ValidationAttribute.FormatErrorMessage(String) Method

Definition

Applies formatting to an error message, based on the data field where the error occurred.

C#
public virtual string FormatErrorMessage (string name);

Parameters

name
String

The name to include in the formatted message.

Returns

An instance of the formatted error message.

Exceptions

The current attribute is malformed.

Remarks

This method formats an error message by using the ErrorMessageString property. This method appends the name of the data field that triggered the error to the formatted error message. You can customize how the error message is formatted by creating a derived class that overrides this method.

Applies to

Product Versions
.NET Core 1.0, Core 1.1, Core 2.0, Core 2.1, Core 2.2, Core 3.0, Core 3.1, 5, 6, 7, 8, 9
.NET Framework 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1
.NET Standard 2.0 (package-provided), 2.1 (package-provided)
UWP 10.0