This topic has not yet been rated - Rate this topic

EnumDataTypeAttribute Class

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

System.Object
  System.Attribute
    System.ComponentModel.DataAnnotations.ValidationAttribute
      System.ComponentModel.DataAnnotations.DataTypeAttribute
        System.ComponentModel.DataAnnotations.EnumDataTypeAttribute

Namespace:  System.ComponentModel.DataAnnotations
Assembly:  System.ComponentModel.DataAnnotations (in System.ComponentModel.DataAnnotations.dll)
[AttributeUsageAttribute(AttributeTargets.Method|AttributeTargets.Property|AttributeTargets.Field|AttributeTargets.Parameter, AllowMultiple = false)]
public sealed class EnumDataTypeAttribute : DataTypeAttribute

The EnumDataTypeAttribute type exposes the following members.

  Name Description
Public method EnumDataTypeAttribute Initializes a new instance of the EnumDataTypeAttribute class.
Top
  Name Description
Public property CustomDataType Gets the name of custom field template that is associated with the data field. (Inherited from DataTypeAttribute.)
Public property DataType Gets the type that is associated with the data field. (Inherited from DataTypeAttribute.)
Public property DisplayFormat Gets a data-field display format. (Inherited from DataTypeAttribute.)
Public property EnumType Gets or sets the enumeration type.
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 TypeId When implemented in a derived class, gets a unique identifier for this Attribute. (Inherited from Attribute.)
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 Applies formatting to an error message, based on the data field where the error occurred. (Inherited from ValidationAttribute.)
Public method GetDataTypeName Returns the name of the type that is associated with the data field. (Inherited from DataTypeAttribute.)
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) Checks that the value of the data field is valid. (Overrides DataTypeAttribute.IsValid(Object).)
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

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.

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; }
        }
    }

.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)
Community Content Add
Annotations FAQ