ValidationSummary Class (System.Web.UI.WebControls)

Collapse All

Language Filter

This page is specific to

Microsoft Visual Studio 2008/.NET Framework 3.5

Other versions are also available for the following:

.NET Framework Class Library

ValidationSummary Class

Updated: November 2007

Displays a summary of all validation errors inline on a Web page, in a message box, or both.

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

Syntax

Visual Basic (Declaration)

<AspNetHostingPermissionAttribute(SecurityAction.LinkDemand, Level := AspNetHostingPermissionLevel.Minimal)> _
<AspNetHostingPermissionAttribute(SecurityAction.InheritanceDemand, Level := AspNetHostingPermissionLevel.Minimal)> _
Public Class ValidationSummary _
    Inherits WebControl

Visual Basic (Usage)

Dim instance As ValidationSummary

[AspNetHostingPermissionAttribute(SecurityAction.LinkDemand, Level = AspNetHostingPermissionLevel.Minimal)]
[AspNetHostingPermissionAttribute(SecurityAction.InheritanceDemand, Level = AspNetHostingPermissionLevel.Minimal)]
public class ValidationSummary : WebControl

Visual C++

[AspNetHostingPermissionAttribute(SecurityAction::LinkDemand, Level = AspNetHostingPermissionLevel::Minimal)]
[AspNetHostingPermissionAttribute(SecurityAction::InheritanceDemand, Level = AspNetHostingPermissionLevel::Minimal)]
public ref class ValidationSummary : public WebControl

/** @attribute AspNetHostingPermissionAttribute(SecurityAction.LinkDemand, Level = AspNetHostingPermissionLevel.Minimal) */
/** @attribute AspNetHostingPermissionAttribute(SecurityAction.InheritanceDemand, Level = AspNetHostingPermissionLevel.Minimal) */
public class ValidationSummary extends WebControl

JScript

public class ValidationSummary extends WebControl

ASP.NET

<asp:ValidationSummary />

Remarks

The ValidationSummary class is used to summarize the error messages from all validators on a Web page in a single location. You can summarize the error messages from a group of validators on a Web page by assigning the ValidationSummary control to a validation group by setting the ValidationGroup property.

The summary can be displayed as a list, as a bulleted list, or as a single paragraph, based on the DisplayMode property.

The summary can be displayed on the Web page and in a message box by setting the ShowSummary and ShowMessageBox properties, respectively.

Note:
When you use the ValidationSummary control inside an UpdatePanel control, make sure that the validator control and the control it is associated with are in the same panel. For more information about using the UpdatePanel control for partial-page updates, see Partial-Page Rendering Overview.

For a list of initial property values for an instance of ValidationSummary, see the ValidationSummary constructor.

