CollectionDataContractAttribute Класс

Определение

При применении к типу коллекции позволяет пользователю задавать элементы коллекции.When applied to a collection type, enables custom specification of the collection item elements. Этот атрибут может применяться только к типам, распознаваемым методом DataContractSerializer как допустимые сериализуемые коллекции.This attribute can be applied only to types that are recognized by the DataContractSerializer as valid, serializable collections.

public ref class CollectionDataContractAttribute sealed : Attribute
public sealed class CollectionDataContractAttribute : Attribute
[System.AttributeUsage(System.AttributeTargets.Class | System.AttributeTargets.Struct, AllowMultiple=false, Inherited=false)]
public sealed class CollectionDataContractAttribute : Attribute
type CollectionDataContractAttribute = class
    inherit Attribute
[<System.AttributeUsage(System.AttributeTargets.Class | System.AttributeTargets.Struct, AllowMultiple=false, Inherited=false)>]
type CollectionDataContractAttribute = class
    inherit Attribute
Public NotInheritable Class CollectionDataContractAttribute
Inherits Attribute
Наследование
CollectionDataContractAttribute
Атрибуты

Примеры

В следующем примере CollectionDataContractAttribute применяется к классу, наследующему от класса List<T>.The following example applies the CollectionDataContractAttribute to a class that inherits from the List<T> class. Свойствам Name и ItemName задаются пользовательские значения.The code sets the Name and ItemName properties to custom values.

[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) , код напоминает следующий пример.When the ServiceModel Metadata Utility Tool (Svcutil.exe) is used to generate code for the client, the code resembles the following example. Обратите внимание, что меняется и имя класса, и свойство ItemName.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 : 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, и для управления точной формой сериализованных экземпляров.The CollectionDataContractAttribute is intended to ease interoperability when working with data from non-WCF providers and to control the exact shape of serialized instances. Для этой цели свойство ItemName предоставляет возможность управлять именами повторяющихся экземпляров коллекции.To this end, the ItemName property enables you to control the names of the repeating items inside a collection. Это особенно полезно, когда поставщик не использует имя типа XML-элемента в качестве имени элемента массива; например, если поставщик использует в качестве имени типа элемента "String" вместо имени типа XSD "string".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".

CollectionDataContractAttribute также предназначен для использования с типами словаря для обработки коллекций с ключами.The CollectionDataContractAttribute is also intended to be used with dictionary types to handle keyed collections. Типы словаря — это классы, реализующие интерфейс IDictionary или интерфейс IDictionary<TKey,TValue>; например, Dictionary<TKey,TValue>.Dictionary types are classes that implement either the IDictionary or the IDictionary<TKey,TValue> interface, for example, the Dictionary<TKey,TValue>. Используйте свойства KeyName и ValueName, чтобы задать пользовательские имена при использовании класса Dictionary<TKey,TValue>.Use the KeyName and ValueName properties to set custom names when using the Dictionary<TKey,TValue> class.

Дополнительные сведения об использовании DataContractSerializer см. в разделе использование контрактов данных.For more information about using the DataContractSerializer, see Using Data Contracts.

Конструкторы

CollectionDataContractAttribute()

Инициализирует новый экземпляр класса CollectionDataContractAttribute.Initializes a new instance of the CollectionDataContractAttribute class.

Свойства

IsItemNameSetExplicitly

Получает значение, указывающее, был ли объект ItemName задан явно.Gets whether ItemName has been explicitly set.

IsKeyNameSetExplicitly

Получает значение, указывающее, был ли объект KeyName задан явно.Gets whether KeyName has been explicitly set.

IsNameSetExplicitly

Получает значение, указывающее, был ли объект Name задан явно.Gets whether Name has been explicitly set.

IsNamespaceSetExplicitly

Получает значение, указывающее, был ли объект Namespace задан явно.Gets whether Namespace has been explicitly set.

IsReference

Возвращает или задает значение, указывающее, следует ли сохранять данные ссылки на объект.Gets or sets a value that indicates whether to preserve object reference data.

IsReferenceSetExplicitly

Получает значение, указывающее, была ли ссылка задана явно.Gets whether reference has been explicitly set.

IsValueNameSetExplicitly

Получает значение, указывающее, был ли объект ValueName задан явно.Gets whether ValueName has been explicitly set.

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.

TypeId

В случае реализации в производном классе возвращает уникальный идентификатор для этого атрибута Attribute.When implemented in a derived class, gets a unique identifier for this Attribute.

(Унаследовано от Attribute)
ValueName

Возвращает или задает пользовательское имя для имени значения словаря.Gets or sets the custom name for a dictionary value name.

Методы

Equals(Object)

Возвращает значение, показывающее, равен ли экземпляр указанному объекту.Returns a value that indicates whether this instance is equal to a specified object.

(Унаследовано от Attribute)
GetHashCode()

Возвращает хэш-код данного экземпляра.Returns the hash code for this instance.

(Унаследовано от Attribute)
GetType()

Возвращает объект Type для текущего экземпляра.Gets the Type of the current instance.

(Унаследовано от Object)
IsDefaultAttribute()

При переопределении в производном классе указывает, является ли значение этого экземпляра значением по умолчанию для производного класса.When overridden in a derived class, indicates whether the value of this instance is the default value for the derived class.

(Унаследовано от Attribute)
Match(Object)

При переопределении в производном классе возвращает значение, указывающее, является ли этот экземпляр равным заданному объекту.When overridden in a derived class, returns a value that indicates whether this instance equals a specified object.

(Унаследовано от Attribute)
MemberwiseClone()

Создает неполную копию текущего объекта Object.Creates a shallow copy of the current Object.

(Унаследовано от Object)
ToString()

Возвращает строку, представляющую текущий объект.Returns a string that represents the current object.

(Унаследовано от Object)

Явные реализации интерфейса

_Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr)

Сопоставляет набор имен соответствующему набору идентификаторов диспетчеризации.Maps a set of names to a corresponding set of dispatch identifiers.

(Унаследовано от Attribute)
_Attribute.GetTypeInfo(UInt32, UInt32, IntPtr)

Возвращает сведения о типе объекта, которые можно использовать для получения сведений о типе интерфейса.Retrieves the type information for an object, which can be used to get the type information for an interface.

(Унаследовано от Attribute)
_Attribute.GetTypeInfoCount(UInt32)

Возвращает количество предоставляемых объектом интерфейсов для доступа к сведениям о типе (0 или 1).Retrieves the number of type information interfaces that an object provides (either 0 or 1).

(Унаследовано от Attribute)
_Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr)

Предоставляет доступ к открытым свойствам и методам объекта.Provides access to properties and methods exposed by an object.

(Унаследовано от Attribute)

Применяется к

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