DataTypeAttribute クラス

リファレンス

定義

名前空間:: System.ComponentModel.DataAnnotations

アセンブリ:: System.ComponentModel.Annotations.dll

アセンブリ:: System.ComponentModel.Annotations.dll, System.ComponentModel.DataAnnotations.dll

アセンブリ:: System.ComponentModel.DataAnnotations.dll

重要

一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。

データフィールドに関連付ける追加の型の名前を指定します。

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

[<System.AttributeUsage(System.AttributeTargets.Field | 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

その他…

属性: AttributeUsageAttribute

例

次の例では、この属性を DataTypeAttribute 使用して EmailAddress データフィールドの表示をカスタマイズします。電子メールアドレスは、単純なテキストではなくハイパーリンクとして表示されます。これは、動的データが組み込みデータ型から推論する内容です。コード例は 3 つの部分にあり、次の手順を実行します。

メタデータ部分クラスと関連付けられたメタデータクラスを実装します。
関連付けられたメタデータクラスでは、列挙値を 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のバージョンに合った正しいバージョンのサンプルデータベースをインストールしてください。
データドリブン Web サイト。これにより、データベースのデータコンテキストを作成し、カスタマイズするデータフィールドを含むクラスを作成できます。詳細については、「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)

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

_Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr)	一連の名前を対応する一連のディスパッチ識別子に割り当てます。 (継承元 Attribute)
_Attribute.GetTypeInfo(UInt32, UInt32, IntPtr)	オブジェクトの型情報を取得します。この情報はインターフェイスの型情報の取得に使用できます。 (継承元 Attribute)
_Attribute.GetTypeInfoCount(UInt32)	オブジェクトが提供する型情報インターフェイスの数 (0 または 1) を取得します。 (継承元 Attribute)
_Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr)	オブジェクトによって公開されたプロパティおよびメソッドへのアクセスを提供します。 (継承元 Attribute)

適用対象