This topic has not yet been rated - Rate this topic

EnumMemberAttribute.Value Property

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

Namespace:  System.Runtime.Serialization
Assembly:  System.Runtime.Serialization (in System.Runtime.Serialization.dll)
public string Value { get; set; }

Property Value

Type: System.String
The value associated with the enumeration member.

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.

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     
}

results in the following XML:

<Shapes>1</Shapes>

or

<Shapes>2</Shapes>

.NET Framework

Supported in: 4.5, 4, 3.5, 3.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Portable Class Library

Supported in: Portable Class Library

.NET for Windows Store apps

Supported in: Windows 8

Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Did you find this helpful?
(1500 characters remaining)
© 2013 Microsoft. All rights reserved.