ValidationSummary.HeaderText Property

Definition

Gets or sets the header text displayed at the top of the summary.

public:
 property System::String ^ HeaderText { System::String ^ get(); void set(System::String ^ value); };
[System.ComponentModel.Bindable(true)]
public string HeaderText { get; set; }
public string HeaderText { get; set; }
[<System.ComponentModel.Bindable(true)>]
member this.HeaderText : string with get, set
member this.HeaderText : string with get, set
Public Property HeaderText As String

Property Value

The header text displayed at the top of the summary. The default is Empty.

Attributes

Examples

The following code example demonstrates how to use the HeaderText property to display a title for the ValidationSummary control.


<%@ Page Language="C#"%>

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" >
  <head runat="server">
    <title>ASP.NET Example</title>
</head>
<body>
    <form id="form1" runat="server">
    
      Name:<br/>
      <asp:textbox id="NameTextBox"
        runat="server"/>
        
      <asp:requiredfieldvalidator id="NameTextBoxRequiredValidator"
        controltovalidate="NameTextBox"
        errormessage="Name field."
        text="Please enter your name"
        runat="server"/>     
        
      <br/>  
      
      City:<br/>
      <asp:textbox id="CityTextBox"
        runat="server"/>
        
      <asp:requiredfieldvalidator id="CityTextBoxRequiredValidator"
        controltovalidate="CityTextBox"
        errormessage="City field."
        text="Please enter the city."
        runat="server"/> 
        
      <br/>
      
      <asp:Button id="SubmitButton"
        text="Submit"
        runat="server"/>
      
      <hr/>
      
      <asp:ValidationSummary 
        id="valSum" 
        displaymode="BulletList" 
        headertext="You must enter a value in the following fields:"
        runat="server"/>
    
    </form>
  </body>
</html>

<%@ Page Language="VB"%>

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" >
  <head runat="server">
    <title>ASP.NET Example</title>
</head>
<body>
    <form id="form1" runat="server">
    
      Name:<br/>
      <asp:textbox id="NameTextBox"
        runat="server"/>
        
      <asp:requiredfieldvalidator id="NameTextBoxRequiredValidator"
        controltovalidate="NameTextBox"
        errormessage="Name field."
        text="Please enter your name"
        runat="server"/>     
        
      <br/>  
      
      City:<br/>
      <asp:textbox id="CityTextBox"
        runat="server"/>
        
      <asp:requiredfieldvalidator id="CityTextBoxRequiredValidator"
        controltovalidate="CityTextBox"
        errormessage="City field."
        text="Please enter the city."
        runat="server"/> 
        
      <br/>
      
      <asp:Button id="SubmitButton"
        text="Submit"
        runat="server"/>
      
      <hr/>
      
      <asp:ValidationSummary 
        id="valSum" 
        displaymode="BulletList" 
        headertext="You must enter a value in the following fields:"
        runat="server"/>
    
    </form>
  </body>
</html>

Remarks

Use this property to display a title for the ValidationSummary control.

The HeaderText property is not HTML encoded. Therefore, HTML tags can be included in HeaderText.

The value of this property, when set, can be saved automatically to a resource file by using a designer tool. For more information, see LocalizableAttribute and ASP.NET Globalization and Localization.

Applies to