CollectionDataContractAttribute Класс

Определение

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

Наследование

Object

Attribute

CollectionDataContractAttribute

Атрибуты

AttributeUsageAttribute

Примеры

В следующем примере применяется CollectionDataContractAttribute класс, наследующий от List<T> класса. Код задает настраиваемые Name значения и ItemName свойства.

[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

Если средство служебной программы метаданных ServiceModel (Svcutil.exe) используется для создания кода для клиента, код похож на следующий пример. Обратите внимание, что имя класса изменено, а также ItemNameимя класса. При использовании универсальных шаблонов имя параметра типа используется для создания результирующего имени типа.

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

Комментарии

Он CollectionDataContractAttribute предназначен для упрощения взаимодействия при работе с данными из поставщиков, отличных от WCF, и для управления точной формой сериализованных экземпляров. В этом случае ItemName свойство позволяет управлять именами повторяющихся элементов в коллекции. Это особенно полезно, если поставщик не использует имя типа XML-элемента в качестве имени элемента массива, например, если поставщик использует "String" в качестве имени типа элемента вместо имени типа XSD "string".

Он CollectionDataContractAttribute также предназначен для использования с типами словарей для обработки ключей коллекций. Типы словарей — это классы, реализующие интерфейс IDictionary или IDictionary<TKey,TValue> интерфейс, Dictionary<TKey,TValue>например. KeyName ValueName Используйте свойства для задания пользовательских имен при использовании Dictionary<TKey,TValue> класса.

Дополнительные сведения об использовании DataContractSerializerсм. в разделе "Использование контрактов данных".

См. также раздел

• DataContractSerializer