DataTypeAttribute クラス

定義

データ フィールドに関連付ける追加の型の名前を指定します。Specifies the name of an additional type to associate with a data field.

public ref class DataTypeAttribute : System::ComponentModel::DataAnnotations::ValidationAttribute
[System.AttributeUsage(System.AttributeTargets.Field | System.AttributeTargets.Method | System.AttributeTargets.Parameter | System.AttributeTargets.Property, AllowMultiple=false)]
[System.AttributeUsage]
[System.AttributeUsage(System.AttributeTargets.Field | System.AttributeTargets.Property, AllowMultiple=false)]
public class DataTypeAttribute : System.ComponentModel.DataAnnotations.ValidationAttribute
type DataTypeAttribute = class
    inherit ValidationAttribute
Public Class DataTypeAttribute
Inherits ValidationAttribute
継承
派生
属性

次の例では、DataTypeAttribute 属性を使用して、EmailAddress データフィールドの表示をカスタマイズします。The following example uses the DataTypeAttribute attribute to customize the display of the EmailAddress data field. 電子メールアドレスは、単純なテキストとしてではなくハイパーリンクとして表示されます。これは、組み込みのデータ型から推論される動的データです。The email addresses are shown as hyperlinks instead of as simple text, which is what Dynamic Data would infer from the intrinsic data type. コード例は3つの部分に分かれており、次の手順を実行します。The example code is in three parts, and it performs the following steps:

  • メタデータ部分クラスと関連付けられたメタデータクラスを実装します。It implements a metadata partial class and the associated metadata class.

  • 関連付けられたメタデータクラスでは、EmailAddress 列挙値を指定することによって、EmailAddress データフィールドに DataTypeAttribute 属性を適用します。In the associated metadata class, it applies the DataTypeAttribute attribute to the EmailAddress data field by specifying the EmailAddress enumerated value. これは、テキスト .ascx フィールドテンプレートに対して、電子メールアドレスの表示をカスタマイズする必要があることを示します。This indicates to the Text.ascx field template that it should customize the display of email addresses.

  • EmailAddress データフィールドの表示をカスタマイズするために、テキスト .ascx フィールドテンプレートを変更します。It modifies the Text.ascx field template to customize the display of the EmailAddress data fields.

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

コード例をコンパイルして実行するには、次のものが必要です。To compile and run the example code, you need the following:

  • Visual Studio 2010 以降の任意のエディション。Any edition of Visual Studio 2010 or later.

  • AdventureWorksLT サンプルデータベース。The AdventureWorksLT sample database. SQL Server サンプルデータベースをダウンロードしてインストールする方法の詳細については、GitHub の「製品サンプル: データベース」を参照し Microsoft SQL Server てください。For information about how to download and install the SQL Server sample database, see Microsoft SQL Server Product Samples: Database on GitHub. 実行している SQL Server のバージョンに適したバージョンのサンプルデータベースがインストールされていることを確認してください。Make sure that you install the correct version of the sample database for the version of SQL Server that you are running.

  • データドリブンの Web サイト。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. 詳細については、「 Walkthrough: Creating a New Dynamic Data Web Site using Scaffolding」を参照してください。For more information, see Walkthrough: Creating a New Dynamic Data Web Site using Scaffolding.

注釈

DataTypeAttribute 属性を使用すると、データベースの組み込み型よりも具体的な型を使用してフィールドにマークを付けることができます。The DataTypeAttribute attribute enables you to mark fields by using a type that is more specific than the database intrinsic type. 型名は DataType 列挙型から選択されます。The type name is selected from the DataType enumeration type. たとえば、電子メールアドレスを含む文字列データフィールドを EmailAddress の種類として指定できます。For example, a string data field that contains email 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.

DataTypeAttribute 属性は、次の理由で使用します。You use the DataTypeAttribute attribute for the following reasons:

  • データフィールドに追加の型情報を提供する場合は。To provide additional type information for a data field. これを行うには、データモデルのデータフィールドに DataTypeAttribute 属性を適用し、DataType 列挙体から追加の型名を指定します。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. たとえば、テキストフィールドテンプレートでは、組み込み型が String電子メールアドレスのハイパーリンクを生成できます。For example, the text field template can generate hyperlinks for email 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. これは、UIHintAttribute 属性を使用する代わりに使用できます。This is an alternative to using the UIHintAttribute attribute.

DataTypeAttribute 属性をデータフィールドに適用する場合は、次の操作を行う必要があります。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.

詳細については、「 ASP.NET 動的データのガイドライン」を参照してください。For more information, see ASP.NET Dynamic Data Guidelines.

コンストラクター

DataTypeAttribute(DataType)

指定した型名を使用して、DataTypeAttribute クラスの新しいインスタンスを初期化します。Initializes a new instance of the DataTypeAttribute class by using the specified type name.

DataTypeAttribute(String)

