CollectionDataContractAttribute Klasse

Definition

Namespace:

System.Runtime.Serialization

Assemblys:

netstandard.dll, System.Runtime.Serialization.Primitives.dll

Quelle:

CollectionDataContractAttribute.cs

Wenn sie auf einen Sammlungstyp angewendet wird, wird die benutzerdefinierte Spezifikation der Sammlungselementelemente aktiviert. 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 die CollectionDataContractAttribute Klasse angewendet, die von der List<T> Klasse erbt. Der Code legt die und ItemName die Name Eigenschaften 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) verwendet wird, um Code für den Client zu generieren, ähnelt der Code dem folgenden Beispiel. Beachten Sie, dass der Name der Klasse sowie die ItemName. Bei Verwendung von Generika 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

Dies CollectionDataContractAttribute soll die Interoperabilität beim Arbeiten mit Daten von Nicht-WCF-Anbietern erleichtern und die genaue Form serialisierter Instanzen steuern. Zu diesem Zweck können Sie mit der ItemName Eigenschaft die Namen der wiederholten Elemente innerhalb einer Auflistung steuern. Dies ist besonders nützlich, wenn der Anbieter den XML-Elementtypnamen nicht als Arrayelementnamen verwendet, z. B. wenn ein Anbieter "String" anstelle des XSD-Typnamens "string" verwendet.

Dies CollectionDataContractAttribute soll auch mit Wörterbuchtypen für die Behandlung von Schlüsselauflistungen verwendet werden. Wörterbuchtypen sind Klassen, die entweder die IDictionary Schnittstelle oder die IDictionary<TKey,TValue> Schnittstelle implementieren, z. B. die Dictionary<TKey,TValue>. Verwenden Sie die KeyName Eigenschaften, ValueName um benutzerdefinierte Namen bei Verwendung der Dictionary<TKey,TValue> Klasse festzulegen.

Weitere Informationen zur Verwendung der DataContractSerializerDatenverträge finden Sie unter Verwenden von Datenverträgen.

Konstruktoren

Name	Beschreibung
CollectionDataContractAttribute()	Initialisiert eine neue Instanz der CollectionDataContractAttribute-Klasse.

Eigenschaften

Name	Beschreibung
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	Dient zum Abrufen oder Festlegen eines benutzerdefinierten Namens für ein Auflistungselement.
KeyName	Dient zum Abrufen oder Festlegen des benutzerdefinierten Namens für einen Wörterbuchschlüsselnamen.
Name	Dient zum Abrufen oder Festlegen des Datenvertragsnamens für den Sammlungstyp.
Namespace	Ruft den Namespace für den Datenvertrag ab oder legt den Namespace fest.
TypeId	Wenn sie in einer abgeleiteten Klasse implementiert wird, wird ein eindeutiger Bezeichner für diese Attribute. (Geerbt von Attribute)
ValueName	Dient zum Abrufen oder Festlegen des benutzerdefinierten Namens für einen Wörterbuchwertnamen.

Methoden

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

Weitere Informationen

• DataContractSerializer