CollectionDataContractAttribute Clase

Definición

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

Herencia

Object

Attribute

CollectionDataContractAttribute

Atributos

AttributeUsageAttribute

Ejemplos

El ejemplo siguiente aplica CollectionDataContractAttribute a una clase que se hereda de la clase List<T>. El código establece las propiedades Name y ItemName en 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

Cuando se usa la Herramienta de utilidad de metadatos de ServiceModel (Svcutil.exe) para generar código para el cliente, el código se parece al ejemplo siguiente. Observe que se cambia el nombre de la clase, así como ItemName. Al usar genéricos, se usa el nombre del parámetro de tipo para crear el nombre 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

Comentarios

está CollectionDataContractAttribute pensado para facilitar la interoperabilidad cuando se trabaja con datos de proveedores que no son WCF y para controlar la forma exacta de las instancias serializadas. Con este objetivo, la propiedad ItemName le permite controlar los nombres de los elementos de repetición dentro de una colección. Esto es especialmente útil cuando el proveedor no usa el nombre del tipo de elemento XML como nombre de elemento de la matriz; por ejemplo, si un proveedor usa "Cadena" como nombre del tipo de elemento en lugar del nombre de tipo XSD "cadena".

CollectionDataContractAttribute también está diseñado para usarse con tipos de diccionario para manipular colecciones codificadas en clave. Los tipos de diccionario son clases que implementan la interfaz IDictionary o IDictionary<TKey,TValue>, por ejemplo, Dictionary<TKey,TValue>. Use las propiedades KeyName y ValueName para establecer los nombres personalizados al usar la clase Dictionary<TKey,TValue>.

Para obtener más información sobre el uso de DataContractSerializer, vea Using Data Contracts( Uso de contratos de datos).

Constructores

Propiedades

Métodos

Implementaciones de interfaz explícitas

Se aplica a

Consulte también

• DataContractSerializer