CollectionDataContractAttribute Klasse

Definition

Ermöglich bei Anwendung auf einen Auflistungstyp die benutzerdefinierte Angabe der Auflistungselemente.When applied to a collection type, enables custom specification of the collection item elements. Dieses Attribut kann nur auf Typen angewendet werden, die vom DataContractSerializer als gültige, serialisierbare Auflistungen erkannt werden.This attribute can be applied only to types that are recognized by the DataContractSerializer as valid, serializable collections.

public ref class CollectionDataContractAttribute sealed : Attribute
[System.AttributeUsage(System.AttributeTargets.Class | System.AttributeTargets.Struct, AllowMultiple=false, Inherited=false)]
public sealed class CollectionDataContractAttribute : Attribute
type CollectionDataContractAttribute = class
    inherit Attribute
Public NotInheritable Class CollectionDataContractAttribute
Inherits Attribute
Vererbung
CollectionDataContractAttribute
Attribute

Beispiele

Im folgenden Beispiel wird der CollectionDataContractAttribute auf eine Klasse angewendet, die von der List<T>-Klasse erbt.The following example applies the CollectionDataContractAttribute to a class that inherits from the List<T> class. Der Code legt die Name-Eigenschaft und die ItemName-Eigenschaft auf benutzerdefinierte Werte fest.The code sets the Name and ItemName properties to custom values.

