EnumMemberAttribute.Value Property

Definition

Namespace:

System.Runtime.Serialization

Assembly:

System.Runtime.Serialization.Primitives.dll

Source:

EnumMemberAttribute.cs

Gets or sets the value associated with the enumeration member the attribute is applied to.

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

public string? Value { get; set; }

member this.Value : string with get, set

Public Property Value As String

Property Value

String

The value associated with the enumeration member.

Examples

The following code:

[DataContract]
public enum Shapes
{
    [EnumMember]
    Circle,
    [EnumMember]
    Square
}

results in the following XML when serialized with the DataContractSerializer:

<Shapes>Circle</Shapes>  

or

<Shapes>Square</Shapes>  

The following code, with the Value property set:

[DataContract]
public enum Shapes
{

    [EnumMember(Value="1")]
    Circle,
    [EnumMember(Value="2")]
    Square
}

 <DataContract> _
Public Enum Shapes
    <EnumMember(Value:="1")> Circle
    <EnumMember(Value:="2")> Square   
End Enum

results in the following XML:

<Shapes>1</Shapes>  

or

<Shapes>2</Shapes>  

Remarks

By default, the value of an enumeration is the name of the enumeration. When a value is specified, that value will appear in the XML document or stream.