Exportar (0) Imprimir
Expandir todo

XmlIgnoreAttribute (Clase)

Actualización: noviembre 2007

Instruye al método Serialize de XmlSerializer para que no serialice el valor de campo público o propiedad pública de lectura/escritura.

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

[AttributeUsageAttribute(AttributeTargets.Property|AttributeTargets.Field|AttributeTargets.Parameter|AttributeTargets.ReturnValue)]
public class XmlIgnoreAttribute : Attribute
/** @attribute AttributeUsageAttribute(AttributeTargets.Property|AttributeTargets.Field|AttributeTargets.Parameter|AttributeTargets.ReturnValue) */
public class XmlIgnoreAttribute extends Attribute
public class XmlIgnoreAttribute extends Attribute

XmlIgnoreAttribute pertenece a una familia de atributos que controla la forma en la que XmlSerializer serializa o deserializa un objeto. Si se aplica XmlIgnoreAttribute a cualquier miembro de una clase, XmlSerializer omitirá el miembro al serializar o deserializar una instancia de la clase. Para obtener una lista completa de atributos similares, vea Atributos que controlan la serialización XML.

Se puede reemplazar el comportamiento ocasionado por XmlIgnoreAttribute creando un objeto XmlAttributes y estableciendo su propiedad XmlIgnore en false. Hay que aplicar Add al objeto XmlAttributes para agregarlo a una instancia de la clase XmlAttributeOverrides. Por último, debe utilizar el objeto XmlAttributeOverrides para construir una instancia de la clase XmlSerializer antes de llamar a los métodos Serialize o Deserialize.

Herramienta Definición de esquemas XML (Xsd.exe) a veces genera XmlIgnoreAttribute al crear clases a partir de un archivo de esquema (.xsd). Se produce este comportamiento cuando, a diferencia de los tipos de datos XML, los tipos de valores no se pueden establecer en null. Por ello, la herramienta crea dos campos al detectar un tipo XML que se asigna a un tipo de valor; uno que contiene el valor y otro, como campo especial que adopta la forma de fieldnameSpecified, donde fieldname se reemplaza por el nombre del campo o la propiedad. Sin embargo, observe que este campo especial se genera sólo cuando el esquema especifica que no es necesario que se produzca un número mínimo de apariciones del elemento (minOccurs = "0") y que no tiene un valor predeterminado. XmlSerializer establece y comprueba este campo especial para determinar si se ha establecido un valor para el campo o la propiedad. Como el campo especial no debe serializarse, la herramienta le aplica XmlIgnoreAttribute.

Para obtener más información acerca del uso de atributos, vea Extender metadatos mediante atributos.

8x0dc01z.alert_note(es-es,VS.90).gifNota:

En el código, se puede utilizar la palabra XmlIgnore en lugar de XmlIgnoreAttribute, que es más largo.

En el siguiente ejemplo se muestra una clase denominada Group que contiene un campo denominado Comment. En el ejemplo, se asigna XmlIgnoreAttribute al campo, instruyendo a XmlSerializer para que omita el campo al serializar o deserializar una instancia de la clase.

public class Group
{
   // The XmlSerializer ignores this field.
   [XmlIgnore]
   public string Comment;

   // The XmlSerializer serializes this field.
   public string GroupName;
}



public class Group
{
    // The XmlSerializer ignores this field.
    /** @attribute XmlIgnore()
     */
    public String comment;
    // The XmlSerializer serializes this field.
    public String groupName;
} //Group


System.Object
  System.Attribute
    System.Xml.Serialization.XmlIgnoreAttribute

Todos los miembros static (Shared en Visual Basic) públicos de este tipo son seguros para la ejecución de subprocesos. No se garantiza que los miembros de instancias sean seguros para la ejecución de subprocesos.

Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98, Windows CE, Windows Mobile para Smartphone, Windows Mobile para Pocket PC, Xbox 360

.NET Framework y .NET Compact Framework no admiten todas las versiones de cada plataforma. Para obtener una lista de las versiones compatibles, vea Requisitos de sistema de .NET Framework.

.NET Framework

Compatible con: 3.5, 3.0, 2.0, 1.1, 1.0

.NET Compact Framework

Compatible con: 3.5, 2.0, 1.0

XNA Framework

Compatible con: 2.0, 1.0

Adiciones de comunidad

AGREGAR
Mostrar:
© 2015 Microsoft