XmlEnumAttribute Klass

Definition

Namnområde:

System.Xml.Serialization

Sammansättningar:

netstandard.dll, System.Xml.ReaderWriter.dll

Källa:

XmlEnumAttribute.cs

Styr hur XmlSerializer serialiserar en uppräkningsmedlem.

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

Arv

Object

Attribute

XmlEnumAttribute

Attribut

AttributeUsageAttribute

Exempel

Följande exempel gäller XmlEnumAttribute för medlemmarna i en uppräkning. XmlSerializer När genererar XML-data för den här uppräkningen överensstämmer data med egenskapernas Name värden.

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

Du kan använda ordet XmlEnum i koden i stället för längre XmlEnumAttribute.

Kommentarer

XmlEnumAttribute Tillhör en familj av attribut som styr hur XmlSerializer serialiserar eller deserialiserar ett objekt. En fullständig lista över liknande attribut finns i Attribut som styr XML-serialisering.

XmlEnumAttribute Använd för att ändra den uppräkning som XmlSerializer genereras eller identifieras (när den serialiserar eller deserialiserar en klass). Om en uppräkning till exempel innehåller en medlem med namnet One, men du föredrar att XML-utdata heter Single, använder du XmlEnumAttribute för uppräkningsmedlemmen och anger Name egenskapen till "Enskild".

Du kan åsidosätta egenskapsvärdet Name för en XmlEnumAttribute genom att skapa en instans av XmlEnumAttribute klassen och tilldela den XmlEnum till egenskapen för ett XmlAttributes objekt. Mer information finns i XmlAttributeOverrides klassen .

Note

Du kan använda ordet XmlEnum i koden i stället för längre XmlEnumAttribute.

Konstruktorer

Name	Description
XmlEnumAttribute()	Initierar en ny instans av XmlEnumAttribute klassen.
XmlEnumAttribute(String)	Initierar en ny instans av XmlEnumAttribute klassen och anger det XML-värde som XmlSerializer genereras eller identifieras (när den serialiserar eller deserialiserar uppräkningen).

Egenskaper

Name	Description
Name	Hämtar eller anger värdet som genereras i en XML-dokumentinstans när XmlSerializer serialiserar en uppräkning, eller värdet som identifieras när den deserialiserar uppräkningsmedlemmen.
TypeId	När den implementeras i en härledd klass hämtar du en unik identifierare för den här Attribute. (Ärvd från Attribute)

Metoder

Name	Description
Equals(Object)	Returnerar ett värde som anger om den här instansen är lika med ett angivet objekt. (Ärvd från Attribute)
GetHashCode()	Returnerar hash-koden för den här instansen. (Ärvd från Attribute)
GetType()	Hämtar den aktuella instansen Type . (Ärvd från Object)
IsDefaultAttribute()	När den åsidosättas i en härledd klass anger du om värdet för den här instansen är standardvärdet för den härledda klassen. (Ärvd från Attribute)
Match(Object)	När den åsidosätts i en härledd klass returneras ett värde som anger om den här instansen är lika med ett angivet objekt. (Ärvd från Attribute)
MemberwiseClone()	Skapar en ytlig kopia av den aktuella Object. (Ärvd från Object)
ToString()	Returnerar en sträng som representerar det aktuella objektet. (Ärvd från Object)

Se även

• Serialize(TextWriter, Object)
• Deserialize(Stream)
• XmlSerializer
• XmlEnum
• XmlAttributeOverrides
• XmlAttributes
• Introduktion till XML-serialisering
• Anvisningar: Ange ett alternativt elementnamn för en XML-dataström
• Kontrollera XML-serialisering med hjälp av attribut
• Exempel på XML-serialisering
• XML-schemadefinitionsverktyg (Xsd.exe)