XmlEnumAttribute.Name Property

Definition

Namespace:

System.Xml.Serialization

Assembly:

System.Xml.ReaderWriter.dll

Source:

XmlEnumAttribute.cs

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.

public:
 property System::String ^ Name { System::String ^ get(); void set(System::String ^ value); };

public string? Name { get; set; }

member this.Name : string with get, set

Public Property Name As String

Property Value

String

The value generated in an XML-document instance when the XmlSerializer serializes the enumeration, or the value recognized when it is deserializes the enumeration member.

Examples

The following example applies the XmlEnumAttribute attribute to members of an enumeration. The generated XML data conforms to the values set for the Name property.

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

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

Public Enum EmployeeStatus
   <XmlEnumAttribute("Single")> One
   <XmlEnumAttribute("Double")> Two
   <XmlEnumAttribute("Triple")> Three
End Enum

Remarks

Specify the Name when you want the generated XML data to differ from the enumeration identifier.

Note

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

See also

• Serialize(TextWriter, Object)
• Deserialize(Stream)
• XmlSerializer