CustomValidationAttribute Class (System.ComponentModel.DataAnnotations)

Collapse All

Language Filter

This page is specific to

Microsoft Visual Studio 2010/.NET Framework 4

Other versions are also available for the following:

.NET Framework Class Library

CustomValidationAttribute Class

Specifies a custom validation method to to validate a property or class instance.

Inheritance Hierarchy

System..::.Object
  System..::.Attribute
    System.ComponentModel.DataAnnotations..::.ValidationAttribute
      System.ComponentModel.DataAnnotations..::.CustomValidationAttribute

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

Syntax

Visual Basic

<AttributeUsageAttribute(AttributeTargets.Class Or AttributeTargets.Method Or AttributeTargets.Property Or AttributeTargets.Field Or AttributeTargets.Parameter, AllowMultiple := True)> _
Public NotInheritable Class CustomValidationAttribute _
    Inherits ValidationAttribute

[AttributeUsageAttribute(AttributeTargets.Class|AttributeTargets.Method|AttributeTargets.Property|AttributeTargets.Field|AttributeTargets.Parameter, AllowMultiple = true)]
public sealed class CustomValidationAttribute : ValidationAttribute

Visual C++

[AttributeUsageAttribute(AttributeTargets::Class|AttributeTargets::Method|AttributeTargets::Property|AttributeTargets::Field|AttributeTargets::Parameter, AllowMultiple = true)]
public ref class CustomValidationAttribute sealed : public ValidationAttribute

[<Sealed>]
[<AttributeUsageAttribute(AttributeTargets.Class|AttributeTargets.Method|AttributeTargets.Property|AttributeTargets.Field|AttributeTargets.Parameter, AllowMultiple = true)>]
type CustomValidationAttribute =  
    class
        inherit ValidationAttribute
    end

The CustomValidationAttribute type exposes the following members.

Constructors

	Name	Description
	CustomValidationAttribute	Initializes a new instance of the CustomValidationAttribute class.

Top

Properties

	Name	Description
	ErrorMessage	Gets or sets an error message to associate with a validation control if validation fails. (Inherited from ValidationAttribute.)
	ErrorMessageResourceName	Gets or sets the error message resource name to use in order to look up the ErrorMessageResourceType property value if validation fails. (Inherited from ValidationAttribute.)
	ErrorMessageResourceType	Gets or sets the resource type to use for error-message lookup if validation fails. (Inherited from ValidationAttribute.)
	ErrorMessageString	Gets the localized validation error message. (Inherited from ValidationAttribute.)
	Method	Gets the validation method.
	TypeId	Gets a unique identifier for this attribute. (Overrides Attribute..::.TypeId.)
	ValidatorType	Gets the type that performs custom validation.

Top

Methods

	Name	Description
	Equals	Infrastructure. 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	Formats a validation error message. (Overrides ValidationAttribute..::.FormatErrorMessage(String).)
	GetHashCode	Returns the hash code for this instance. (Inherited from Attribute.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	GetValidationResult	Checks whether the specified value is valid with respect to the current validation attribute. (Inherited from ValidationAttribute.)
	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. (Inherited from ValidationAttribute.)
	IsValid(Object, ValidationContext)	Validates the specified value with respect to the current validation attribute. (Inherited from ValidationAttribute.)
	Match	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, ValidationContext)	Validates the specified object. (Inherited from ValidationAttribute.)
	Validate(Object, String)	Validates the specified object. (Inherited from ValidationAttribute.)

Top

Explicit Interface Implementations

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

Top

Remarks

The CustomValidationAttribute attribute is used to perform custom validation. The IsValid(Object) method is invoked to perform validation. It then redirects the call to the method that is identified by the Method property, which in turn performs the actual validation.

The CustomValidationAttribute attribute can be applied to types, properties, fields, methods, and method parameters. When it is applied to a property, the attribute is invoked whenever a value is assigned to that property. When it is applied to a method, the attribute is invoked whenever the program calls that method. When it is applied to a method parameter, the attribute is invoked before the method is called.

For more information about using attributes, see Extending Metadata Using Attributes.

Version Information

.NET Framework

Supported in: 4

.NET Framework Client Profile

Supported in: 4

Platforms

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.

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.

Reference

System.ComponentModel.DataAnnotations Namespace