DataTypeAttribute Класс

Определение

Пространство имен:

System.ComponentModel.DataAnnotations

Сборка:

System.ComponentModel.Annotations.dll

Исходный код:

DataTypeAttribute.cs

Задает имя дополнительного типа, который необходимо связать с полем данных.

public ref class DataTypeAttribute : System::ComponentModel::DataAnnotations::ValidationAttribute

[System.AttributeUsage(System.AttributeTargets.Field | System.AttributeTargets.Method | System.AttributeTargets.Parameter | System.AttributeTargets.Property, AllowMultiple=false)]
public class DataTypeAttribute : System.ComponentModel.DataAnnotations.ValidationAttribute

[<System.AttributeUsage(System.AttributeTargets.Field | System.AttributeTargets.Method | System.AttributeTargets.Parameter | System.AttributeTargets.Property, AllowMultiple=false)>]
type DataTypeAttribute = class
    inherit ValidationAttribute

Public Class DataTypeAttribute
Inherits ValidationAttribute

Наследование

Object

Attribute

ValidationAttribute

DataTypeAttribute

Производный

System.ComponentModel.DataAnnotations.CreditCardAttribute

System.ComponentModel.DataAnnotations.EmailAddressAttribute

System.ComponentModel.DataAnnotations.EnumDataTypeAttribute

System.ComponentModel.DataAnnotations.FileExtensionsAttribute

System.ComponentModel.DataAnnotations.PhoneAttribute

System.ComponentModel.DataAnnotations.UrlAttribute

Атрибуты

AttributeUsageAttribute

Примеры

В следующем примере атрибут используется DataTypeAttribute для настройки отображения поля данных EmailAddress. Адреса электронной почты отображаются в виде гиперссылок, а не в виде простого текста, который динамические данные будут выводить из встроенного типа данных. Пример кода состоит из трех частей и выполняет следующие действия:

• Он реализует разделяемый класс метаданных и связанный класс метаданных.

• В связанном классе метаданных атрибут применяется DataTypeAttribute к полю данных EmailAddress, указывая EmailAddress перечислимое значение. Это указывает шаблону поля Text.ascx, что он должен настроить отображение адресов электронной почты.

• Он изменяет шаблон поля Text.ascx, чтобы настроить отображение полей данных EmailAddress.

using System;
using System.Web.DynamicData;
using System.ComponentModel.DataAnnotations;

[MetadataType(typeof(CustomerMetaData))]
public partial class Customer
{
}

public class CustomerMetaData
{

    // Add type information.
    [DataType(DataType.EmailAddress)]
    public object EmailAddress;
}

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="C#" 
CodeFile="Text.ascx.cs" Inherits="TextField" %>

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

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

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

using System;
using System.Linq;
using System.Web.UI.WebControls;
using System.Web.DynamicData;
using System.ComponentModel.DataAnnotations;

public partial class TextField : 
    System.Web.DynamicData.FieldTemplateUserControl {

    protected override void OnDataBinding(EventArgs e)
    {
        base.OnDataBinding(e);
        bool processed = false;
        var metadata = MetadataAttributes.OfType
            <DataTypeAttribute>().FirstOrDefault();
        if (metadata != null)
        {
            if (metadata.DataType == DataType.EmailAddress)
            {
                if (!string.IsNullOrEmpty(FieldValueString))
                {
                    processed = true;
                    HyperLink hyperlink = new HyperLink();
                    hyperlink.Text = FieldValueString;
                    hyperlink.NavigateUrl = "mailto:" + FieldValueString;
                    Controls.Add(hyperlink);
                }
            }
        }
        if (!processed)
        {
            Literal literal = new Literal();
            literal.Text = FieldValueString;
            Controls.Add(literal);
        }
    }
}

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

Чтобы скомпилировать и запустить пример кода, вам потребуется следующее:

• Любой выпуск Visual Studio 2010 или более поздней версии.

• Пример базы данных AdventureWorksLT. Сведения о том, как скачать и установить образец базы данных SQL Server, см. в разделе Примеры продуктов Microsoft SQL Server: База данных на GitHub. Убедитесь, что установлена правильная версия образца базы данных для версии SQL Server, которую вы используете.

• Управляемый данными веб-сайт. Это позволяет создать контекст данных для базы данных и класс, содержащий настраиваемое поле данных. Для получения дополнительной информации см. Walkthrough: Creating a New Dynamic Data Web Site using Scaffolding.

Комментарии

Атрибут DataTypeAttribute позволяет помечать поля с помощью типа, который более специфичен, чем встроенный тип базы данных. Имя типа выбирается из типа перечисления DataType . Например, в качестве EmailAddress типа можно указать строковое поле данных, содержащее адреса электронной почты. Затем шаблоны полей получают доступ к этой информации, чтобы изменить способ обработки поля данных.

