XmlIgnoreAttribute Clase

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)]
public class XmlIgnoreAttribute : Attribute
type XmlIgnoreAttribute = class
    inherit Attribute
Public Class XmlIgnoreAttribute
Inherits Attribute
Herencia
XmlIgnoreAttribute
Atributos

Ejemplos

En el ejemplo siguiente se muestra una Groupclase denominada, que contiene un Commentcampo denominado.The following example shows a class named Group, which contains a field named Comment. XmlIgnoreAttribute En el ejemplo se asigna al campo, con lo XmlSerializer que se indica a que omita 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

Pertenece a una familia de atributos que controla XmlSerializer cómo serializa o deserializa un objeto. XmlIgnoreAttributeThe XmlIgnoreAttribute belongs to a family of attributes that controls how the XmlSerializer serializes or deserializes an object. Si aplica XmlIgnoreAttribute a cualquier miembro de una clase 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 atributos que controlan la serialización XML.For a complete list of similar attributes, see Attributes That Control XML Serialization.

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

La herramienta de definición de esquemas XML (XSD. exe) genera XmlIgnoreAttribute ocasionalmente al crear clases a partir 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 nullse pueden establecer en, pero todos los tipos de datos XML pueden ser.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: uno para contener el valor y otro campo especial que toma la forma fieldnameSpecifiedde, fieldname donde se reemplaza por el nombre del campo o la 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. No obstante, 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.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. XmlSerializer Establece y comprueba este campo especial para determinar si se ha establecido un valor para el campo o la propiedad.The XmlSerializer sets and checks this special field to determine whether a value has been set for the field or property. Dado XmlIgnoreAttribute que no se debe serializar el campo especial, la herramienta le aplica.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 más larga. XmlIgnoreAttributeYou can use the word XmlIgnore in your code instead of the longer XmlIgnoreAttribute.

Constructores

XmlIgnoreAttribute()

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

Propiedades

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.

(Heredado de Attribute)

Métodos

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.

(Heredado de Attribute)
GetHashCode()

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

(Heredado de Attribute)
GetType()

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

(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.When overridden in a derived class, indicates whether the value of this instance is the default value for the derived class.

(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.When overridden in a derived class, returns a value that indicates whether this instance equals a specified object.

(Heredado de Attribute)
MemberwiseClone()

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

(Heredado de Object)
ToString()

Devuelve un valor de tipo string que representa el objeto actual.Returns a string that represents the current object.

(Heredado de Object)

Implementaciones de interfaz explícitas

_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.

(Heredado de Attribute)
_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.

(Heredado de Attribute)
_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).

(Heredado de Attribute)
_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.

(Heredado de Attribute)

Se aplica a

Consulte también: