ValidationSummary.HeaderText Property

 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

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

Namespace:   System.Web.UI.WebControls
Assembly:  System.Web (in System.Web.dll)

public string HeaderText { get; set; }

Property Value

Type: System.String

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

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.

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>

.NET Framework
Available since 1.1
Return to top
Show: