ValidationAttribute Class

.NET Framework (current version)

Note
The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Serves as the base class for all validation attributes.

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

Inheritance Hierarchy

Syntax

C++

Public MustInherit Class ValidationAttribute
	Inherits Attribute

Constructors

	Name	Description
	ValidationAttribute()	Initializes a new instance of the ValidationAttribute class.
	ValidationAttribute(Func(Of String))	Initializes a new instance of the ValidationAttribute class by using the function that enables access to validation resources.
	ValidationAttribute(String)	Initializes a new instance of the ValidationAttribute class by using the error message to associate with a validation control.

Properties

	Name	Description
	ErrorMessage	Gets or sets an error message to associate with a validation control if validation fails.
	ErrorMessageResourceName	Gets or sets the error message resource name to use in order to look up the ErrorMessageResourceType property value if validation fails.
	ErrorMessageResourceType	Gets or sets the resource type to use for error-message lookup if validation fails.
	ErrorMessageString	Gets the localized validation error message.
	RequiresValidationContext	Gets a value that indicates whether the attribute requires validation context.
	TypeId	When implemented in a derived class, gets a unique identifier for this Attribute.(Inherited from Attribute.)

Methods

	Name	Description
	Equals(Object)	This API supports the product infrastructure and is not intended to be used directly from your code. Returns a value that indicates whether this instance is equal to a specified object.(Inherited from Attribute.)
	Finalize()	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(Inherited from Object.)
	FormatErrorMessage(String)	Applies formatting to an error message, based on the data field where the error occurred.
	GetHashCode()	Returns the hash code for this instance.(Inherited from Attribute.)
	GetType()	Gets the Type of the current instance.(Inherited from Object.)
	GetValidationResult(Object, ValidationContext)	Checks whether the specified value is valid with respect to the current validation attribute.
	IsDefaultAttribute()	When overridden in a derived class, indicates whether the value of this instance is the default value for the derived class.(Inherited from Attribute.)
	IsValid(Object)	Determines whether the specified value of the object is valid.
	IsValid(Object, ValidationContext)	Validates the specified value with respect to the current validation attribute.
	Match(Object)	When overridden in a derived class, returns a value that indicates whether this instance equals a specified object.(Inherited from Attribute.)
	MemberwiseClone()	Creates a shallow copy of the current Object.(Inherited from Object.)
	ToString()	Returns a string that represents the current object.(Inherited from Object.)
	Validate(Object, String)	Validates the specified object.
	Validate(Object, ValidationContext)	Validates the specified object.

Explicit Interface Implementations

	Name	Description
	_Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr)	Maps a set of names to a corresponding set of dispatch identifiers.(Inherited from Attribute.)
	_Attribute.GetTypeInfo(UInt32, UInt32, IntPtr)	Retrieves the type information for an object, which can be used to get the type information for an interface.(Inherited from Attribute.)
	_Attribute.GetTypeInfoCount(UInt32)	Retrieves the number of type information interfaces that an object provides (either 0 or 1).(Inherited from Attribute.)
	_Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr)	Provides access to properties and methods exposed by an object.(Inherited from Attribute.)

Exceptions

Exception	Condition
ValidationException	The ErrorMessageResourceType and ErrorMessageResourceName properties for localized error message are set at the same time that the non-localized ErrorMessage property error message is set.

Remarks

This class enforces validation, based on the metadata that is associated with the data table. You can override this class to create custom validation attributes.

Version Information

Universal Windows Platform
Available since 8
.NET Framework
Available since 3.5
Portable Class Library
Supported in: portable .NET platforms
Silverlight
Available since 3.0

Thread Safety

Any public static ( Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.