[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 Service Model Metadata Utility-Tool (Svcutil. exe) verwendet wird, um Code für den Client zu generieren, ähnelt der Code dem folgenden Beispiel.When the ServiceModel Metadata Utility Tool (Svcutil.exe) is used to generate code for the client, the code resembles the following example. Beachten Sie, dass sowohl der Name der Klasse als auch der ItemName geändert werden.Notice that the name of the class is changed, as well as the ItemName. Bei der Verwendung von Generics wird der Typparametername verwendet, um den resultierenden Typnamen zu erstellen.When using generics, the type parameter name is used to create the resulting type name.

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

Der CollectionDataContractAttribute soll die Interoperabilität bei der Arbeit mit Daten von nicht-WCF-Anbietern vereinfachen und die genaue Form der serialisierten Instanzen steuern.The CollectionDataContractAttribute is intended to ease interoperability when working with data from non-WCF providers and to control the exact shape of serialized instances. Deshalb können Sie mit der ItemName-Eigenschaft die Namen der sich wiederholenden Elemente in einer Auflistung kontrollieren.To this end, the ItemName property enables you to control the names of the repeating items inside a collection. 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.This is especially useful when the provider does not use the XML element type name as the array item name, for example, if a provider uses "String" as an element type name instead of the XSD type name "string".

Der CollectionDataContractAttribute ist auch für die Verwendung mit Wörterbuchtypen zur Behandlung verschlüsselter Auflistungen vorgesehen.The CollectionDataContractAttribute is also intended to be used with dictionary types to handle keyed collections. Wörterbuchtypen sind Klassen, die entweder den IDictionary oder die IDictionary<TKey,TValue>-Schnittstelle implementieren, z. B. Dictionary<TKey,TValue>.Dictionary types are classes that implement either the IDictionary or the IDictionary<TKey,TValue> interface, for example, the Dictionary<TKey,TValue>. Verwenden Sie die KeyName-Eigenschaft und die ValueName-Eigenschaft, um benutzerdefinierte Namen festzulegen, wenn Sie die Dictionary<TKey,TValue>-Klasse verwenden.Use the KeyName and ValueName properties to set custom names when using the Dictionary<TKey,TValue> class.

Weitere Informationen zum verwenden DataContractSerializervon finden Sie unter Verwenden von Daten Verträgen.For more information about using the DataContractSerializer, see Using Data Contracts.

Konstruktoren

CollectionDataContractAttribute()

Initialisiert eine neue Instanz der CollectionDataContractAttribute-Klasse.Initializes a new instance of the CollectionDataContractAttribute class.

Eigenschaften

IsItemNameSetExplicitly

Ruft ab, ob ItemName explizit festgelegt wurde.Gets whether ItemName has been explicitly set.

IsKeyNameSetExplicitly

Ruft ab, ob KeyName explizit festgelegt wurde.Gets whether KeyName has been explicitly set.

IsNameSetExplicitly

Ruft ab, ob Name explizit festgelegt wurde.Gets whether Name has been explicitly set.

IsNamespaceSetExplicitly

Ruft ab, ob Namespace explizit festgelegt wurde.Gets whether Namespace has been explicitly set.

IsReference

Ruft einen Wert ab oder legt einen Wert fest, der angibt, ob Objektverweisdaten beizubehalten sind.Gets or sets a value that indicates whether to preserve object reference data.

IsReferenceSetExplicitly

Ruft ab, ob der Verweis explizit festgelegt wurde.Gets whether reference has been explicitly set.

IsValueNameSetExplicitly

Ruft ab, ob ValueName explizit festgelegt wurde.Gets whether ValueName has been explicitly set.

ItemName

Ruft einen benutzerdefinierten Namen für ein Auflistungselement ab oder legt ihn fest.Gets or sets a custom name for a collection element.

KeyName

Ruft den benutzerdefinierten Namen für einen Wörterbuchschlüsselnamen ab oder legt ihn fest.Gets or sets the custom name for a dictionary key name.

Name

Ruft den Namen des Datenvertrags für den Auflistungstyp ab oder legt ihn fest.Gets or sets the data contract name for the collection type.

Namespace

Ruft den Namespace für den Datenvertrag ab oder legt ihn fest.Gets or sets the namespace for the data contract.

TypeId

Ruft bei Implementierung in einer abgeleiteten Klasse einen eindeutigen Bezeichner für dieses Attribute ab.When implemented in a derived class, gets a unique identifier for this Attribute.

(Geerbt von Attribute)
ValueName

Ruft den benutzerdefinierten Namen für einen Wörterbuchwertnamen ab oder legt ihn fest.Gets or sets the custom name for a dictionary value name.

Methoden

Equals(Object)

Gibt einen Wert zurück, der angibt, ob diese Instanz gleich einem angegebenen Objekt ist.Returns a value that indicates whether this instance is equal to a specified object.

(Geerbt von Attribute)
GetHashCode()

Gibt den Hashcode für diese Instanz zurück.Returns the hash code for this instance.

(Geerbt von Attribute)
GetType()

Ruft den Type der aktuellen Instanz ab.Gets the Type of the current instance.

(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.When overridden in a derived class, indicates whether the value of this instance is the default value for the derived class.

(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.When overridden in a derived class, returns a value that indicates whether this instance equals a specified object.

(Geerbt von Attribute)
MemberwiseClone()

Erstellt eine flache Kopie des aktuellen Object.Creates a shallow copy of the current Object.

(Geerbt von Object)
ToString()

Gibt eine Zeichenfolge zurück, die das aktuelle Objekt darstellt.Returns a string that represents the current object.

(Geerbt von Object)

Explizite Schnittstellenimplementierungen

_Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr)

Ordnet eine Reihe von Namen einer entsprechenden Reihe von Dispatchbezeichnern zu.Maps a set of names to a corresponding set of dispatch identifiers.

(Geerbt von Attribute)
_Attribute.GetTypeInfo(UInt32, UInt32, IntPtr)

Ruft die Typinformationen für ein Objekt ab, mit deren Hilfe die Typinformationen für eine Schnittstelle abgerufen werden können.Retrieves the type information for an object, which can be used to get the type information for an interface.

(Geerbt von Attribute)
_Attribute.GetTypeInfoCount(UInt32)

Ruft die Anzahl der Schnittstellen mit Typinformationen ab, die von einem Objekt bereitgestellt werden (0 oder 1).Retrieves the number of type information interfaces that an object provides (either 0 or 1).

(Geerbt von Attribute)
_Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr)

Stellt den Zugriff auf von einem Objekt verfügbar gemachte Eigenschaften und Methoden bereit.Provides access to properties and methods exposed by an object.

(Geerbt von Attribute)

Gilt für:

Siehe auch