ValidationExtensions.ValidationMessage Method (HtmlHelper, String, String, IDictionary<String, Object>)
Displays a validation message if an error exists for the specified field in the ModelStateDictionary object.
Namespace: System.Web.Mvc.Html
Assembly: System.Web.Mvc (in System.Web.Mvc.dll)
Syntax
'Declaration
<ExtensionAttribute> _
Public Shared Function ValidationMessage ( _
htmlHelper As HtmlHelper, _
modelName As String, _
validationMessage As String, _
htmlAttributes As IDictionary(Of String, Object) _
) As MvcHtmlString
public static MvcHtmlString ValidationMessage(
this HtmlHelper htmlHelper,
string modelName,
string validationMessage,
IDictionary<string, Object> htmlAttributes
)
[ExtensionAttribute]
public:
static MvcHtmlString^ ValidationMessage(
HtmlHelper^ htmlHelper,
String^ modelName,
String^ validationMessage,
IDictionary<String^, Object^>^ htmlAttributes
)
Parameters
- htmlHelper
Type: System.Web.Mvc.HtmlHelper
The HTML helper instance that this method extends.
- modelName
Type: System.String
The name of the property or model object that is being validated.
- validationMessage
Type: System.String
The message to display if the specified field contains an error.
- htmlAttributes
Type: System.Collections.Generic.IDictionary<String, Object>
An object that contains the HTML attributes for the element.
Return Value
Type: System.Web.Mvc.MvcHtmlString
If the property or object is valid, an empty string; otherwise, a span element that contains an error message.
Usage Note
In Visual Basic and C#, you can call this method as an instance method on any object of type HtmlHelper. When you use instance method syntax to call this method, omit the first parameter. For more information, see Extension Methods (Visual Basic) or Extension Methods (C# Programming Guide).
Remarks
The ValidationMessage method renders a validation message if the specified field contains invalid input.
If the DefaultModelBinder instance cannot bind a form-field value to the model, the binder adds an error to the ModelState object. When the view is rendered, the validation messages and validation summary are displayed based on the Errors property of the ModelState object.