This documentation is archived and is not being maintained.

RangeAttribute::FormatErrorMessage Method

Formats the error message that is displayed when range validation fails.

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

public:
virtual String^ FormatErrorMessage(
	String^ name
) override

Parameters

name
Type: System::String
The name of the field that caused the validation failure.

Return Value

Type: System::String
The formatted error message.

The FormatErrorMessage creates the error message by using the name of the data field that caused the validation failure. You can override this method in a custom validation attribute to customize how errors are created, or to provide a more complex message that contains parameters that you evaluate at run time. For an example, see the RangeAttribute::RangeAttribute constructor.

.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.
Show: