CollectionDataContractAttribute Classe

Définition

public ref class CollectionDataContractAttribute sealed : Attribute

[System.AttributeUsage(System.AttributeTargets.Class | System.AttributeTargets.Struct, AllowMultiple=false, Inherited=false)]
public sealed class CollectionDataContractAttribute : Attribute

[<System.AttributeUsage(System.AttributeTargets.Class | System.AttributeTargets.Struct, AllowMultiple=false, Inherited=false)>]
type CollectionDataContractAttribute = class
    inherit Attribute

Public NotInheritable Class CollectionDataContractAttribute
Inherits Attribute

Héritage

Object

Attribute

CollectionDataContractAttribute

Attributs

AttributeUsageAttribute

Exemples

L'exemple suivant applique le CollectionDataContractAttribute à une classe qui hérite de la classe List<T>. Le code affecte des valeurs personnalisées aux propriétés Name et ItemName.

[CollectionDataContract(Name = "Custom{0}List", ItemName = "CustomItem")]
public class CustomList<T> : List<T>
{
    public CustomList()
        : base()
    {
    }

    public CustomList(T[] items)
        : base()
    {
        foreach (T item in items)
        {
            Add(item);
        }
    }
}

<CollectionDataContract(Name := "Custom{0}List", ItemName := "CustomItem")> _
Public Class CustomList(Of T)
    Inherits List(Of T)
    Public Sub New()
        MyBase.New()
    End Sub

    Public Sub New(ByVal items() As T)
        MyBase.New()
        For Each item As T In items
            Add(item)
        Next item
    End Sub
End Class

Lorsque l’outil ServiceModel Metadata Utility Tool (Svcutil.exe) est utilisé pour générer du code pour le client, le code ressemble à l’exemple suivant. Remarquez que le nom de la classe est modifié, tout comme la ItemName. Lors de l’utilisation de génériques, le nom de paramètre de type est utilisé pour créer le nom de type résultant.

// This is the generated code. Note that the class is renamed to "CustomBookList",
// and the ItemName is set to "CustomItem".
[System.CodeDom.Compiler.GeneratedCodeAttribute("System.Runtime.Serialization", "3.0.0.0")]
[System.Runtime.Serialization.CollectionDataContractAttribute(ItemName = "CustomItem")]
public class CustomBookList : System.Collections.Generic.List<Microsoft.Security.Samples.Book>
{
}

' This is the generated code. Note that the class is renamed to "CustomBookList", 
' and the ItemName is set to "CustomItem".
<System.CodeDom.Compiler.GeneratedCodeAttribute("System.Runtime.Serialization", "3.0.0.0"), System.Runtime.Serialization.CollectionDataContractAttribute(ItemName := "CustomItem")> _
Public Class CustomBookList
    Inherits System.Collections.Generic.List(Of Microsoft.Security.Samples.Book)
End Class

Remarques

Le CollectionDataContractAttribute est destiné à faciliter l’interopérabilité lors de l’utilisation de données provenant de fournisseurs non WCF et à contrôler la forme exacte des instances sérialisées. À cette fin, la propriété ItemName vous permet de contrôler les noms des éléments à répétition à l’intérieur d’une collection. Cette technique est particulièrement utile lorsque le fournisseur n'utilise pas le nom du type d'élément XML comme nom d'élément de tableau, par exemple, si un fournisseur utilise « String » comme nom de type d'élément à la place du nom de type XSD « string ».

Le CollectionDataContractAttribute est également prévu pour être utilisé avec les types de dictionnaire afin de gérer des collections à clé. Les types de dictionnaire sont des classes qui implémentent l'interface IDictionary ou IDictionary<TKey,TValue>, par exemple, le Dictionary<TKey,TValue>. Utilisez les propriétés KeyName et ValueName pour définir des noms personnalisés en cas d'utilisation de la classe Dictionary<TKey,TValue>.

Pour plus d’informations sur l’utilisation de DataContractSerializer, consultez Utilisation de contrats de données.

Constructeurs

Propriétés

Méthodes

Implémentations d’interfaces explicites

S’applique à

Voir aussi

• DataContractSerializer