Export (0) Print
Expand All

EnumDataTypeAttribute Class

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

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.

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

  NameDescription
Public propertySupported by Portable Class LibrarySupported in .NET for Windows Store appsCustomDataTypeGets the name of custom field template that is associated with the data field. (Inherited from DataTypeAttribute.)
Public propertySupported by Portable Class LibrarySupported in .NET for Windows Store appsDataTypeGets the type that is associated with the data field. (Inherited from DataTypeAttribute.)
Public propertySupported by Portable Class LibrarySupported in .NET for Windows Store appsDisplayFormatGets a data-field display format. (Inherited from DataTypeAttribute.)
Public propertySupported by Portable Class LibrarySupported in .NET for Windows Store appsEnumTypeGets or sets the enumeration type.
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 propertyRequiresValidationContextGets a value that indicates whether the attribute requires validation context. (Inherited from ValidationAttribute.)
Public propertyTypeIdWhen implemented in a derived class, gets a unique identifier for this Attribute. (Inherited from Attribute.)
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 appsFormatErrorMessageApplies formatting to an error message, based on the data field where the error occurred. (Inherited from ValidationAttribute.)
Public methodSupported by Portable Class LibrarySupported in .NET for Windows Store appsGetDataTypeNameReturns the name of the type that is associated with the data field. (Inherited from DataTypeAttribute.)
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 methodIsValidChecks that the value of the data field is valid. (Overrides DataTypeAttribute.IsValid(Object).)
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

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