CollectionDataContractAttribute Classe

Definição

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

Herança

Object

Attribute

CollectionDataContractAttribute

Atributos

AttributeUsageAttribute

Exemplos

O exemplo a seguir aplica-se a CollectionDataContractAttribute uma classe que herda da List<T> classe. O código define as propriedades e ItemName as Name propriedades como valores personalizados.

[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

Quando a Ferramenta de Utilitário de Metadados do ServiceModel (Svcutil.exe) é usada para gerar código para o cliente, o código se assemelha ao exemplo a seguir. Observe que o nome da classe foi alterado, bem como o ItemName. Ao usar genéricos, o nome do parâmetro de tipo é usado para criar o nome do tipo resultante.

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

Comentários

O CollectionDataContractAttribute objetivo é facilitar a interoperabilidade ao trabalhar com dados de provedores não WCF e controlar a forma exata de instâncias serializadas. Para esse fim, a ItemName propriedade permite que você controle os nomes dos itens repetidos dentro de uma coleção. Isso é especialmente útil quando o provedor não usa o nome do tipo de elemento XML como o nome do item de matriz, por exemplo, se um provedor usa "String" como um nome de tipo de elemento em vez do nome do tipo XSD "string".

O CollectionDataContractAttribute também destina-se a ser usado com tipos de dicionário para lidar com coleções chaveadas. Os tipos de dicionário são classes que implementam a interface ou a IDictionaryIDictionary<TKey,TValue> interface, por exemplo, a Dictionary<TKey,TValue>. Use as KeyName propriedades e ValueName para definir nomes personalizados ao usar a Dictionary<TKey,TValue> classe.

Para obter mais informações sobre como usar os DataContractSerializercontratos de dados, consulte Como usar contratos de dados.

Confira também

• DataContractSerializer