XmlIgnoreAttribute Classe

Référence

Définition

Espace de noms:: System.Xml.Serialization

Assembly:: System.Xml.XmlSerializer.dll

Assembly:: System.Xml.ReaderWriter.dll

Assembly:: System.Xml.dll

Assembly:: netstandard.dll

Important

Certaines informations portent sur la préversion du produit qui est susceptible d’être en grande partie modifiée avant sa publication. Microsoft exclut toute garantie, expresse ou implicite, concernant les informations fournies ici.

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.

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

Héritage: Object

Attribute
XmlIgnoreAttribute

Attributs: AttributeUsageAttribute

Exemples

L’exemple suivant montre une classe nommée Group, qui contient un champ nommé Comment. L’exemple affecte le champ, en demandant ainsi à l’ignorer XmlIgnoreAttribute XmlSerializer lors de la sérialisation ou de la désérialisation d’une instance de la classe.

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

Il XmlIgnoreAttribute appartient à une famille d’attributs qui contrôle la XmlSerializer sérialisation ou la désérialisation d’un objet. Si vous appliquez le XmlIgnoreAttribute membre d’une classe, il XmlSerializer ignore le membre lors de la sérialisation ou de la désérialisation d’une instance de la classe. Pour obtenir la liste complète des attributs similaires, consultez Attributs qui contrôlent la sérialisation XML.

Vous pouvez remplacer le comportement provoqué par la XmlIgnoreAttribute création d’un XmlAttributes objet et définir sa XmlIgnore propriété sur false. Vous devez Add l’objet XmlAttributes à une instance de la XmlAttributeOverrides classe. Enfin, vous devez utiliser l’objet XmlAttributeOverrides pour construire une instance de la XmlSerializer classe avant d’appeler les méthodes ou Deserialize les Serialize méthodes.

L’outil de définition de schéma XML (Xsd.exe) génère occasionnellement les XmlIgnoreAttribute classes lors de la création de classes à partir d’un fichier de schéma (.xsd). Ce comportement se produit car les types de valeur ne peuvent pas être définis sur null, mais tous les types de données XML peuvent être. 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 fieldnameSpecified, où le fieldname nom du champ ou de la propriété est remplacé. Notez toutefois que ce champ spécial est généré uniquement lorsque le schéma spécifie que l’élément n’a aucune occurrence minimale (minOccurs = « 0 ») et que l’élément n’a aucune valeur par défaut. Les XmlSerializer jeux et vérifient ce champ spécial pour déterminer si une valeur a été définie pour le champ ou la propriété. Étant donné que le champ spécial ne doit pas être sérialisé, l’outil l’applique XmlIgnoreAttribute .

Pour plus d’informations sur l’utilisation d’attributs, consultez Attributs.

Notes

Vous pouvez utiliser le mot XmlIgnore dans votre code plutôt que plus long XmlIgnoreAttribute.

Constructeurs

XmlIgnoreAttribute()

Initialise une nouvelle instance de la classe XmlIgnoreAttribute.

Propriétés

TypeId

Lors de l'implémentation dans une classe dérivée, obtient un identificateur unique pour l'objet Attribute.

(Hérité de Attribute)

Méthodes

Equals(Object)	Retourne une valeur qui indique si cette instance est égale à un objet spécifié. (Hérité de Attribute)
GetHashCode()	Retourne le code de hachage de cette instance. (Hérité de Attribute)
GetType()	Obtient le Type de l'instance actuelle. (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. (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é. (Hérité de Attribute)
MemberwiseClone()	Crée une copie superficielle du Object actuel. (Hérité de Object)
ToString()	Retourne une chaîne qui représente l'objet actuel. (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. (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. (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). (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. (Hérité de Attribute)

S’applique à