This documentation is archived and is not being maintained.

ValidationAttribute.FormatErrorMessage Method

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

Namespace:  System.ComponentModel.DataAnnotations
Assembly:  System.ComponentModel.DataAnnotations (in System.ComponentModel.DataAnnotations.dll)

public virtual string FormatErrorMessage(
	string name


Type: System.String
The name to include in the formatted message.

Return Value

Type: System.String
An instance of the formatted error message.

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.

.NET Framework

Supported in: 4, 3.5 SP1

.NET Framework Client Profile

Supported in: 4

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.