XmlIgnoreAttribute XmlIgnoreAttribute XmlIgnoreAttribute XmlIgnoreAttribute Class

Definición

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.Instructs the Serialize(TextWriter, Object) method of the XmlSerializer not to serialize the public field or public read/write property value.

public ref class XmlIgnoreAttribute : Attribute
[System.AttributeUsage(System.AttributeTargets.Field | System.AttributeTargets.Parameter | System.AttributeTargets.Property | System.AttributeTargets.ReturnValue)]
[System.AttributeUsage(System.AttributeTargets.Property | System.AttributeTargets.Field | System.AttributeTargets.Parameter | System.AttributeTargets.ReturnValue)]
public class XmlIgnoreAttribute : Attribute
type XmlIgnoreAttribute = class
    inherit Attribute
Public Class XmlIgnoreAttribute
Inherits Attribute
Herencia
XmlIgnoreAttributeXmlIgnoreAttributeXmlIgnoreAttributeXmlIgnoreAttribute
Atributos

Ejemplos

El ejemplo siguiente muestra una clase denominada Group, que contiene un campo denominado Comment.The following example shows a class named Group, which contains a field named Comment. El ejemplo se asigna el XmlIgnoreAttribute al campo, con lo que se está indicando el XmlSerializer para pasar por alto el campo al serializar o deserializar una instancia de la clase.The example assigns the XmlIgnoreAttribute to the field, thereby instructing the XmlSerializer to ignore the field when serializing or deserializing an instance of the class.

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

El XmlIgnoreAttribute pertenece a una familia de atributos que controla cómo el XmlSerializer serializa o deserializa un objeto.The XmlIgnoreAttribute belongs to a family of attributes that controls how the XmlSerializer serializes or deserializes an object. Si aplica el XmlIgnoreAttribute a cualquier miembro de una clase, el XmlSerializer omite el miembro al serializar o deserializar una instancia de la clase.If you apply the XmlIgnoreAttribute to any member of a class, the XmlSerializer ignores the member when serializing or deserializing an instance of the class. Para obtener una lista completa de atributos similares, vea Attributes That Control XML Serialization.For a complete list of similar attributes, see Attributes That Control XML Serialization.

Puede invalidar el comportamiento ocasionado por la XmlIgnoreAttribute mediante la creación de un XmlAttributes objeto y estableciendo su XmlIgnore propiedad a false.You can override the behavior caused by the XmlIgnoreAttribute by creating an XmlAttributes object, and setting its XmlIgnore property to false. Debe Add el XmlAttributes objeto a una instancia de la XmlAttributeOverrides clase.You must Add the XmlAttributes object to an instance of the XmlAttributeOverrides class. Por último, debe usar el XmlAttributeOverrides objeto para construir una instancia de la XmlSerializer clase antes de llamar a la Serialize o Deserialize métodos.Lastly, you must use the XmlAttributeOverrides object to construct an instance of the XmlSerializer class before you call the Serialize or Deserialize methods.

El XML Schema Definition Tool (Xsd.exe) a veces genera el XmlIgnoreAttribute al crear clases de un archivo de esquema (.xsd).The XML Schema Definition Tool (Xsd.exe) occasionally generates the XmlIgnoreAttribute when creating classes from a schema file (.xsd). Este comportamiento se produce porque los tipos de valor no pueden establecerse en null, pero pueden ser todos los tipos de datos XML.This behavior occurs because value types cannot be set to null, but all XML data types can be. Por lo tanto, la herramienta crea dos campos cuando encuentra un tipo XML que se asigna a un tipo de valor: una para almacenar el valor y el otro campo especial que adopta la forma de fieldnameSpecified, donde el fieldname se sustituye por el nombre del campo o propiedad.Therefore, the tool creates two fields when it encounters an XML type that maps to a value type: one to hold the value and another special field that takes the form of fieldnameSpecified, where the fieldname is replaced by the name of the field or property. Sin embargo, tenga en cuenta que este campo especial se genera solo 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.Notice, however, that this special field is generated only when the schema specifies that the element has no minimum occurrence (minOccurs = "0") and that the element has no default value. El XmlSerializer establece y comprueba este campo especial para determinar si se ha establecido un valor para el campo o propiedad.The XmlSerializer sets and checks this special field to determine whether a value has been set for the field or property. Dado que no se debe serializar el campo especial, la herramienta aplica el XmlIgnoreAttribute a él.Because the special field must not be serialized, the tool applies the XmlIgnoreAttribute to it.

