EnumDataTypeAttribute EnumDataTypeAttribute EnumDataTypeAttribute EnumDataTypeAttribute Class

Definition

Enables a .NET Framework enumeration to be mapped to a data column.

public ref class EnumDataTypeAttribute sealed : System::ComponentModel::DataAnnotations::DataTypeAttribute
[System.AttributeUsage(System.AttributeTargets.Field | System.AttributeTargets.Method | System.AttributeTargets.Parameter | System.AttributeTargets.Property, AllowMultiple=false)]
[System.AttributeUsage(System.AttributeTargets.Method | System.AttributeTargets.Property | System.AttributeTargets.Field | System.AttributeTargets.Parameter, AllowMultiple=false)]
public sealed class EnumDataTypeAttribute : System.ComponentModel.DataAnnotations.DataTypeAttribute
type EnumDataTypeAttribute = class
    inherit DataTypeAttribute
Public NotInheritable Class EnumDataTypeAttribute
Inherits DataTypeAttribute
Inheritance
Attributes

Examples

The following example shows how to replace the numeric value of an enumeration with the corresponding declaration.

public enum eReorderLvl {  
        zero = 0,  
        five = 5,  
        ten=10,  
        fifteen=15,  
        twenty=20,  
        twenty_five=25,  
        thirty=30  
    }  
    [MetadataType(typeof(Product_MD))]  
    public partial class Product {  
        public class Product_MD {  
            [EnumDataType(typeof(eReorderLvl))]  
            public object ReorderLevel { get; set; }  
        }  
    }  
Imports Public Enum eReorderLvl  
    zero = 0  
    five = 5  
    ten = 10  
    fifteen = 15  
    twenty = 20  
    twenty_five = 25  
    thirty = 30  
End Enum  
<MetadataType(GetType(Product_MD))>  _  
Public Class Product  
    Public Class Product_MD  
        <EnumDataType(GetType(eReorderLvl))>  _  
        Public Property ReorderLevel As Object  
        End Property  
    End Class  
End Class  

Remarks

This class lets you map the underlying value in a column to a corresponding enumeration constant name. This lets you define an enumeration that contains descriptive values that correspond to database values, and then use the enumeration constant names instead of the database values when data is displayed.

Constructors

EnumDataTypeAttribute(Type) EnumDataTypeAttribute(Type) EnumDataTypeAttribute(Type) EnumDataTypeAttribute(Type)

Initializes a new instance of the EnumDataTypeAttribute class.

Properties

CustomDataType CustomDataType CustomDataType CustomDataType

Gets the name of custom field template that is associated with the data field.

(Inherited from DataTypeAttribute)
DataType DataType DataType DataType

Gets the type that is associated with the data field.

(Inherited from DataTypeAttribute)
DisplayFormat DisplayFormat DisplayFormat DisplayFormat

Gets a data-field display format.

(Inherited from DataTypeAttribute)
EnumType EnumType EnumType EnumType

Gets or sets the enumeration type.

ErrorMessage ErrorMessage ErrorMessage ErrorMessage

Gets or sets an error message to associate with a validation control if validation fails.

(Inherited from ValidationAttribute)
ErrorMessageResourceName ErrorMessageResourceName ErrorMessageResourceName 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 ErrorMessageResourceType ErrorMessageResourceType ErrorMessageResourceType

Gets or sets the resource type to use for error-message lookup if validation fails.

(Inherited from ValidationAttribute)
ErrorMessageString ErrorMessageString ErrorMessageString ErrorMessageString

Gets the localized validation error message.

(Inherited from ValidationAttribute)
RequiresValidationContext RequiresValidationContext RequiresValidationContext RequiresValidationContext

Gets a value that indicates whether the attribute requires validation context.

(Inherited from ValidationAttribute)
TypeId TypeId TypeId TypeId

When implemented in a derived class, gets a unique identifier for this Attribute.

(Inherited from Attribute)

Methods

Equals(Object) Equals(Object) Equals(Object) Equals(Object)

Returns a value that indicates whether this instance is equal to a specified object.

(Inherited from Attribute)
FormatErrorMessage(String) FormatErrorMessage(String) FormatErrorMessage(String) FormatErrorMessage(String)

Applies formatting to an error message, based on the data field where the error occurred.

(Inherited from ValidationAttribute)
GetDataTypeName() GetDataTypeName() GetDataTypeName() GetDataTypeName()

Returns the name of the type that is associated with the data field.

(Inherited from DataTypeAttribute)
GetHashCode() GetHashCode() GetHashCode() GetHashCode()

Returns the hash code for this instance.

(Inherited from Attribute)
GetType() GetType() GetType() GetType()

Gets the Type of the current instance.

(Inherited from Object)
GetValidationResult(Object, ValidationContext) GetValidationResult(Object, ValidationContext) GetValidationResult(Object, ValidationContext) GetValidationResult(Object, ValidationContext)

Checks whether the specified value is valid with respect to the current validation attribute.

(Inherited from ValidationAttribute)
IsDefaultAttribute() IsDefaultAttribute() IsDefaultAttribute() 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) IsValid(Object) IsValid(Object) IsValid(Object)

Checks that the value of the data field is valid.

IsValid(Object, ValidationContext) IsValid(Object, ValidationContext) IsValid(Object, ValidationContext) IsValid(Object, ValidationContext)

Validates the specified value with respect to the current validation attribute.

(Inherited from ValidationAttribute)
Match(Object) Match(Object) Match(Object) Match(Object)

When overridden in a derived class, returns a value that indicates whether this instance equals a specified object.

(Inherited from Attribute)
MemberwiseClone() MemberwiseClone() MemberwiseClone() MemberwiseClone()

Creates a shallow copy of the current Object.

(Inherited from Object)
ToString() ToString() ToString() ToString()

Returns a string that represents the current object.

(Inherited from Object)
Validate(Object, String) Validate(Object, String) Validate(Object, String) Validate(Object, String)

Validates the specified object.

(Inherited from ValidationAttribute)
Validate(Object, ValidationContext) Validate(Object, ValidationContext) Validate(Object, ValidationContext) Validate(Object, ValidationContext)

Validates the specified object.

(Inherited from ValidationAttribute)

Explicit Interface Implementations

_Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr) _Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr) _Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr) _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) _Attribute.GetTypeInfo(UInt32, UInt32, IntPtr) _Attribute.GetTypeInfo(UInt32, UInt32, IntPtr) _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) _Attribute.GetTypeInfoCount(UInt32) _Attribute.GetTypeInfoCount(UInt32) _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) _Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr) _Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr) _Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr)

Provides access to properties and methods exposed by an object.

(Inherited from Attribute)

Applies to