指定されたフィールド テンプレート名を使用して、DataTypeAttribute クラスの新しいインスタンスを初期化します。Initializes a new instance of the DataTypeAttribute class by using the specified field template name.

プロパティ

CustomDataType

データ フィールドに関連付けられたカスタム フィールド テンプレートの名前を取得します。Gets the name of custom field template that is associated with the data field.

DataType

データ フィールドに関連付けられた型を取得します。Gets the type that is associated with the data field.

DisplayFormat

データ フィールドの表示形式を取得します。Gets a data-field display format.

ErrorMessage

検証が失敗した場合に検証コントロールに関連付けるエラー メッセージを取得または設定します。Gets or sets an error message to associate with a validation control if validation fails.

(継承元 ValidationAttribute)
ErrorMessageResourceName

検証が失敗した場合に ErrorMessageResourceType プロパティ値の検索に使用するエラー メッセージ リソース名を取得または設定します。Gets or sets the error message resource name to use in order to look up the ErrorMessageResourceType property value if validation fails.

(継承元 ValidationAttribute)
ErrorMessageResourceType

検証が失敗した場合にエラー メッセージの検索に使用するリソースの種類を取得または設定します。Gets or sets the resource type to use for error-message lookup if validation fails.

(継承元 ValidationAttribute)
ErrorMessageString

ローカライズされた検証エラー メッセージを取得します。Gets the localized validation error message.

(継承元 ValidationAttribute)
RequiresValidationContext

属性で検証コンテキストが必要かどうかを示す値を取得します。Gets a value that indicates whether the attribute requires validation context.

(継承元 ValidationAttribute)
TypeId

派生クラスで実装されると、この Attribute の一意の識別子を取得します。When implemented in a derived class, gets a unique identifier for this Attribute.

(継承元 Attribute)

メソッド

Equals(Object)

このインスタンスが、指定されたオブジェクトと等価であるかどうかを示す値を返します。Returns a value that indicates whether this instance is equal to a specified object.

(継承元 Attribute)
FormatErrorMessage(String)

エラーが発生したデータ フィールドに基づいて、エラー メッセージに書式を適用します。Applies formatting to an error message, based on the data field where the error occurred.

(継承元 ValidationAttribute)
GetDataTypeName()

データ フィールドに関連付けられた型の名前を返します。Returns the name of the type that is associated with the data field.

GetHashCode()

このインスタンスのハッシュ コードを返します。Returns the hash code for this instance.

(継承元 Attribute)
GetType()

現在のインスタンスの Type を取得します。Gets the Type of the current instance.

(継承元 Object)
GetValidationResult(Object, ValidationContext)

現在の検証属性に対して、指定した値が有効かどうかを確認します。Checks whether the specified value is valid with respect to the current validation attribute.

(継承元 ValidationAttribute)
IsDefaultAttribute()

派生クラスでオーバーライドされるとき、このインスタンスの値が派生クラスの既定値であるかどうかを示します。When overridden in a derived class, indicates whether the value of this instance is the default value for the derived class.

(継承元 Attribute)
IsValid(Object)

データ フィールドの値が有効かどうかをチェックします。Checks that the value of the data field is valid.

IsValid(Object, ValidationContext)

現在の検証属性に対して、指定した値を検証します。Validates the specified value with respect to the current validation attribute.

(継承元 ValidationAttribute)
Match(Object)

派生クラス内でオーバーライドされたときに、指定したオブジェクトとこのインスタンスが等しいかどうかを示す値を返します。When overridden in a derived class, returns a value that indicates whether this instance equals a specified object.

(継承元 Attribute)
MemberwiseClone()

現在の Object の簡易コピーを作成します。Creates a shallow copy of the current Object.

(継承元 Object)
ToString()

現在のオブジェクトを表す string を返します。Returns a string that represents the current object.

(継承元 Object)
Validate(Object, String)

指定されたオブジェクトを検証します。Validates the specified object.

(継承元 ValidationAttribute)
Validate(Object, ValidationContext)

指定されたオブジェクトを検証します。Validates the specified object.

(継承元 ValidationAttribute)

明示的なインターフェイスの実装

_Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr)

一連の名前を対応する一連のディスパッチ識別子に割り当てます。Maps a set of names to a corresponding set of dispatch identifiers.

(継承元 Attribute)
_Attribute.GetTypeInfo(UInt32, UInt32, IntPtr)

オブジェクトの型情報を取得します。この情報はインターフェイスの型情報の取得に使用できます。Retrieves the type information for an object, which can be used to get the type information for an interface.

(継承元 Attribute)
_Attribute.GetTypeInfoCount(UInt32)

オブジェクトが提供する型情報インターフェイスの数 (0 または 1) を取得します。Retrieves the number of type information interfaces that an object provides (either 0 or 1).

(継承元 Attribute)
_Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr)

オブジェクトによって公開されたプロパティおよびメソッドへのアクセスを提供します。Provides access to properties and methods exposed by an object.

(継承元 Attribute)

適用対象

こちらもご覧ください