CollectionDataContractAttribute Class

July 28, 2014

When applied to a collection type, enables custom specification of the collection item elements. This attribute can be applied only to types that are recognized by the DataContractSerializer as valid, serializable collections.

System.Object
  System.Attribute
    System.Runtime.Serialization.CollectionDataContractAttribute

Namespace:  System.Runtime.Serialization
Assembly:  System.Runtime.Serialization (in System.Runtime.Serialization.dll)

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

The CollectionDataContractAttribute type exposes the following members.

  NameDescription
Public methodCollectionDataContractAttributeInitializes a new instance of the CollectionDataContractAttribute class.
Top

  NameDescription
Public propertyIsReferenceGets or sets a value that indicates whether to preserve object reference data.
Public propertyItemNameGets or sets a custom name for a collection element.
Public propertyKeyNameGets or sets the custom name for a dictionary key name.
Public propertyNameGets or sets the data contract name for the collection type.
Public propertyNamespaceGets or sets the namespace for the data contract.
Public propertyValueNameGets or sets the custom name for a dictionary value name.
Top

  NameDescription
Public methodEqualsInfrastructure. Returns a value that indicates whether this instance is equal to a specified object. (Inherited from Attribute.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetHashCodeReturns the hash code for this instance. (Inherited from Attribute.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodMatchWhen overridden in a derived class, returns a value that indicates whether this instance equals a specified object. (Inherited from Attribute.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Top

The CollectionDataContractAttribute is intended to ease interoperability when working with data from non-Windows Communication Foundation (WCF) services and to control the exact shape of serialized instances. To achieve this, the ItemName property enables you to control the names of the repeating items inside a collection.

The CollectionDataContractAttribute is also intended to be used with dictionary types to handle keyed collections. Dictionary types are classes that implement either the IDictionary or the IDictionary<TKey, TValue> interface, for example, the Dictionary<TKey, TValue>. Use the KeyName and ValueName properties to set custom names when using the Dictionary<TKey, TValue> class.

Windows Phone OS

Supported in: 8.1, 8.0, 7.1, 7.0

Windows Phone

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Show:
© 2014 Microsoft