Partager via

XmlEnumAttribute Classe

Définition

Espace de noms:
System.Xml.Serialization
Assemblys:
System.Xml.dll, System.Xml.XmlSerializer.dll
Assemblys:
netstandard.dll, System.Xml.ReaderWriter.dll
Assembly:
System.Xml.XmlSerializer.dll
Assembly:
System.Xml.ReaderWriter.dll
Assembly:
System.Xml.dll
Assembly:
netstandard.dll
Source:
XmlEnumAttribute.cs
Source:
XmlEnumAttribute.cs
Source:
XmlEnumAttribute.cs
Source:
XmlEnumAttribute.cs
Source:
XmlEnumAttribute.cs

Contrôle la façon dont le XmlSerializer sérialise un membre d’énumération.

public ref class XmlEnumAttribute : Attribute
[System.AttributeUsage(System.AttributeTargets.Field)]
public class XmlEnumAttribute : Attribute
[<System.AttributeUsage(System.AttributeTargets.Field)>]
type XmlEnumAttribute = class
    inherit Attribute
Public Class XmlEnumAttribute
Inherits Attribute
Héritage
Object
Attribute
XmlEnumAttribute
Attributs
AttributeUsageAttribute

Exemples

L’exemple suivant applique les XmlEnumAttribute membres d’une énumération. Lorsque les XmlSerializer données XML générées pour cette énumération sont générées, les données sont conformes aux valeurs des Name propriétés.

public enum EmployeeStatus
{
   [XmlEnum(Name = "Single")]
   One,
   [XmlEnum(Name = "Double")]
   Two,
   [XmlEnum(Name = "Triple")]
   Three
}

Public Enum EmployeeStatus
   <XmlEnum("Single")> One = 1
   <XmlEnum("Double")> Two = 2
   <XmlEnum("Triple")> Three = 3
End Enum

Note

Vous pouvez utiliser le mot XmlEnum dans votre code au lieu du plus long XmlEnumAttribute.

Remarques

Appartient XmlEnumAttribute à une famille d’attributs qui contrôle la façon dont le XmlSerializer sérialise ou désérialise un objet. Pour obtenir la liste complète des attributs similaires, consultez Attributs qui contrôlent la sérialisation XML.

Utilisez l’énumération XmlEnumAttribute pour modifier l’énumération XmlSerializer générée ou reconnaît (lorsqu’elle sérialise ou désérialise une classe, respectivement). Par exemple, si une énumération contient un membre nommé One, mais que vous préférez que la sortie XML soit nommée Single, appliquez XmlEnumAttribute le membre d’énumération et définissez la Name propriété sur « Single ».

Vous pouvez remplacer la Name valeur de propriété d’un XmlEnumAttribute en créant une instance de la XmlEnumAttribute classe et en l’affectant à la XmlEnum propriété d’un XmlAttributes objet. Pour plus d’informations, consultez la XmlAttributeOverrides classe.

Note

Vous pouvez utiliser le mot XmlEnum dans votre code au lieu du plus long XmlEnumAttribute.

Constructeurs

Nom Description
XmlEnumAttribute()

Initialise une nouvelle instance de la classe XmlEnumAttribute.
XmlEnumAttribute(String)

Initialise une nouvelle instance de la XmlEnumAttribute classe et spécifie la valeur XML que le XmlSerializer générateur ou reconnaît (lorsqu’il sérialise ou désérialise l’énumération, respectivement).

Propriétés

Nom Description
Name

Obtient ou définit la valeur générée dans une instance de document XML lorsque la XmlSerializer sérialise une énumération ou la valeur reconnue lorsqu’elle désérialise le membre d’énumération.
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)

Implémentations d’interfaces explicites

Nom Description
_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 d’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 méthodes exposées par un objet.

(Hérité de Attribute)

S’applique à

Voir aussi