CollectionDataContractAttribute Class
TOC
Collapse the table of content
Expand the table of content

CollectionDataContractAttribute Class

 

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.

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

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

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

NameDescription
System_CAPS_pubmethodCollectionDataContractAttribute()

Initializes a new instance of the CollectionDataContractAttribute class.

NameDescription
System_CAPS_pubpropertyIsItemNameSetExplicitly

Gets whether ItemName has been explicitly set.

System_CAPS_pubpropertyIsKeyNameSetExplicitly

Gets whether KeyName has been explicitly set.

System_CAPS_pubpropertyIsNameSetExplicitly

Gets whether Name has been explicitly set.

System_CAPS_pubpropertyIsNamespaceSetExplicitly

Gets whether Namespace has been explicitly set.

System_CAPS_pubpropertyIsReference

Gets or sets a value that indicates whether to preserve object reference data.

System_CAPS_pubpropertyIsReferenceSetExplicitly

Gets whether reference has been explicitly set.

System_CAPS_pubpropertyIsValueNameSetExplicitly

Gets whether ValueName has been explicitly set.

System_CAPS_pubpropertyItemName

Gets or sets a custom name for a collection element.

System_CAPS_pubpropertyKeyName

Gets or sets the custom name for a dictionary key name.

System_CAPS_pubpropertyName

Gets or sets the data contract name for the collection type.

System_CAPS_pubpropertyNamespace

Gets or sets the namespace for the data contract.

System_CAPS_pubpropertyTypeId

When implemented in a derived class, gets a unique identifier for this Attribute.(Inherited from Attribute.)

System_CAPS_pubpropertyValueName

Gets or sets the custom name for a dictionary value name.

NameDescription
System_CAPS_pubmethodEquals(Object)

This API supports the product infrastructure and is not intended to be used directly from your code. Returns a value that indicates whether this instance is equal to a specified object.(Inherited from Attribute.)

System_CAPS_pubmethodGetHashCode()

Returns the hash code for this instance.(Inherited from Attribute.)

System_CAPS_pubmethodGetType()

Gets the Type of the current instance.(Inherited from Object.)

System_CAPS_pubmethodIsDefaultAttribute()

When overridden in a derived class, indicates whether the value of this instance is the default value for the derived class.(Inherited from Attribute.)

System_CAPS_pubmethodMatch(Object)

When overridden in a derived class, returns a value that indicates whether this instance equals a specified object.(Inherited from Attribute.)

System_CAPS_pubmethodToString()

Returns a string that represents the current object.(Inherited from Object.)

NameDescription
System_CAPS_pubinterfaceSystem_CAPS_privmethod_Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr)

Maps a set of names to a corresponding set of dispatch identifiers.(Inherited from Attribute.)

System_CAPS_pubinterfaceSystem_CAPS_privmethod_Attribute.GetTypeInfo(UInt32, UInt32, IntPtr)

Retrieves the type information for an object, which can be used to get the type information for an interface.(Inherited from Attribute.)

System_CAPS_pubinterfaceSystem_CAPS_privmethod_Attribute.GetTypeInfoCount(UInt32)

Retrieves the number of type information interfaces that an object provides (either 0 or 1).(Inherited from Attribute.)

System_CAPS_pubinterfaceSystem_CAPS_privmethod_Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr)

Provides access to properties and methods exposed by an object.(Inherited from Attribute.)

The CollectionDataContractAttribute is intended to ease interoperability when working with data from non-WCF providers and to control the exact shape of serialized instances. To this end, the ItemName property enables you to control the names of the repeating items inside a collection. 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".

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(Of TKey, TValue) interface, for example, the Dictionary(Of TKey, TValue). Use the KeyName and ValueName properties to set custom names when using the Dictionary(Of TKey, TValue) class.

For more information about using the DataContractSerializer, see Using Data Contracts.

The following example applies the CollectionDataContractAttribute to a class that inherits from the List(Of T) class. The code sets the Name and ItemName properties to custom values.

<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

When the ServiceModel Metadata Utility Tool (Svcutil.exe) is used to generate code for the client, the code resembles the following example. Notice that the name of the class is changed, as well as the ItemName. 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
	Inherits System.Collections.Generic.List(Of Microsoft.Security.Samples.Book)
End Class

Universal Windows Platform
Available since 8
.NET Framework
Available since 3.0
Portable Class Library
Supported in: portable .NET platforms
Silverlight
Available since 2.0
Windows Phone Silverlight
Available since 7.0
Windows Phone
Available since 8.1

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

Return to top
Show:
© 2016 Microsoft