Este artículo se tradujo automáticamente. Para ver el artículo en inglés, active la casilla Inglés. Además, puede mostrar el texto en inglés en una ventana emergente si mueve el puntero del mouse sobre el texto.
Traducción
Inglés

Clase CollectionDataContractAttribute

 

Publicado: octubre de 2016

Cuando se aplica a un tipo de colección, habilita la especificación personalizada de los elementos de elemento de colección. Este atributo sólo se puede aplicar a los tipos que son reconocidos por DataContractSerializer como colecciones válidas serializables.

Espacio de nombres:   System.Runtime.Serialization
Ensamblado:  System.Runtime.Serialization (en System.Runtime.Serialization.dll)

System.Object
  System.Attribute
    System.Runtime.Serialization.CollectionDataContractAttribute

[AttributeUsageAttribute(AttributeTargets.Class | AttributeTargets.Struct, 
	Inherited = false, AllowMultiple = false)]
public sealed class CollectionDataContractAttribute : Attribute

NombreDescripción
System_CAPS_pubmethodCollectionDataContractAttribute()

Inicializa una nueva instancia de la clase CollectionDataContractAttribute.

NombreDescripción
System_CAPS_pubpropertyIsItemNameSetExplicitly

Obtiene si ItemName se estableció explícitamente.

System_CAPS_pubpropertyIsKeyNameSetExplicitly

Obtiene si KeyName se estableció explícitamente.

System_CAPS_pubpropertyIsNameSetExplicitly

Obtiene si Name se estableció explícitamente.

System_CAPS_pubpropertyIsNamespaceSetExplicitly

Obtiene si Namespace se estableció explícitamente.

System_CAPS_pubpropertyIsReference

Obtiene o establece un valor que indica si conservar los datos de referencia al objeto.

System_CAPS_pubpropertyIsReferenceSetExplicitly

Obtiene si la referencia se estableció explícitamente.

System_CAPS_pubpropertyIsValueNameSetExplicitly

Obtiene si ValueName se estableció explícitamente.

System_CAPS_pubpropertyItemName

Obtiene o establece un nombre personalizado para un elemento de la colección.

System_CAPS_pubpropertyKeyName

Obtiene o establece el nombre personalizado para un nombre de clave del diccionario.

System_CAPS_pubpropertyName

Obtiene o establece el nombre del contrato de datos para el tipo de colección.

System_CAPS_pubpropertyNamespace

Obtiene o establece el espacio de nombres para el contrato de datos.

System_CAPS_pubpropertyTypeId

Cuando se implementa en una clase derivada, obtiene un identificador único para este Attribute.(Heredado de Attribute).

System_CAPS_pubpropertyValueName

Obtiene o establece el nombre personalizado para un nombre de valor del diccionario.

NombreDescripción
System_CAPS_pubmethodEquals(Object)

Esta API admite la infraestructura producto y no está diseñada para usarse directamente desde el código. Devuelve un valor que indica si esta instancia equivale al objeto especificado. (Heredado de Attribute).

System_CAPS_pubmethodGetHashCode()

Devuelve el código hash de esta instancia.(Heredado de Attribute).

System_CAPS_pubmethodGetType()

Obtiene el Type de la instancia actual.(Heredado de Object).

System_CAPS_pubmethodIsDefaultAttribute()

Si se reemplaza en una clase derivada, indica si el valor de esta instancia es el valor predeterminado de la clase derivada.(Heredado de Attribute).

System_CAPS_pubmethodMatch(Object)

Cuando se invalida en una clase derivada, devuelve un valor que indica si esta instancia es igual al objeto especificado. (Heredado de Attribute).

System_CAPS_pubmethodToString()

Devuelve una cadena que representa al objeto actual. (Heredado de Object).

NombreDescripción
System_CAPS_pubinterfaceSystem_CAPS_privmethod_Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr)

Asigna un conjunto de nombres a un conjunto correspondiente de identificadores de envío.(Heredado de Attribute).

System_CAPS_pubinterfaceSystem_CAPS_privmethod_Attribute.GetTypeInfo(UInt32, UInt32, IntPtr)

Obtiene la información del tipo de un objeto, que puede utilizarse para obtener la información del tipo de una interfaz. (Heredado de Attribute).

System_CAPS_pubinterfaceSystem_CAPS_privmethod_Attribute.GetTypeInfoCount(UInt32)

Recupera el número de interfaces de tipo de información que suministra un objeto (0 ó 1)

(Heredado de Attribute).

System_CAPS_pubinterfaceSystem_CAPS_privmethod_Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr)

Proporciona acceso a las propiedades y los métodos expuestos por un objeto.(Heredado de Attribute).

The T:System.Runtime.Serialization.CollectionDataContractAttribute is intended to ease interoperability when working with data from non-indigo2 providers and to control the exact shape of serialized instances. To this end, the P:System.Runtime.Serialization.CollectionDataContractAttribute.ItemName property enables you to control the names of the repeating items inside a collection. 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".

The T:System.Runtime.Serialization.CollectionDataContractAttribute is also intended to be used with dictionary types to handle keyed collections. Dictionary types are classes that implement either the T:System.Collections.IDictionary or the T:System.Collections.Generic.IDictionary`2 interface, for example, the T:System.Collections.Generic.Dictionary`2. Use the P:System.Runtime.Serialization.CollectionDataContractAttribute.KeyName and P:System.Runtime.Serialization.CollectionDataContractAttribute.ValueName properties to set custom names when using the T:System.Collections.Generic.Dictionary`2 class.

Para obtener más información sobre using the DataContractSerializer, see Utilización de contratos de datos.

The following example applies the T:System.Runtime.Serialization.CollectionDataContractAttribute to a class that inherits from the T:System.Collections.Generic.List`1 class. The code sets the P:System.Runtime.Serialization.CollectionDataContractAttribute.Name and P:System.Runtime.Serialization.CollectionDataContractAttribute.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);
        }
    }
}

When the Service Model Metadata Utility Tool (Svcutil.exe) is used to generate code for the client, the code resembles the following example. Notice that the name of the class is changed, as well as the P:System.Runtime.Serialization.CollectionDataContractAttribute.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>
{
}

Plataforma universal de Windows
Disponible desde 8
.NET Framework
Disponible desde 3.0
Biblioteca de clases portable
Se admite en: plataformas portátiles de .NET
Silverlight
Disponible desde 2.0
Windows Phone Silverlight
Disponible desde 7.0
Windows Phone
Disponible desde 8.1

Cualquier miembro ( Compartido en Visual Basic) estático público de este tipo es seguro para subprocesos. No se garantiza que los miembros de instancia sean seguros para subprocesos.

Volver al principio
Mostrar: