DataTypeAttribute Class

DataTypeAttribute Class

 

Specifies the name of an additional type to associate with a data field.

Namespace:   System.ComponentModel.DataAnnotations
Assembly:  System.ComponentModel.DataAnnotations (in System.ComponentModel.DataAnnotations.dll)


<AttributeUsageAttribute(AttributeTargets.Method Or AttributeTargets.Property Or AttributeTargets.Field Or AttributeTargets.Parameter,
	AllowMultiple := False)>
Public Class DataTypeAttribute
	Inherits ValidationAttribute

NameDescription
System_CAPS_pubmethodDataTypeAttribute(DataType)

Initializes a new instance of the DataTypeAttribute class by using the specified type name.

System_CAPS_pubmethodDataTypeAttribute(String)

Initializes a new instance of the DataTypeAttribute class by using the specified field template name.

NameDescription
System_CAPS_pubpropertyCustomDataType

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

System_CAPS_pubpropertyDataType

Gets the type that is associated with the data field.

System_CAPS_pubpropertyDisplayFormat

Gets a data-field display format.

System_CAPS_pubpropertyErrorMessage

Gets or sets an error message to associate with a validation control if validation fails.(Inherited from ValidationAttribute.)

System_CAPS_pubpropertyErrorMessageResourceName

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

System_CAPS_pubpropertyErrorMessageResourceType

Gets or sets the resource type to use for error-message lookup if validation fails.(Inherited from ValidationAttribute.)

System_CAPS_protpropertyErrorMessageString

Gets the localized validation error message.(Inherited from ValidationAttribute.)

System_CAPS_pubpropertyRequiresValidationContext

Gets a value that indicates whether the attribute requires validation context.(Inherited from ValidationAttribute.)

System_CAPS_pubpropertyTypeId

When implemented in a derived class, gets a unique identifier for this Attribute.(Inherited from Attribute.)

NameDescription
System_CAPS_pubmethodEquals(Object)

This API supports the product infrastructure and is not intended to be used directly from your code. Returns a value that indicates whether this instance is equal to a specified object.(Inherited from Attribute.)

System_CAPS_protmethodFinalize()

Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(Inherited from Object.)

System_CAPS_pubmethodFormatErrorMessage(String)

Applies formatting to an error message, based on the data field where the error occurred. (Inherited from ValidationAttribute.)

System_CAPS_pubmethodGetDataTypeName()

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

System_CAPS_pubmethodGetHashCode()

Returns the hash code for this instance.(Inherited from Attribute.)

System_CAPS_pubmethodGetType()

Gets the Type of the current instance.(Inherited from Object.)

System_CAPS_pubmethodGetValidationResult(Object, ValidationContext)

Checks whether the specified value is valid with respect to the current validation attribute.(Inherited from ValidationAttribute.)

System_CAPS_pubmethodIsDefaultAttribute()

When overridden in a derived class, indicates whether the value of this instance is the default value for the derived class.(Inherited from Attribute.)

System_CAPS_pubmethodIsValid(Object)

Checks that the value of the data field is valid.(Overrides ValidationAttribute.IsValid(Object).)

System_CAPS_protmethodIsValid(Object, ValidationContext)

Validates the specified value with respect to the current validation attribute.(Inherited from ValidationAttribute.)

System_CAPS_pubmethodMatch(Object)

When overridden in a derived class, returns a value that indicates whether this instance equals a specified object.(Inherited from Attribute.)

System_CAPS_protmethodMemberwiseClone()

Creates a shallow copy of the current Object.(Inherited from Object.)

System_CAPS_pubmethodToString()

Returns a string that represents the current object.(Inherited from Object.)

System_CAPS_pubmethodValidate(Object, String)

Validates the specified object.(Inherited from ValidationAttribute.)

System_CAPS_pubmethodValidate(Object, ValidationContext)

Validates the specified object.(Inherited from ValidationAttribute.)

NameDescription
System_CAPS_pubinterfaceSystem_CAPS_privmethod_Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr)

Maps a set of names to a corresponding set of dispatch identifiers.(Inherited from Attribute.)

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

System_CAPS_pubinterfaceSystem_CAPS_privmethod_Attribute.GetTypeInfoCount(UInt32)

Retrieves the number of type information interfaces that an object provides (either 0 or 1).(Inherited from Attribute.)

System_CAPS_pubinterfaceSystem_CAPS_privmethod_Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr)

Provides access to properties and methods exposed by an object.(Inherited from Attribute.)

The DataTypeAttribute attribute enables you to mark fields by using a type that is more specific than the database intrinsic type. The type name is selected from the DataType enumeration type. For example, a string data field that contains e-mail addresses can be specified as the EmailAddress type. This information is then accessed by the field templates to modify how the data field is processed.

You use the DataTypeAttribute attribute for the following reasons:

  • To provide additional type information for a data field. You do this by applying the DataTypeAttribute attribute to a data field in the data model and by specifying the additional type name from the DataType enumeration. The field template that processes the data field can access this additional metadata type information to determine how to process the field. For example, the text field template can generate hyperlinks for e-mail addresses whose intrinsic type is String.

  • To associate a custom field template with a data field. The specified custom field template will then be used to process the data field. This is an alternative to using the UIHintAttribute attribute.

When you apply the DataTypeAttribute attribute to a data field you must do the following:

  • Follow the attribute usage rules.

  • Implement the metadata class that contains the data fields to which you want to apply the attribute.

  • Issue validation errors as appropriate.

For more information, see ASP.NET Dynamic Data Guidelines.

See a run-time code example of this feature: Run.

The following example uses the DataTypeAttribute attribute to customize the display of the EmailAddress data field. The e-mail addresses are shown as hyperlinks instead of as simple text, which is what Dynamic Data would infer from the intrinsic data type. The example code is in three parts, and it performs the following steps:

  • It implements a metadata partial class and the associated metadata class.

  • In the associated metadata class, it applies the DataTypeAttribute attribute to the EmailAddress data field by specifying the EmailAddress enumerated value. This indicates to the Text.ascx field template that it should customize the display of e-mail addresses.

  • It modifies the Text.ascx field template to customize the display of the EmailAddress data fields.

Imports System
Imports System.Web.DynamicData
Imports System.ComponentModel.DataAnnotations

<MetadataType(GetType(CustomerMetadata))> _
Partial Public Class Customer


End Class

Public Class CustomerMetadata

    ' Add type information.
    <DataType(DataType.EmailAddress)> _
    Public EmailAddress As Object

End Class

<%@ Control Language="VB" 
  CodeFile="Text.ascx.vb" Inherits="TextField" %>

<!-- Removed, evaluated in the code behind.
<%# FieldValueString %> --> 


Imports System
Imports System.Linq
Imports System.Web.UI.WebControls
Imports System.Web.DynamicData
Imports System.ComponentModel.DataAnnotations

Partial Public Class TextField
    Inherits System.Web.DynamicData.FieldTemplateUserControl

    Protected Overloads Overrides Sub OnDataBinding(ByVal e As EventArgs)
        MyBase.OnDataBinding(e)
        Dim processed As Boolean = False
        Dim metadata As DataTypeAttribute = _
           MetadataAttributes.OfType(Of DataTypeAttribute)().FirstOrDefault()
        If metadata IsNot Nothing Then
            If metadata.DataType = DataType.EmailAddress Then
                If Not String.IsNullOrEmpty(FieldValueString) Then
                    processed = True
                    Dim hyperlink As New HyperLink()
                    hyperlink.Text = FieldValueString
                    hyperlink.NavigateUrl = "mailto:" + FieldValueString
                    Controls.Add(hyperlink)
                End If
            End If
        End If
        If Not processed Then
            Dim literal As New Literal()
            literal.Text = FieldValueString
            Controls.Add(literal)
        End If
    End Sub

End Class

To compile and run the example code, you need the following:

  • Visual Studio 2008 Service Pack 1 or Visual Developer 2008 Express Edition Service Pack 1.

  • The AdventureWorksLT sample database. For information about how to download and install the SQL Server sample database, see Microsoft SQL Server Product Samples: Database on the CodePlex site. Make sure that you install the correct version of the sample database for the version of SQL Server that you are running (SQL Server 2005 or SQL Server 2008).

  • A data-driven Web site. This enables you to create a data context for the database and to create the class that contains the data field to customize. For more information, see Walkthrough: Creating a New Dynamic Data Web Site using Scaffolding.

Universal Windows Platform
Available since 8
.NET Framework
Available since 3.5
Portable Class Library
Supported in: portable .NET platforms
Silverlight
Available since 3.0

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Return to top
Show:
© 2016 Microsoft