Share via


HtmlHelper.ValidationSummary Method (Object)

Returns an HTML div element that has the specified custom attributes defined by an attribute object, and that contains an unordered list of all validation error messages that are in the model-state dictionary.

Namespace:  System.Web.WebPages.Html
Assembly:  System.Web.WebPages (in System.Web.WebPages.dll)

Syntax

'Declaration
Public Function ValidationSummary ( _
    htmlAttributes As Object _
) As IHtmlString
'Usage
Dim instance As HtmlHelper 
Dim htmlAttributes As Object 
Dim returnValue As IHtmlString 

returnValue = instance.ValidationSummary(htmlAttributes)
public IHtmlString ValidationSummary(
    Object htmlAttributes
)
public:
IHtmlString^ ValidationSummary(
    Object^ htmlAttributes
)
member ValidationSummary : 
        htmlAttributes:Object -> IHtmlString
public function ValidationSummary(
    htmlAttributes : Object
) : IHtmlString

Parameters

  • htmlAttributes
    Type: System.Object
    An object that contains custom attributes for the element. The attribute names and values are retrieved through reflection by examining the properties of the object.

Return Value

Type: System.Web.IHtmlString
The HTML markup that represents the validation error messages.

Remarks

This method is used in conjunction with the System.Web.Helpers.Validation class.

The returned markup consists of an HTML div element in the following form:

<div ...htmlAttributes...>
  <ul>
    <li>summary message</li>
    <li>summary message</li>
    ...
  <ul>
</div>

Each summary message contains a validation error message that is associated with a model-level and field-level error in the model-state dictionary.

See Also

Reference

HtmlHelper Class

ValidationSummary Overload

System.Web.WebPages.Html Namespace