XmlIgnoreAttribute Classe

Définition

Espace de noms:

System.Xml.Serialization

Assemblys:

netstandard.dll, System.Xml.ReaderWriter.dll

Source:

XmlIgnoreAttribute.cs

Indique à la méthode Serialize(TextWriter, Object) de l'XmlSerializer de ne pas sérialiser le champ public ou la valeur de 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 XmlIgnoreAttribute champ, demandant ainsi à XmlSerializer ignorer le champ lors de la sérialisation ou de la désérialisation d’une instance de la classe.

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

Appartient XmlIgnoreAttribute à une famille d’attributs qui contrôle la façon dont le XmlSerializer sérialise ou désérialise 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 classes lors de la XmlIgnoreAttribute création de classes à partir d’un fichier de schéma (.xsd). Ce comportement se produit parce que les types valeur ne peuvent pas être définis nullsur , 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 mappé à un type valeur : un pour contenir la valeur et un autre champ spécial qui prend la forme fieldnameSpecified, où le fieldname champ ou la propriété est remplacé par le nom du champ ou de la propriété. 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. 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.

Note

Vous pouvez utiliser le mot XmlIgnore dans votre code au lieu du plus long XmlIgnoreAttribute.

Constructeurs

Nom	Description
XmlIgnoreAttribute()	Initialise une nouvelle instance de la classe XmlIgnoreAttribute.

Propriétés

Nom	Description
TypeId	En cas d’implémentation dans une classe dérivée, obtient un identificateur unique pour cette Attribute. (Hérité de Attribute)

Méthodes

Nom	Description
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 pour cette instance. (Hérité de Attribute)
GetType()	Obtient la 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 de la classe dérivée. (Hérité de Attribute)
Match(Object)	En cas de substitution dans une classe dérivée, retourne une valeur qui indique si cette instance est égale à un objet spécifié. (Hérité de Attribute)
MemberwiseClone()	Crée une copie superficielle du Objectactuel. (Hérité de Object)
ToString()	Retourne une chaîne qui représente l’objet actuel. (Hérité de Object)

Voir aussi

• XmlAttributeOverrides
• XmlAttributes
• XmlIgnore
• XmlSerializer
• Présentation de la sérialisation XML
• Guide pratique pour spécifier un autre nom d’élément pour un flux XML
• Contrôle de la sérialisation XML à l’aide d’attributs
• Exemples de sérialisation XML
• Outil de définition de schéma XML (Xsd.exe)