CollectionDataContractAttribute Klasse

Definition

Namespace:

System.Runtime.Serialization

Assembly:

System.Runtime.Serialization.Primitives.dll

Quelle:

CollectionDataContractAttribute.cs

Ermöglich bei Anwendung auf einen Auflistungstyp die benutzerdefinierte Angabe der Auflistungselemente. Dieses Attribut kann nur auf Typen angewendet werden, die vom DataContractSerializer als gültige, serialisierbare Auflistungen erkannt werden.

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

Vererbung

Object

Attribute

CollectionDataContractAttribute

Attribute

AttributeUsageAttribute

Beispiele

Im folgenden Beispiel wird der CollectionDataContractAttribute auf eine Klasse angewendet, die von der List<T>-Klasse erbt. Der Code legt die Name-Eigenschaft und die ItemName-Eigenschaft auf benutzerdefinierte Werte fest.

[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

Wenn das ServiceModel Metadata Utility Tool (Svcutil.exe) zum Generieren von Code für den Client verwendet wird, ähnelt der Code dem folgenden Beispiel. Beachten Sie, dass sowohl der Name der Klasse als auch der ItemName geändert werden. Bei der Verwendung von Generics wird der Typparametername verwendet, um den resultierenden Typnamen zu erstellen.

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

Hinweise

Die CollectionDataContractAttribute soll die Interoperabilität beim Arbeiten mit Daten von Nicht-WCF-Anbietern erleichtern und die genaue Form serialisierter Instanzen steuern. Deshalb können Sie mit der ItemName-Eigenschaft die Namen der sich wiederholenden Elemente in einer Auflistung kontrollieren. Dies ist besonders dann sinnvoll, wenn der Anbieter den XML-Elementtypnamen nicht als Arrayelementnamen verwendet: wenn der Anbieter beispielsweise anstelle des XSD-Typnamens "string" als Elementtypnamen "String" verwendet.

Der CollectionDataContractAttribute ist auch für die Verwendung mit Wörterbuchtypen zur Behandlung verschlüsselter Auflistungen vorgesehen. Wörterbuchtypen sind Klassen, die entweder den IDictionary oder die IDictionary<TKey,TValue>-Schnittstelle implementieren, z. B. Dictionary<TKey,TValue>. Verwenden Sie die KeyName-Eigenschaft und die ValueName-Eigenschaft, um benutzerdefinierte Namen festzulegen, wenn Sie die Dictionary<TKey,TValue>-Klasse verwenden.

Weitere Informationen zur Verwendung von finden Sie unter Verwenden vonDataContractSerializer Datenverträgen.

Konstruktoren

CollectionDataContractAttribute()

Initialisiert eine neue Instanz der CollectionDataContractAttribute-Klasse.

Eigenschaften

IsItemNameSetExplicitly	Ruft ab, ob ItemName explizit festgelegt wurde.
IsKeyNameSetExplicitly	Ruft ab, ob KeyName explizit festgelegt wurde.
IsNameSetExplicitly	Ruft ab, ob Name explizit festgelegt wurde.
IsNamespaceSetExplicitly	Ruft ab, ob Namespace explizit festgelegt wurde.
IsReference	Ruft einen Wert ab oder legt einen Wert fest, der angibt, ob Objektverweisdaten beizubehalten sind.
IsReferenceSetExplicitly	Ruft ab, ob der Verweis explizit festgelegt wurde.
IsValueNameSetExplicitly	Ruft ab, ob ValueName explizit festgelegt wurde.
ItemName	Ruft einen benutzerdefinierten Namen für ein Auflistungselement ab oder legt ihn fest.
KeyName	Ruft den benutzerdefinierten Namen für einen Wörterbuchschlüsselnamen ab oder legt ihn fest.
Name	Ruft den Namen des Datenvertrags für den Auflistungstyp ab oder legt ihn fest.
Namespace	Ruft den Namespace für den Datenvertrag ab oder legt ihn fest.
TypeId	Ruft bei Implementierung in einer abgeleiteten Klasse einen eindeutigen Bezeichner für dieses Attribute ab. (Geerbt von Attribute)
ValueName	Ruft den benutzerdefinierten Namen für einen Wörterbuchwertnamen ab oder legt ihn fest.

Methoden

Equals(Object)	Gibt einen Wert zurück, der angibt, ob diese Instanz gleich einem angegebenen Objekt ist. (Geerbt von Attribute)
GetHashCode()	Gibt den Hashcode für diese Instanz zurück. (Geerbt von Attribute)
GetType()	Ruft den Type der aktuellen Instanz ab. (Geerbt von Object)
IsDefaultAttribute()	Gibt beim Überschreiben in einer abgeleiteten Klasse an, ob der Wert der Instanz der Standardwert für die abgeleitete Klasse ist. (Geerbt von Attribute)
Match(Object)	Beim Überschreiben in einer abgeleiteten Klasse wird ein Wert zurückgegeben, der angibt, ob diese Instanz einem bestimmten Objekt entspricht. (Geerbt von Attribute)
MemberwiseClone()	Erstellt eine flache Kopie des aktuellen Object. (Geerbt von Object)
ToString()	Gibt eine Zeichenfolge zurück, die das aktuelle Objekt darstellt. (Geerbt von Object)

Weitere Informationen

• DataContractSerializer