DataTypeAttribute, classe (System.ComponentModel.DataAnnotations)

L'attribut DataTypeAttribute vous permet de marquer des champs à l'aide d'un type qui est plus spécifique que le type intrinsèque de la base de données. Le nom de type est sélectionné à partir du type énumération DataType. Par exemple, un champ de données de type chaîne qui contient des adresses de messagerie peut être spécifié comme type EmailAddress. Ces informations sont ensuite accessibles par les modèles de champs afin de modifier la façon dont le champ de données est traité.

Vous utilisez l'attribut DataTypeAttribute pour les raisons suivantes :

• Pour fournir des informations de type supplémentaires pour un champ de données. Pour cela, vous appliquez l'attribut DataTypeAttribute à un champ de données dans le modèle de données et vous spécifiez le nom de type supplémentaire à partir de l'énumération DataType. Le modèle de champ qui traite le champ de données peut accéder à ces informations de type de métadonnées supplémentaires pour déterminer comment traiter le champ. Par exemple, le modèle de champ de texte peut générer des liens hypertexte pour des adresses de messagerie dont le type intrinsèque est String.

• Pour associer un modèle de champ personnalisé à un champ de données. Le modèle de champ personnalisé spécifié sera ensuite utilisé pour traiter le champ de données. Il s'agit d'une alternative à l'utilisation de l'attribut UIHintAttribute.

Lorsque vous appliquez l'attribut DataTypeAttribute à un champ de données, vous devez effectuer les opérations suivantes :

• suivre les règles d'utilisation de l'attribut ;

• implémenter la classe de métadonnées qui contient les champs de données auxquels vous souhaitez appliquer l'attribut ;

• émettre des erreurs de validation le cas échéant.

Pour plus d'informations, consultez Instructions relatives à Dynamic Data ASP.NET.

Consultez un exemple de code de runtime de cette fonctionnalité : Run.

L'exemple suivant utilise l'attribut DataTypeAttribute pour personnaliser l'affichage du champ de données EmailAddress. Les adresses de messagerie sont indiquées comme liens hypertexte plutôt que texte simple, qui est ce que Dynamic Data déduirait du type de données intrinsèque. L'exemple de code est composé de trois parties et il exécute les étapes suivantes :

• Il implémente une classe de métadonnées partielle et la classe de métadonnées associée.

• Dans la classe de métadonnées associée, il applique l'attribut DataTypeAttribute au champ de données EmailAddress en spécifiant la valeur énumérée EmailAddress. Cela indique au modèle de champ Text.ascx qu'il doit personnaliser l'affichage des adresses de messagerie.

• Il modifie le modèle de champ Text.ascx pour personnaliser l'affichage des champs de données EmailAddress.

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

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;

}

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

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

<%@ Control Language="C#" 
CodeFile="Text.ascx.cs" 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

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);
        }
    }

}

Pour compiler et exécuter cet exemple de code, vous avez besoin des éléments suivants :

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

• L'exemple de base de données AdventureWorksLT. Pour plus d'informations sur le téléchargement et l'installation de l'exemple de base de données SQL Server, consultez Exemples de produits Microsoft SQL Server : Base de données (en anglais) sur le site CodePlex. Assurez-vous d'installer la version de l'exemple de base de données correspondant à la version de SQL Server que vous exécutez (SQL Server 2005 ou SQL Server 2008).

• Un site Web piloté par des données. Celui-ci vous permet de créer un contexte de données pour la base de données, ainsi que la classe qui contient le champ de données à personnaliser. Pour plus d'informations, consultez Walkthrough: Creating a New Dynamic Data Web Site using Scaffolding.

.NET Framework

.NET Framework Client Profile

Windows 7, Windows Vista SP1 ou ultérieur, Windows XP SP3, Windows Server 2008 (installation minimale non prise en charge), Windows Server 2008 R2 (installation minimale prise en charge avec SP1 ou version ultérieure), Windows Server 2003 SP2

Référence

Autres ressources