XmlEnumAttribute Class

Definition

Namespace:

System.Xml.Serialization

Assembly:

System.Xml.ReaderWriter.dll

Source:

XmlEnumAttribute.cs

Controls how the XmlSerializer serializes an enumeration member.

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

Inheritance

Object

Attribute

XmlEnumAttribute

Attributes

AttributeUsageAttribute

Examples

The following example applies the XmlEnumAttribute to the members of an enumeration. When the XmlSerializer generates XML data for this enumeration, the data conforms to the values of the Name properties.

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

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

You can use the word XmlEnum in your code instead of the longer XmlEnumAttribute.

Remarks

The XmlEnumAttribute belongs to a family of attributes that controls how the XmlSerializer serializes or deserializes an object. For a complete list of similar attributes, see Attributes That Control XML Serialization.

Use the XmlEnumAttribute to change the enumeration that the XmlSerializer generates or recognizes (when it serializes or deserializes a class, respectively). For example, if an enumeration contains a member named One, but you prefer that the XML output be named Single, apply the XmlEnumAttribute to the enumeration member and set the Name property to "Single".

You can override the Name property value of an XmlEnumAttribute by creating an instance of the XmlEnumAttribute class and assigning it to the XmlEnum property of an XmlAttributes object. For details, see the XmlAttributeOverrides class.

Note

You can use the word XmlEnum in your code instead of the longer XmlEnumAttribute.

Constructors

XmlEnumAttribute()	Initializes a new instance of the XmlEnumAttribute class.
XmlEnumAttribute(String)	Initializes a new instance of the XmlEnumAttribute class, and specifies the XML value that the XmlSerializer generates or recognizes (when it serializes or deserializes the enumeration, respectively).

Properties

Name	Gets or sets the value generated in an XML-document instance when the XmlSerializer serializes an enumeration, or the value recognized when it deserializes the enumeration member.
TypeId	When implemented in a derived class, gets a unique identifier for this Attribute. (Inherited from Attribute)

Methods

Equals(Object)	Returns a value that indicates whether this instance is equal to a specified object. (Inherited from Attribute)
GetHashCode()	Returns the hash code for this instance. (Inherited from Attribute)
GetType()	Gets the Type of the current instance. (Inherited from Object)
IsDefaultAttribute()	When overridden in a derived class, indicates whether the value of this instance is the default value for the derived class. (Inherited from Attribute)
Match(Object)	When overridden in a derived class, returns a value that indicates whether this instance equals a specified object. (Inherited from Attribute)
MemberwiseClone()	Creates a shallow copy of the current Object. (Inherited from Object)
ToString()	Returns a string that represents the current object. (Inherited from Object)

See also

• Serialize(TextWriter, Object)
• Deserialize(Stream)
• XmlSerializer
• XmlEnum
• XmlAttributeOverrides
• XmlAttributes
• Introducing XML Serialization
• How to: Specify an Alternate Element Name for an XML Stream
• Controlling XML Serialization Using Attributes
• Examples of XML Serialization
• XML Schema Definition Tool (Xsd.exe)