HtmlHelper.ValidationMessage Method (String, String, Object)
Returns an HTML span element that has the specified custom attributes defined by an attribute object, and that contains a validation error message for the specified form field.
Namespace: System.Web.WebPages.Html
Assembly: System.Web.WebPages (in System.Web.WebPages.dll)
Syntax
'Declaration
Public Function ValidationMessage ( _
name As String, _
message As String, _
htmlAttributes As Object _
) As IHtmlString
'Usage
Dim instance As HtmlHelper
Dim name As String
Dim message As String
Dim htmlAttributes As Object
Dim returnValue As IHtmlString
returnValue = instance.ValidationMessage(name, _
message, htmlAttributes)
public IHtmlString ValidationMessage(
string name,
string message,
Object htmlAttributes
)
public:
IHtmlString^ ValidationMessage(
String^ name,
String^ message,
Object^ htmlAttributes
)
member ValidationMessage :
name:string *
message:string *
htmlAttributes:Object -> IHtmlString
public function ValidationMessage(
name : String,
message : String,
htmlAttributes : Object
) : IHtmlString
Parameters
- name
Type: System.String
The name of the form field that was validated.
- message
Type: System.String
The validation error message to display. If null reference (Nothing in Visual Basic), the first validation error message that is associated with the specified form field is displayed.
- 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
If the specified field is valid, null reference (Nothing in Visual Basic); otherwise, the HTML markup that represents a validation error message that is associated with the specified field.
Exceptions
| Exception | Condition |
|---|---|
| ArgumentException | name is null reference (Nothing in Visual Basic) or empty. |
Remarks
This method is used in conjunction with the System.Web.Helpers.Validation class.
The returned markup consists of an HTML span element in the following form:
<span ...htmlAttributes...>message</span>
message contains the specified validation error message, or the first validation error message that is associated with the form field whose id attribute is name if message is null reference (Nothing in Visual Basic). Additional validation errors might be associated with the field and will be returned the next time that the form is submitted if the errors have not been resolved.