XmlIgnoreAttribute Clase

Definición

Espacio de nombres:

System.Xml.Serialization

Ensamblado:

System.Xml.ReaderWriter.dll

Source:

XmlIgnoreAttribute.cs

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

public ref class XmlIgnoreAttribute : Attribute

[System.AttributeUsage(System.AttributeTargets.Field | System.AttributeTargets.Parameter | System.AttributeTargets.Property | System.AttributeTargets.ReturnValue)]
public class XmlIgnoreAttribute : Attribute

[<System.AttributeUsage(System.AttributeTargets.Field | System.AttributeTargets.Parameter | System.AttributeTargets.Property | System.AttributeTargets.ReturnValue)>]
type XmlIgnoreAttribute = class
    inherit Attribute

Public Class XmlIgnoreAttribute
Inherits Attribute

Herencia

Object

Attribute

XmlIgnoreAttribute

Atributos

AttributeUsageAttribute

Ejemplos

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

public ref class Group
{
public:

   // The XmlSerializer ignores this field.

   [XmlIgnore]
   String^ Comment;

   // The XmlSerializer serializes this field.
   String^ GroupName;
};

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.
    <XmlIgnore()> Public Comment As String
    
    ' The XmlSerializer serializes this field.
    Public GroupName As String
End Class

Comentarios

XmlIgnoreAttribute pertenece a una familia de atributos que controla cómo serializa XmlSerializer o deserializa un objeto . Si aplica a XmlIgnoreAttribute cualquier miembro de una clase, XmlSerializer omite 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.

Puede invalidar el comportamiento causado por la XmlIgnoreAttribute creación de un XmlAttributes objeto y establecer su XmlIgnore propiedad en false. Add Debe ser el XmlAttributes objeto en una instancia de la XmlAttributeOverrides clase . Por último, debe usar el XmlAttributeOverrides objeto para construir una instancia de la XmlSerializer clase antes de llamar a los Serialize métodos o Deserialize .

La Herramienta de definición de esquemas XML (Xsd.exe) genera ocasionalmente al XmlIgnoreAttribute crear clases a partir de un archivo de esquema (.xsd). Este comportamiento se produce porque los tipos de valor no se pueden establecer nullen , pero todos los tipos de datos XML pueden ser. Por lo tanto, la herramienta crea dos campos cuando encuentra un tipo XML que se asigna a un tipo de valor: uno para contener el valor y otro campo especial que toma la forma de fieldnameSpecified, donde fieldname se reemplaza por el nombre del campo o propiedad. Sin embargo, tenga en cuenta que este campo especial solo se genera cuando el esquema especifica que el elemento no tiene ninguna repetición mínima (minOccurs = "0") y que el elemento no tiene ningún valor predeterminado. Establece XmlSerializer y comprueba este campo especial para determinar si se ha establecido un valor para el campo o la propiedad. Dado que el campo especial no debe serializarse, la herramienta se aplica XmlIgnoreAttribute a él.

Para obtener más información sobre el uso de atributos, vea Atributos.

Nota

Puede usar la palabra XmlIgnore en el código en lugar del más largo XmlIgnoreAttribute.

Constructores

XmlIgnoreAttribute()

Inicializa una nueva instancia de la clase XmlIgnoreAttribute.

Propiedades

TypeId

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

Métodos

Equals(Object)	Devuelve un valor que indica si esta instancia es igual que un objeto especificado. (Heredado de Attribute)
GetHashCode()	Devuelve el código hash de esta instancia. (Heredado de Attribute)
GetType()	Obtiene el Type de la instancia actual. (Heredado de Object)
IsDefaultAttribute()	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)
Match(Object)	Cuando se invalida en una clase derivada, devuelve un valor que indica si esta instancia es igual a un objeto especificado. (Heredado de Attribute)
MemberwiseClone()	Crea una copia superficial del Object actual. (Heredado de Object)
ToString()	Devuelve una cadena que representa el objeto actual. (Heredado de Object)

Consulte también

• XmlAttributeOverrides
• XmlAttributes
• XmlIgnore
• XmlSerializer
• Introducción a la serialización XML
• Cómo: Especificar un nombre de elemento alternativo para una secuencia XML
• Controlar la serialización XML mediante atributos
• Ejemplos de serialización XML
• Herramienta de definición de esquema XML (Xsd.exe)