Topic	Location
How to: Control Validation Error Message Display for ASP.NET Server Controls	Building ASP .NET Web Applications
How to: Control Validation Error Message Display for ASP.NET Server Controls	Building ASP .NET Web Applications
How to: Control Validation Error Message Display for ASP.NET Server Controls	Building ASP .NET Web Applications in Visual Studio
How to: Disable Validation for ASP.NET Server Controls	Building ASP .NET Web Applications
How to: Disable Validation for ASP.NET Server Controls	Building ASP .NET Web Applications
How to: Disable Validation for ASP.NET Server Controls	Building ASP .NET Web Applications in Visual Studio
How to: Display Server Side Custom Validation Messages for ASP.NET Server Controls	Building ASP .NET Web Applications
How to: Display Server Side Custom Validation Messages for ASP.NET Server Controls	Building ASP .NET Web Applications
How to: Display Server Side Custom Validation Messages for ASP.NET Server Controls	Building ASP .NET Web Applications in Visual Studio
How to: Format Validation Error Messages for ASP.NET Server Controls	Building ASP .NET Web Applications
How to: Format Validation Error Messages for ASP.NET Server Controls	Building ASP .NET Web Applications
How to: Format Validation Error Messages for ASP.NET Server Controls	Building ASP .NET Web Applications in Visual Studio
How to: Specify Layout for In-Place Messages On ASP.NET Server Controls	Building ASP .NET Web Applications
How to: Specify Layout for In-Place Messages On ASP.NET Server Controls	Building ASP .NET Web Applications
How to: Specify Layout for In-Place Messages On ASP.NET Server Controls	Building ASP .NET Web Applications in Visual Studio
How to: Test Validity Programmatically for ASP.NET Server Controls	Building ASP .NET Web Applications
How to: Test Validity Programmatically for ASP.NET Server Controls	Building ASP .NET Web Applications
How to: Test Validity Programmatically for ASP.NET Server Controls	Building ASP .NET Web Applications in Visual Studio
How to: Validate Against a Data Type for ASP.NET Server Controls	Building ASP .NET Web Applications
How to: Validate Against a Data Type for ASP.NET Server Controls	Building ASP .NET Web Applications
How to: Validate Against a Data Type for ASP.NET Server Controls	Building ASP .NET Web Applications in Visual Studio
How to: Validate Against a Range of Values for ASP.NET Server Controls	Building ASP .NET Web Applications
How to: Validate Against a Range of Values for ASP.NET Server Controls	Building ASP .NET Web Applications
How to: Validate Against a Range of Values for ASP.NET Server Controls	Building ASP .NET Web Applications in Visual Studio
How to: Validate Against a Specific Value for ASP.NET Server Controls	Building ASP .NET Web Applications
How to: Validate Against a Specific Value for ASP.NET Server Controls	Building ASP .NET Web Applications
How to: Validate Against a Specific Value for ASP.NET Server Controls	Building ASP .NET Web Applications in Visual Studio
How to: Validate Against Patterns for ASP.NET Server Controls	Building ASP .NET Web Applications
How to: Validate Against Patterns for ASP.NET Server Controls	Building ASP .NET Web Applications
How to: Validate Against Patterns for ASP.NET Server Controls	Building ASP .NET Web Applications in Visual Studio
How to: Validate Against Values in a Database for ASP.NET Server Controls	Building ASP .NET Web Applications
How to: Validate Against Values in a Database for ASP.NET Server Controls	Building ASP .NET Web Applications
How to: Validate Against Values in a Database for ASP.NET Server Controls	Building ASP .NET Web Applications in Visual Studio
How to: Validate Programmatically for ASP.NET Server Controls	Building ASP .NET Web Applications
How to: Validate Programmatically for ASP.NET Server Controls	Building ASP .NET Web Applications
How to: Validate Programmatically for ASP.NET Server Controls	Building ASP .NET Web Applications in Visual Studio
How to: Validate Required Entries for ASP.NET Server Controls	Building ASP .NET Web Applications
How to: Validate Required Entries for ASP.NET Server Controls	Building ASP .NET Web Applications
How to: Validate Required Entries for ASP.NET Server Controls	Building ASP .NET Web Applications in Visual Studio
How to: Validate with a Custom Function for ASP.NET Server Controls	Building ASP .NET Web Applications
How to: Validate with a Custom Function for ASP.NET Server Controls	Building ASP .NET Web Applications
How to: Validate with a Custom Function for ASP.NET Server Controls	Building ASP .NET Web Applications in Visual Studio
Walkthrough: Validating User Input in a Web Forms Page	Building ASP .NET Web Applications in Visual Studio
Walkthrough: Validating User Input in a Web Forms Page	Building Applications with Visual Web Developer

Examples

The following code example demonstrates how to use a ValidationSummary control to summarize the error messages from all validation controls on a Web page and display them in a bulleted list.

Security Note:
This example has a text box that accepts user input, which is a potential security threat. By default, ASP.NET Web pages validate that user input does not include script or HTML elements. For more information, see Script Exploits Overview.

Visual Basic

<%@ Page Language="VB" AutoEventWireup="True" %>
 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html  >
 <head>
    <title>ValidationSummary Sample</title>
</head>
 <body>

    <h3>ValidationSummary Sample</h3>
    <br />

    <form id="form1" runat="server">

       <table cellpadding="10">
          <tr>
             <td>
                <table style="background-color:#eeeeee; padding:10">

                   <tr>
                      <td colspan="3">
                         <b>Credit Card Information</b>
                      </td>
                   </tr>
                   <tr>
                      <td align="right">
                         Card Type:
                      </td>
                      <td>
                         <asp:RadioButtonList id="RadioButtonList1" 
                              RepeatLayout="Flow"
                               runat="server">
                            <asp:ListItem>MasterCard</asp:ListItem>
                            <asp:ListItem>Visa</asp:ListItem>
                         </asp:RadioButtonList>
                      </td>
                      <td align="center" rowspan="1">
                         <asp:RequiredFieldValidator 
                              id="RequiredFieldValidator1"
                              ControlToValidate="RadioButtonList1" 
                              ErrorMessage="Card Type. "
                              Display="Static"
                              InitialValue="" Width="100%" runat="server">
                            *
                         </asp:RequiredFieldValidator>
                      </td>
                   </tr>
                   <tr>
                      <td align="right">
                         Card Number:
                      </td>
                      <td>
                         <asp:TextBox id="TextBox1" runat="server" />
                      </td>
                      <td>
                         <asp:RequiredFieldValidator 
                              id="RequiredFieldValidator2"
                              ControlToValidate="TextBox1" 
                              ErrorMessage="Card Number. "
                              Display="Static"
                              Width="100%" runat="server">
                            *
                         </asp:RequiredFieldValidator>
                      </td>
                   </tr>

                   <tr>
                      <td></td>
                      <td>
                         <asp:Button 
                              id="Button1" 
                              text="Validate" 
                              runat="server" />
                      </td>
                      <td></td>
                   </tr>
                </table>
             </td>
             <td valign="top">
                <table cellpadding="20">
                   <tr>
                      <td>
                         <asp:ValidationSummary 
                              id="valSum" 
                              DisplayMode="BulletList" 
                              runat="server"
                              HeaderText="You must enter a value in the following fields:"
                              Font-Names="verdana" 
                              Font-Size="12"/>
                      </td>
                   </tr>
                </table>
             </td>
          </tr>
       </table>

    </form>

 </body>
 </html>

<%@ Page Language="C#" AutoEventWireup="True" %>
 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html  >
 <head>
    <title>ValidationSummary Sample</title>
</head>
 <body>

    <h3>ValidationSummary Sample</h3>
    <br />

    <form id="form1" runat="server">

       <table cellpadding="10">
          <tr>
             <td>
                <table style="background-color:#eeeeee; padding:10">

                   <tr>
                      <td colspan="3">
                         <b>Credit Card Information</b> 
                      </td>
                   </tr>
                   <tr>
                      <td align="right">
                         Card Type: 
                      </td>
                      <td>
                         <asp:RadioButtonList id="RadioButtonList1" 
                              RepeatLayout="Flow"
                               runat="server">
                            <asp:ListItem>MasterCard</asp:ListItem>
                            <asp:ListItem>Visa</asp:ListItem>
                         </asp:RadioButtonList>
                      </td>
                      <td align="center" rowspan="1">
                         <asp:RequiredFieldValidator 
                              id="RequiredFieldValidator1"
                              ControlToValidate="RadioButtonList1" 
                              ErrorMessage="Card Type. "
                              Display="Static"
                              InitialValue="" Width="100%" runat="server">
                            *
                         </asp:RequiredFieldValidator>
                      </td>
                   </tr>
                   <tr>
                      <td align="right">
                         Card Number: 
                      </td>
                      <td>
                         <asp:TextBox id="TextBox1" runat="server" />
                      </td>
                      <td>
                         <asp:RequiredFieldValidator 
                              id="RequiredFieldValidator2"
                              ControlToValidate="TextBox1" 
                              ErrorMessage="Card Number. "
                              Display="Static"
                              Width="100%" runat="server">
                            *
                         </asp:RequiredFieldValidator>
                      </td>
                   </tr>

                   <tr>
                      <td></td>
                      <td>
                         <asp:Button 
                              id="Button1" 
                              text="Validate" 
                              runat="server" />
                      </td>
                      <td></td>
                   </tr>
                </table>
             </td>
             <td valign="top">
                <table cellpadding="20">
                   <tr>
                      <td>
                         <asp:ValidationSummary 
                              id="valSum" 
                              DisplayMode="BulletList" 
                              runat="server"
                              HeaderText="You must enter a value in the following fields:"
                              Font-Names="verdana" 
                              Font-Size="12"/>
                      </td>
                   </tr>
                </table>
             </td>
          </tr>
       </table>

    </form>

 </body>
 </html>

Permissions

AspNetHostingPermission
for operating in a hosted environment. Demand value: LinkDemand; Permission value: Minimal.
AspNetHostingPermission
for operating in a hosted environment. Demand value: InheritanceDemand; Permission value: Minimal.

Inheritance Hierarchy

System..::.Object
  System.Web.UI..::.Control
    System.Web.UI.WebControls..::.WebControl
      System.Web.UI.WebControls..::.ValidationSummary

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Platforms

Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Version Information