CollectionDataContractAttribute Classe

Definizione

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

Ereditarietà

Object

Attribute

CollectionDataContractAttribute

Attributi

AttributeUsageAttribute

Esempio

Nell'esempio seguente viene applicato l'attributo CollectionDataContractAttribute a una classe che eredita dalla classe List<T>. Il codice imposta le proprietà Name e ItemName su valori personalizzati.

[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

Quando lo strumento utilità metadati ServiceModel (Svcutil.exe) viene usato per generare codice per il client, il codice è simile all'esempio seguente. Il nome della classe risulta modificato, così come ItemName. Quando si utilizzano generics, il nome del parametro di tipo viene utilizzato per creare il nome del tipo risultante.

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

Commenti

l'oggetto CollectionDataContractAttribute è progettato per semplificare l'interoperabilità quando si utilizzano dati da provider non WCF e per controllare la forma esatta delle istanze serializzate. A tal fine, la proprietà ItemName consente di controllare i nomi degli elementi ripetuti all'interno di una raccolta. Ciò risulta particolarmente utile quando il provider non utilizza il nome del tipo di elemento XML come nome di un elemento della matrice. È ad esempio possibile che un provider utilizzi "String" come nome del tipo di elemento anziché il nome del tipo XSD "string".

La classe CollectionDataContractAttribute può essere inoltre utilizzata con tipi di dizionario per gestire raccolte con chiave. I tipi di dizionario sono classi che implementano l'interfaccia IDictionary o IDictionary<TKey,TValue>, ad esempio Dictionary<TKey,TValue>. Utilizzare le proprietà KeyName e ValueName per impostare nomi personalizzati quando si utilizza la classe Dictionary<TKey,TValue>.

Per altre informazioni sull'uso di DataContractSerializer, vedere Uso dei contratti dati.

Costruttori

Proprietà

Metodi

Implementazioni dell'interfaccia esplicita

Si applica a

Vedi anche

• DataContractSerializer