XmlIgnoreAttribute Classe

Définition

Commande à la méthode Serialize(TextWriter, Object) de XmlSerializer de ne pas sérialiser la valeur du champ public ou de la propriété en lecture/écriture publique.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
Héritage
XmlIgnoreAttribute
Attributs

Exemples

L’exemple suivant montre une classe nommée Group, qui contient un champ nommé Comment.The following example shows a class named Group, which contains a field named Comment. L’exemple assigne la XmlIgnoreAttribute au champ, indiquant ainsi à l' XmlSerializer d’ignorer le champ lors de la sérialisation ou de la désérialisation d’une instance de la classe.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

Remarques

Le XmlIgnoreAttribute appartient à une famille d’attributs qui contrôle la façon dont le XmlSerializer sérialise ou désérialise un objet.The XmlIgnoreAttribute belongs to a family of attributes that controls how the XmlSerializer serializes or deserializes an object. Si vous appliquez l' XmlIgnoreAttribute à n’importe quel membre d’une classe, le XmlSerializer ignore le membre lors de la sérialisation ou de la désérialisation d’une instance de la classe.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. Pour obtenir la liste complète des attributs similaires, consultez attributs qui contrôlent la SÉRIALISATION XML.For a complete list of similar attributes, see Attributes That Control XML Serialization.

Vous pouvez substituer le comportement provoqué par le XmlIgnoreAttribute en créant un objet XmlAttributes et en affectant à sa propriété XmlIgnore la valeur false.You can override the behavior caused by the XmlIgnoreAttribute by creating an XmlAttributes object, and setting its XmlIgnore property to false. Vous devez Add l’objet XmlAttributes à une instance de la classe XmlAttributeOverrides.You must Add the XmlAttributes object to an instance of the XmlAttributeOverrides class. Enfin, vous devez utiliser l’objet XmlAttributeOverrides pour construire une instance de la classe XmlSerializer avant d’appeler les méthodes Serialize ou Deserialize.Lastly, you must use the XmlAttributeOverrides object to construct an instance of the XmlSerializer class before you call the Serialize or Deserialize methods.

L' outil XML Schema Definition (XSD. exe) génère occasionnellement l' XmlIgnoreAttribute lors de la création de classes à partir d’un fichier de schéma (. xsd).The XML Schema Definition Tool (Xsd.exe) occasionally generates the XmlIgnoreAttribute when creating classes from a schema file (.xsd). Ce comportement se produit car les types valeur ne peuvent pas être définis sur null, mais tous les types de données XML peuvent être.This behavior occurs because value types cannot be set to null, but all XML data types can be. Par conséquent, l’outil crée deux champs lorsqu’il rencontre un type XML qui correspond à un type valeur : un pour contenir la valeur et un autre champ spécial qui prend la forme d' fieldnameSpecified, où le fieldname est remplacé par le nom du champ ou de la propriété.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. Notez, toutefois, que ce champ spécial est généré uniquement lorsque le schéma spécifie que l’élément n’a pas d’occurrence minimale (minOccurs = "0") et que l’élément n’a pas de valeur par défaut.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. Le XmlSerializer définit et vérifie ce champ spécial pour déterminer si une valeur a été définie pour le champ ou la propriété.The XmlSerializer sets and checks this special field to determine whether a value has been set for the field or property. Étant donné que le champ spécial ne doit pas être sérialisé, l’outil applique la XmlIgnoreAttribute.Because the special field must not be serialized, the tool applies the XmlIgnoreAttribute to it.

Pour plus d’informations sur l’utilisation d’attributs, consultez attributs.For more information about using attributes, see Attributes.

Notes

Vous pouvez utiliser le mot XmlIgnore dans votre code au lieu du XmlIgnoreAttributeplus long.You can use the word XmlIgnore in your code instead of the longer XmlIgnoreAttribute.

Constructeurs

XmlIgnoreAttribute()

Initialise une nouvelle instance de la classe XmlIgnoreAttribute.Initializes a new instance of the XmlIgnoreAttribute class.

Propriétés

TypeId

Lors de l'implémentation dans une classe dérivée, obtient un identificateur unique pour l'objet Attribute.When implemented in a derived class, gets a unique identifier for this Attribute.

(Hérité de Attribute)

Méthodes

Equals(Object)

Retourne une valeur qui indique si cette instance est égale à un objet spécifié.Returns a value that indicates whether this instance is equal to a specified object.

(Hérité de Attribute)
GetHashCode()

Retourne le code de hachage de cette instance.Returns the hash code for this instance.

(Hérité de Attribute)
GetType()

Obtient le Type de l'instance actuelle.Gets the Type of the current instance.

(Hérité de Object)
IsDefaultAttribute()

En cas de substitution dans une classe dérivée, indique si la valeur de cette instance est la valeur par défaut pour la classe dérivée.When overridden in a derived class, indicates whether the value of this instance is the default value for the derived class.

(Hérité de Attribute)
Match(Object)

En cas de substitution dans une classe dérivée, retourne une valeur indiquant si cette instance équivaut à un objet spécifié.When overridden in a derived class, returns a value that indicates whether this instance equals a specified object.

(Hérité de Attribute)
MemberwiseClone()

Crée une copie superficielle de l'objet Object actuel.Creates a shallow copy of the current Object.

(Hérité de Object)
ToString()

Retourne une chaîne qui représente l'objet en cours.Returns a string that represents the current object.

(Hérité de Object)

Implémentations d’interfaces explicites

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

Mappe un jeu de noms avec un jeu correspondant d'identificateurs de dispatch.Maps a set of names to a corresponding set of dispatch identifiers.

(Hérité de Attribute)
_Attribute.GetTypeInfo(UInt32, UInt32, IntPtr)

Récupère les informations de type pour un objet, qui peuvent être utilisées pour obtenir les informations de type d'une interface.Retrieves the type information for an object, which can be used to get the type information for an interface.

(Hérité de Attribute)
_Attribute.GetTypeInfoCount(UInt32)

Récupère le nombre d'interfaces d'informations de type fourni par un objet (0 ou 1).Retrieves the number of type information interfaces that an object provides (either 0 or 1).

(Hérité de Attribute)
_Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr)

Fournit l'accès aux propriétés et aux méthodes exposées par un objet.Provides access to properties and methods exposed by an object.

(Hérité de Attribute)

S’applique à

Voir aussi