XmlEnumAttribute-Klasse

Artikel
08/20/2007

Steuert die Art, in der XmlSerializer einen Enumerationsmember serialisiert.

Namespace: System.Xml.Serialization
Assembly: System.Xml (in system.xml.dll)

Syntax

'Declaration
<AttributeUsageAttribute(AttributeTargets.Field)> _
Public Class XmlEnumAttribute
    Inherits Attribute
'Usage
Dim instance As XmlEnumAttribute

[AttributeUsageAttribute(AttributeTargets.Field)] 
public class XmlEnumAttribute : Attribute

[AttributeUsageAttribute(AttributeTargets::Field)] 
public ref class XmlEnumAttribute : public Attribute

/** @attribute AttributeUsageAttribute(AttributeTargets.Field) */ 
public class XmlEnumAttribute extends Attribute

AttributeUsageAttribute(AttributeTargets.Field) 
public class XmlEnumAttribute extends Attribute

Hinweise

XmlEnumAttribute gehört zu einer Familie von Attributen, die das Serialisieren bzw. Deserialisieren eines Objekts durch XmlSerializer steuern. Eine vollständige Liste ähnlicher Attribute finden Sie unter Attribute für die Steuerung der XML-Serialisierung.

Verwenden Sie XmlEnumAttribute, um die von XmlSerializer beim Serialisieren einer Klasse generierte bzw. beim Deserialisieren erkannte Enumeration zu ändern. Wenn eine Enumeration z. B. den Member One enthält, Sie aber die XML-Ausgabe Single bevorzugen, weisen Sie dem Enumerationsmember das XmlEnumAttribute zu, und legen Sie dessen Name-Eigenschaft auf "Single" fest.

Sie können den Name-Eigenschaftenwert von XmlEnumAttribute überschreiben, indem Sie eine Instanz der XmlEnumAttribute-Klasse erstellen und diese der XmlEnum-Eigenschaft eines XmlAttributes-Objekts zuweisen. Weitere Informationen finden Sie unter der XmlAttributeOverrides-Klasse.

Hinweis

Sie können das Wort XmlEnum anstelle des längeren XmlEnumAttribute im Code verwenden.

Beispiel

Im folgenden Beispiel wird XmlEnumAttribute auf die Member einer Enumeration angewendet. Wenn XmlSerializer XML-Daten für diese Enumeration generiert, entsprechen diese Daten dem Wert der jeweiligen Name-Eigenschaft.

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

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

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

public class EmployeeStatus
{
    /** @attribute XmlEnum(Name = "Single")
     */
    public static int one;
    /** @attribute XmlEnum(Name = "Double")
     */
    public static int two;
    /** @attribute XmlEnum(Name = "Triple")
     */
    public static int three;
} //EmployeeStatus

Hinweis

Sie können das Wort XmlEnum anstelle des längeren XmlEnumAttribute im Code verwenden.

Vererbungshierarchie

System.Object
System.Attribute
System.Xml.Serialization.XmlEnumAttribute

Threadsicherheit

Alle öffentlichen statischen (Shared in Visual Basic) Member dieses Typs sind threadsicher. Bei Instanzmembern ist die Threadsicherheit nicht gewährleistet.

Plattformen

Windows 98, Windows 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile für Pocket PC, Windows Mobile für Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

.NET Framework unterstützt nicht alle Versionen sämtlicher Plattformen. Eine Liste der unterstützten Versionen finden Sie unter Systemanforderungen.

Versionsinformationen

.NET Framework

Unterstützt in: 2.0, 1.1, 1.0

.NET Compact Framework

Unterstützt in: 2.0, 1.0

Siehe auch

Referenz

XmlEnumAttribute-Member
System.Xml.Serialization-Namespace
Serialize
Deserialize
XmlSerializer
XmlAttributes.XmlEnum-Eigenschaft
XmlAttributeOverrides-Klasse
XmlAttributes-Klasse
XmlAttributes-Klasse

Weitere Ressourcen

Einführung in die XML-Serialisierung
Gewusst wie: Angeben eines alternativen Elementnamens für einen XML-Stream
Steuern der XML-Serialisierung mit Attributen
Beispiele für die XML-Serialisierung
XML Schema Definition-Tool (Xsd.exe)

Freigeben über