Article
11/18/2011

XmlEnumAttribute Class

Microsoft Silverlight will reach end of support after October 2021. Learn more.

Controls how the XmlSerializer serializes an enumeration member.

Inheritance Hierarchy

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

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

Syntax

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

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

The XmlEnumAttribute type exposes the following members.

Constructors

	Name	Description
	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).

Top

Properties

	Name	Description
	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.

Top

Methods

	Name	Description
	Equals	Infrastructure. Returns a value that indicates whether this instance is equal to a specified object. (Inherited from Attribute.)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. (Inherited from Object.)
	GetHashCode	Returns the hash code for this instance. (Inherited from Attribute.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	Match	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.)

Top

Remarks

The XmlEnumAttribute belongs to a family of attributes that controls how the XmlSerializer serializes or deserializes an object.

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 more information, see

the XmlAttributeOverrides class.

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

Version Information

Silverlight

Supported in: 5, 4, 3

Silverlight for Windows Phone

Supported in: Windows Phone OS 7.1, Windows Phone OS 7.0

XNA Framework

Supported in: Xbox 360, Windows Phone OS 7.0

Platforms

For a list of the operating systems and browsers that are supported by Silverlight, see Supported Operating Systems and Browsers.

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Partager via