Home Library Learn Downloads Support Community
Sign in | United States - English | |
2 out of 9 rated this helpful - Rate this topic

CustomValidationAttribute Class

.NET Framework 4

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

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)
C#
C++
F#
VB
Copy 
[AttributeUsageAttribute(AttributeTargets.Class|AttributeTargets.Method|AttributeTargets.Property|AttributeTargets.Field|AttributeTargets.Parameter, AllowMultiple = true)]
public sealed class CustomValidationAttribute : ValidationAttribute

The CustomValidationAttribute type exposes the following members.

  Name Description
Public method CustomValidationAttribute Initializes a new instance of the CustomValidationAttribute class.
Top
  Name Description
Public property ErrorMessage Gets or sets an error message to associate with a validation control if validation fails. (Inherited from ValidationAttribute.)
Public property 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.)
Public property ErrorMessageResourceType Gets or sets the resource type to use for error-message lookup if validation fails. (Inherited from ValidationAttribute.)
Protected property ErrorMessageString Gets the localized validation error message. (Inherited from ValidationAttribute.)
Public property Method Gets the validation method.
Public property TypeId Gets a unique identifier for this attribute. (Overrides Attribute.TypeId.)
Public property ValidatorType Gets the type that performs custom validation.
Top
  Name Description
Public method Equals Infrastructure. Returns a value that indicates whether this instance is equal to a specified object. (Inherited from Attribute.)
Protected method Finalize Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public method FormatErrorMessage Formats a validation error message. (Overrides ValidationAttribute.FormatErrorMessage(String).)
Public method GetHashCode Returns the hash code for this instance. (Inherited from Attribute.)
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Public method GetValidationResult Checks whether the specified value is valid with respect to the current validation attribute. (Inherited from ValidationAttribute.)
Public method 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.)
Public method IsValid(Object) Determines whether the specified value of the object is valid. (Inherited from ValidationAttribute.)
Protected method IsValid(Object, ValidationContext) Validates the specified value with respect to the current validation attribute. (Inherited from ValidationAttribute.)
Public method Match When overridden in a derived class, returns a value that indicates whether this instance equals a specified object. (Inherited from Attribute.)
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Public method ToString Returns a string that represents the current object. (Inherited from Object.)
Public method Validate(Object, ValidationContext) Validates the specified object. (Inherited from ValidationAttribute.)
Public method Validate(Object, String) Validates the specified object. (Inherited from ValidationAttribute.)
Top
  Name Description
Explicit interface implemetation Private method _Attribute.GetIDsOfNames Maps a set of names to a corresponding set of dispatch identifiers. (Inherited from Attribute.)
Explicit interface implemetation Private method _Attribute.GetTypeInfo Retrieves the type information for an object, which can be used to get the type information for an interface. (Inherited from Attribute.)
Explicit interface implemetation Private method _Attribute.GetTypeInfoCount Retrieves the number of type information interfaces that an object provides (either 0 or 1). (Inherited from Attribute.)
Explicit interface implemetation Private method _Attribute.Invoke Provides access to properties and methods exposed by an object. (Inherited from Attribute.)
Top

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.

.NET Framework

Supported in: 4

.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.
Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Did you find this helpful?
(1500 characters remaining)