Атрибут используется DataTypeAttribute по следующим причинам:

• Предоставление дополнительных сведений о типе для поля данных. Это можно сделать, применив DataTypeAttribute атрибут к полю данных в модели данных и указав дополнительное имя типа из перечисления DataType . Шаблон поля, обрабатывающий поле данных, может получить доступ к дополнительным сведениям о типе метаданных, чтобы определить способ обработки поля. Например, шаблон текстового поля может создавать гиперссылки для адресов электронной почты, встроенный тип которых — String.

• Чтобы связать шаблон настраиваемого поля с полем данных. Затем для обработки поля данных будет использоваться указанный шаблон настраиваемого поля. Это альтернатива использованию атрибута UIHintAttribute .

При применении атрибута DataTypeAttribute к полю данных необходимо сделать следующее:

• Следуйте правилам использования атрибутов.

• Реализуйте класс метаданных, содержащий поля данных, к которым требуется применить атрибут .

• Выдает ошибки проверки соответствующим образом.

Дополнительные сведения см. в ASP.NET рекомендации по использованию динамических данных.

Конструкторы

DataTypeAttribute(DataType)	Инициализирует новый экземпляр DataTypeAttribute, используя указанное имя типа.
DataTypeAttribute(String)	Инициализирует новый экземпляр класса DataTypeAttribute, используя указанное имя шаблона поля.

Свойства

CustomDataType	Получает имя шаблона настраиваемого поля, связанного с полем данных.
DataType	Получает тип, связанный с полем данных.
DisplayFormat	Получает формат отображения поля данных.
ErrorMessage	Получает или задает сообщение об ошибке, которое необходимо связать с проверяющим элементом управления на случай сбоя во время проверки. (Унаследовано от ValidationAttribute)
ErrorMessageResourceName	Получает или задает имя ресурса сообщений об ошибках, используемого для поиска значения свойства ErrorMessageResourceType в случае сбоя при проверке. (Унаследовано от ValidationAttribute)
ErrorMessageResourceType	Получает или задает тип ресурса, используемого для поиска сообщения об ошибке в случае сбоя проверки. (Унаследовано от ValidationAttribute)
ErrorMessageString	Получает локализованное сообщение об ошибке проверки. (Унаследовано от ValidationAttribute)
RequiresValidationContext	Получает значение, указывающее, требует ли атрибут контекста проверки. (Унаследовано от ValidationAttribute)
TypeId	В случае реализации в производном классе возвращает уникальный идентификатор для этого атрибута Attribute. (Унаследовано от Attribute)

Методы

Equals(Object)	Возвращает значение, показывающее, равен ли экземпляр указанному объекту. (Унаследовано от Attribute)
FormatErrorMessage(String)	Применяет к сообщению об ошибке форматирование на основе поля данных, в котором произошла ошибка. (Унаследовано от ValidationAttribute)
GetDataTypeName()	Возвращает имя типа, связанного с полем данных.
GetHashCode()	Возвращает хэш-код данного экземпляра. (Унаследовано от Attribute)
GetType()	Возвращает объект Type для текущего экземпляра. (Унаследовано от Object)
GetValidationResult(Object, ValidationContext)	Проверяет, является ли заданное значение допустимым относительно текущего атрибута проверки. (Унаследовано от ValidationAttribute)
IsDefaultAttribute()	При переопределении в производном классе указывает, является ли значение этого экземпляра значением по умолчанию для производного класса. (Унаследовано от Attribute)
IsValid(Object)	Проверяет, действительно ли значение поля данных является пустым.
IsValid(Object, ValidationContext)	Проверяет заданное значение относительно текущего атрибута проверки. (Унаследовано от ValidationAttribute)
Match(Object)	При переопределении в производном классе возвращает значение, указывающее, является ли этот экземпляр равным заданному объекту. (Унаследовано от Attribute)
MemberwiseClone()	Создает неполную копию текущего объекта Object. (Унаследовано от Object)
ToString()	Возвращает строку, представляющую текущий объект. (Унаследовано от Object)
Validate(Object, String)	Проверяет указанный объект. (Унаследовано от ValidationAttribute)
Validate(Object, ValidationContext)	Проверяет указанный объект. (Унаследовано от ValidationAttribute)

См. также раздел

• ValidationAttribute
• UIHintAttribute
• DataType
• AttributeUsageAttribute
• AttributeTargets
• Практическое руководство. Настройка внешнего вида и поведения поля данных для не встроенных типов данных в модели данных
• Расширение метаданных с помощью атрибутов