Para obtener más información sobre el uso de atributos, vea atributos.For more information about using attributes, see Attributes.

Nota

Puede usar la palabra XmlIgnore en el código en lugar de la forma más larga XmlIgnoreAttribute.You can use the word XmlIgnore in your code instead of the longer XmlIgnoreAttribute.

Constructores

XmlIgnoreAttribute() XmlIgnoreAttribute() XmlIgnoreAttribute() XmlIgnoreAttribute()

Inicializa una nueva instancia de la clase XmlIgnoreAttribute.Initializes a new instance of the XmlIgnoreAttribute class.

Métodos

Equals(Object) Equals(Object) Equals(Object) Equals(Object)

Devuelve un valor que indica si esta instancia es igual que un objeto especificado.Returns a value that indicates whether this instance is equal to a specified object.

(Inherited from Attribute)
GetHashCode() GetHashCode() GetHashCode() GetHashCode()

Devuelve el código hash de esta instancia.Returns the hash code for this instance.

(Inherited from Attribute)
GetType() GetType() GetType() GetType()

Obtiene el Type de la instancia actual.Gets the Type of the current instance.

(Inherited from Object)
IsDefaultAttribute() IsDefaultAttribute() IsDefaultAttribute() IsDefaultAttribute()

Si se reemplaza en una clase derivada, indica si el valor de esta instancia es el valor predeterminado de la clase derivada.When overridden in a derived class, indicates whether the value of this instance is the default value for the derived class.

(Inherited from Attribute)
Match(Object) Match(Object) Match(Object) Match(Object)

Cuando se invalida en una clase derivada, devuelve un valor que indica si esta instancia es igual a un objeto especificado.When overridden in a derived class, returns a value that indicates whether this instance equals a specified object.

(Inherited from Attribute)
MemberwiseClone() MemberwiseClone() MemberwiseClone() MemberwiseClone()

Crea una copia superficial del objeto Object actual.Creates a shallow copy of the current Object.

(Inherited from Object)
ToString() ToString() ToString() ToString()

Devuelve una cadena que representa el objeto actual.Returns a string that represents the current object.

(Inherited from Object)

Implementaciones de interfaz explícitas

_Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr) _Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr) _Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr) _Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr)

Asigna un conjunto de nombres a un conjunto correspondiente de identificadores de envío.Maps a set of names to a corresponding set of dispatch identifiers.

(Inherited from Attribute)
_Attribute.GetTypeInfo(UInt32, UInt32, IntPtr) _Attribute.GetTypeInfo(UInt32, UInt32, IntPtr) _Attribute.GetTypeInfo(UInt32, UInt32, IntPtr) _Attribute.GetTypeInfo(UInt32, UInt32, IntPtr)

Obtiene la información de tipos de un objeto, que puede utilizarse para obtener la información de tipos de una interfaz.Retrieves the type information for an object, which can be used to get the type information for an interface.

(Inherited from Attribute)
_Attribute.GetTypeInfoCount(UInt32) _Attribute.GetTypeInfoCount(UInt32) _Attribute.GetTypeInfoCount(UInt32) _Attribute.GetTypeInfoCount(UInt32)

Recupera el número de interfaces de información de tipo que proporciona un objeto (0 ó 1).Retrieves the number of type information interfaces that an object provides (either 0 or 1).

(Inherited from Attribute)
_Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr) _Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr) _Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr) _Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr)

Proporciona acceso a las propiedades y los métodos expuestos por un objeto.Provides access to properties and methods exposed by an object.

(Inherited from Attribute)

Propiedades

TypeId TypeId TypeId TypeId

Cuando se implementa en una clase derivada, obtiene un identificador único para este Attribute.When implemented in a derived class, gets a unique identifier for this Attribute.

(Inherited from Attribute)

Se aplica a

Consulte también: