CollectionDataContractAttribute Class

Microsoft Silverlight will reach end of support after October 2021. Learn more.

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.

Inheritance Hierarchy

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

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

Syntax

'Declaration
<AttributeUsageAttribute(AttributeTargets.Class Or AttributeTargets.Struct, Inherited := False,  _
    AllowMultiple := False)> _
Public NotInheritable Class CollectionDataContractAttribute _
    Inherits Attribute

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

The CollectionDataContractAttribute type exposes the following members.

Constructors

	Name	Description
	CollectionDataContractAttribute	Initializes a new instance of the CollectionDataContractAttribute class.

Top

Properties

	Name	Description
	IsReference	Gets or sets a value that indicates whether to preserve object reference data.
	ItemName	Gets or sets a custom name for a collection element.
	KeyName	Gets or sets the custom name for a dictionary key name.
	Name	Gets or sets the data contract name for the collection type.
	Namespace	Gets or sets the namespace for the data contract.
	ValueName	Gets or sets the custom name for a dictionary value name.

Top

Methods

	Name	Description
	Equals	Infrastructure. Returns a value that indicates whether this instance is equal to a specified object. (Inherited from Attribute.)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. (Inherited from Object.)
	GetHashCode	Returns the hash code for this instance. (Inherited from Attribute.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	Match	When overridden in a derived class, returns a value that indicates whether this instance equals a specified object. (Inherited from Attribute.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Top

Remarks

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.

Version Information

Silverlight

Supported in: 5, 4, 3

Silverlight for Windows Phone

Supported in: Windows Phone OS 7.1, Windows Phone OS 7.0

XNA Framework

Supported in: Windows Phone OS 7.0

Platforms

For a list of the operating systems and browsers that are supported by Silverlight, see Supported Operating Systems and Browsers.

Thread Safety

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

See Also

Reference

System.Runtime.Serialization Namespace

DataContractSerializer