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 seguinte aplica-se a CollectionDataContractAttribute uma classe que herda da List<T> classe. O código define as Name propriedades e ItemName para 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 Utilitária de Metadados do Modelo de Serviço (Svcutil.exe) é usada para gerar código para o cliente, o código assemelha-se ao seguinte exemplo. Note que o nome da classe foi alterado, assim como o ItemName. Ao usar genéricos, o nome do parâmetro de tipo é usado para criar o nome de 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

Observações

O CollectionDataContractAttribute objetivo é facilitar a interoperabilidade ao trabalhar com dados de fornecedores não WCF e controlar a forma exata das instâncias serializadas. Para tal, a ItemName propriedade permite-lhe controlar os nomes dos itens repetidos dentro de uma coleção. Isto é especialmente útil quando o fornecedor não utiliza o nome do tipo de elemento XML como nome do elemento do array, por exemplo, se um fornecedor usar "String" como nome do tipo de elemento em vez do nome do tipo XSD "string".

O dicionário CollectionDataContractAttribute também se destina a ser usado com tipos de dicionário para lidar com coleções de chaves. Os tipos de dicionário são classes que implementam ou ou IDictionary a IDictionary<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 mais informações sobre a utilização do DataContractSerializer, consulte Utilização de Contratos de Dados.

Ver também

• DataContractSerializer