Export (0) Print
Expand All

CustomValidationAttribute Class

Specifies a custom validation method that is used 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)

[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.

  NameDescription
Public methodSupported by Portable Class LibrarySupported in .NET for Windows Store appsCustomValidationAttributeInitializes a new instance of the CustomValidationAttribute class.
Top

  NameDescription
Public propertySupported by Portable Class LibrarySupported in .NET for Windows Store appsErrorMessageGets or sets an error message to associate with a validation control if validation fails. (Inherited from ValidationAttribute.)
Public propertySupported by Portable Class LibrarySupported in .NET for Windows Store appsErrorMessageResourceNameGets 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 propertySupported by Portable Class LibrarySupported in .NET for Windows Store appsErrorMessageResourceTypeGets or sets the resource type to use for error-message lookup if validation fails. (Inherited from ValidationAttribute.)
Public propertySupported by Portable Class LibrarySupported in .NET for Windows Store appsMethodGets the validation method.
Public propertyRequiresValidationContextGets a value that indicates whether the attribute requires validation context. (Inherited from ValidationAttribute.)
Public propertyTypeIdGets a unique identifier for this attribute. (Overrides Attribute.TypeId.)
Public propertySupported by Portable Class LibrarySupported in .NET for Windows Store appsValidatorTypeGets the type that performs custom validation.
Top

  NameDescription
Public methodSupported by Portable Class LibrarySupported in .NET for Windows Store appsEqualsInfrastructure. Returns a value that indicates whether this instance is equal to a specified object. (Inherited from Attribute.)
Public methodSupported by Portable Class LibrarySupported in .NET for Windows Store appsFormatErrorMessageFormats a validation error message. (Overrides ValidationAttribute.FormatErrorMessage(String).)
Public methodSupported by Portable Class LibrarySupported in .NET for Windows Store appsGetHashCodeReturns the hash code for this instance. (Inherited from Attribute.)
Public methodSupported by Portable Class LibrarySupported in .NET for Windows Store appsGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodSupported by Portable Class LibrarySupported in .NET for Windows Store appsGetValidationResultChecks whether the specified value is valid with respect to the current validation attribute. (Inherited from ValidationAttribute.)
Public methodIsDefaultAttributeWhen overridden in a derived class, indicates whether the value of this instance is the default value for the derived class. (Inherited from Attribute.)
Public methodIsValid(Object)Determines whether the specified value of the object is valid. (Inherited from ValidationAttribute.)
Public methodMatchWhen overridden in a derived class, returns a value that indicates whether this instance equals a specified object. (Inherited from Attribute.)
Public methodSupported by Portable Class LibrarySupported in .NET for Windows Store appsToStringReturns a string that represents the current object. (Inherited from Object.)
Public methodSupported by Portable Class LibrarySupported in .NET for Windows Store appsValidate(Object, ValidationContext)Validates the specified object. (Inherited from ValidationAttribute.)
Public methodValidate(Object, String)Validates the specified object. (Inherited from ValidationAttribute.)
Top

  NameDescription
Explicit interface implemetationPrivate method_Attribute.GetIDsOfNamesMaps a set of names to a corresponding set of dispatch identifiers. (Inherited from Attribute.)
Explicit interface implemetationPrivate method_Attribute.GetTypeInfoRetrieves the type information for an object, which can be used to get the type information for an interface. (Inherited from Attribute.)
Explicit interface implemetationPrivate method_Attribute.GetTypeInfoCountRetrieves the number of type information interfaces that an object provides (either 0 or 1). (Inherited from Attribute.)
Explicit interface implemetationPrivate method_Attribute.InvokeProvides access to properties and methods exposed by an object. (Inherited from Attribute.)
Top

The CustomValidationAttribute attribute is used to perform custom validation when the IsValidmethod is invoked to perform validation. The IsValid method 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.5.2, 4.5.1, 4.5, 4

.NET Framework Client Profile

Supported in: 4

Portable Class Library

Supported in: Portable Class Library

.NET for Windows Store apps

Supported in: Windows 8

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

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.
Show:
© 2014 Microsoft