IHtmlHelper.ValidationMessage(String, String, Object, String) Method

  • Reference

Definition

Namespace:
Microsoft.AspNetCore.Mvc.Rendering
Assembly:
Microsoft.AspNetCore.Mvc.ViewFeatures.dll
Package:
Microsoft.AspNetCore.Mvc.ViewFeatures v1.0.0
Package:
Microsoft.AspNetCore.Mvc.ViewFeatures v1.1.0
Package:
Microsoft.AspNetCore.Mvc.ViewFeatures v2.0.0
Package:
Microsoft.AspNetCore.Mvc.ViewFeatures v2.1.0
Package:
Microsoft.AspNetCore.Mvc.ViewFeatures v2.2.0
Package:
Microsoft.AspNetCore.App.Ref v3.0.1
Package:
Microsoft.AspNetCore.App.Ref v3.1.10
Package:
Microsoft.AspNetCore.App.Ref v5.0.0
Package:
Microsoft.AspNetCore.App.Ref v6.0.6
Package:
Microsoft.AspNetCore.App.Ref v7.0.5
Package:
Microsoft.AspNetCore.App.Ref v8.0.0
Package:
Microsoft.AspNetCore.App.Ref v9.0.0-rc.2.24474.3
Source:
IHtmlHelper.cs

Returns the validation message if an error exists in the ModelStateDictionary object for the specified expression.

public:
 Microsoft::AspNetCore::Html::IHtmlContent ^ ValidationMessage(System::String ^ expression, System::String ^ message, System::Object ^ htmlAttributes, System::String ^ tag);
public Microsoft.AspNetCore.Html.IHtmlContent ValidationMessage (string expression, string message, object htmlAttributes, string tag);
abstract member ValidationMessage : string * string * obj * string -> Microsoft.AspNetCore.Html.IHtmlContent
Public Function ValidationMessage (expression As String, message As String, htmlAttributes As Object, tag As String) As IHtmlContent

Parameters

expression
String

Expression name, relative to the current model.

message
String

The message to be displayed. If null or empty, method extracts an error string from the ModelStateDictionary object. Message will always be visible but client-side validation may update the associated CSS class.

htmlAttributes
Object

An Object that contains the HTML attributes for the tag element. Alternatively, an IDictionary<TKey,TValue> instance containing the HTML attributes.

tag
String

The tag to wrap the message in the generated HTML. Its default value is ValidationMessageElement.

Returns

IHtmlContent

A new IHtmlContent containing a tag element. An empty IHtmlContent if the expression is valid and client-side validation is disabled.

Applies to