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