.NET Framework Class Library
EnumMemberAttribute Class

Specifies that the field is an enumeration member and should be serialized.

Inheritance Hierarchy
SystemObject
   SystemAttribute
    System.Runtime.SerializationEnumMemberAttribute

Namespace:   System.Runtime.Serialization
Assembly:  System.Runtime.Serialization (in System.Runtime.Serialization.dll)
Syntax
<[%$TOPIC/ms574806_en-us_VS_110_2_0_0_0_0%]([%$TOPIC/ms574806_en-us_VS_110_2_0_0_0_1%].Field, Inherited := False, AllowMultiple := False)> _
Public NotInheritable Class EnumMemberAttribute _
	Inherits [%$TOPIC/ms574806_en-us_VS_110_2_0_0_0_2%]
[[%$TOPIC/ms574806_en-us_VS_110_2_0_1_0_0%]([%$TOPIC/ms574806_en-us_VS_110_2_0_1_0_1%].Field, Inherited = false, AllowMultiple = false)]
public sealed class EnumMemberAttribute : [%$TOPIC/ms574806_en-us_VS_110_2_0_1_0_2%]
[[%$TOPIC/ms574806_en-us_VS_110_2_0_2_0_0%]([%$TOPIC/ms574806_en-us_VS_110_2_0_2_0_1%]::Field, Inherited = false, AllowMultiple = false)]
public ref class EnumMemberAttribute sealed : public [%$TOPIC/ms574806_en-us_VS_110_2_0_2_0_2%]
[<[%$TOPIC/ms574806_en-us_VS_110_2_0_3_0_0%]>]
[<[%$TOPIC/ms574806_en-us_VS_110_2_0_3_0_1%]([%$TOPIC/ms574806_en-us_VS_110_2_0_3_0_2%].Field, Inherited = false, AllowMultiple = false)>]
type EnumMemberAttribute =  
    class 
        inherit [%$TOPIC/ms574806_en-us_VS_110_2_0_3_0_3%] 
    end

The EnumMemberAttribute type exposes the following members.

Constructors
  NameDescription
Public method Supported by Portable Class Library Supported in .NET for Windows Store apps EnumMemberAttributeInitializes a new instance of the EnumMemberAttribute class.
Top
Properties
  NameDescription
Public property TypeIdWhen implemented in a derived class, gets a unique identifier for this Attribute. (Inherited from Attribute.)
Public property Supported by Portable Class Library Supported in .NET for Windows Store apps ValueGets or sets the value associated with the enumeration member the attribute is applied to.
Top
Methods
  NameDescription
Public method Supported by Portable Class Library Supported in .NET for Windows Store apps EqualsInfrastructure. Returns a value that indicates whether this instance is equal to a specified object. (Inherited from Attribute.)
Public method Supported by Portable Class Library Supported in .NET for Windows Store apps GetHashCodeReturns the hash code for this instance. (Inherited from Attribute.)
Public method Supported by Portable Class Library Supported in .NET for Windows Store apps GetTypeGets the Type of the current instance. (Inherited from Object.)
Public method IsDefaultAttributeWhen overridden in a derived class, indicates whether the value of this instance is the default value for the derived class. (Inherited from Attribute.)
Public method MatchWhen overridden in a derived class, returns a value that indicates whether this instance equals a specified object. (Inherited from Attribute.)
Public method Supported by Portable Class Library Supported in .NET for Windows Store apps ToStringReturns a string that represents the current object. (Inherited from Object.)
Top
Explicit Interface Implementations
  NameDescription
Explicit interface implemetation Private method _AttributeGetIDsOfNamesMaps a set of names to a corresponding set of dispatch identifiers. (Inherited from Attribute.)
Explicit interface implemetation Private method _AttributeGetTypeInfoRetrieves the type information for an object, which can be used to get the type information for an interface. (Inherited from Attribute.)
Explicit interface implemetation Private method _AttributeGetTypeInfoCountRetrieves the number of type information interfaces that an object provides (either 0 or 1). (Inherited from Attribute.)
Explicit interface implemetation Private method _AttributeInvokeProvides access to properties and methods exposed by an object. (Inherited from Attribute.)
Top
Remarks

The EnumMemberAttribute enables fine control of the names of the enumerations as they are serialized.

To use EnumMemberAttribute, create an enumeration and apply the DataContractAttribute attribute to the enumeration. Then apply the EnumMemberAttribute attribute to each member that needs to be in the serialization stream.

Examples

The following example shows EnumMemberAttribute applied to members of an enumeration.

<DataContract()>  _
Public Enum Position
    <EnumMember(Value:="Emp")> Employee
    <EnumMember(Value:="Mgr")> Manager
    <EnumMember(Value:="Ctr")> Contractor
    NotASerializableEnumeration

End Enum 

<DataContract()>  _
Public Class Person
    Implements IExtensibleDataObject

    Public Sub New(ByVal firstNameValue As String, _
       ByVal lastNameValue As String) 
        LastName = firstNameValue
        FirstName = lastNameValue

    End Sub  

    Private extensioDataValue As ExtensionDataObject 

    Public Property ExtensionData() As ExtensionDataObject _
       Implements IExtensibleDataObject.ExtensionData
        Get 
            Return extensioDataValue
        End Get 
        Set
            extensioDataValue = value
        End Set 
    End Property 

    <DataMember()>  _
    Friend FirstName As String

    <DataMember()>  _
    Friend LastName As String

    <DataMember()>  _
    Friend Description As Position

End Class  


NotInheritable Public Class Test

    Private Sub New() 

    End Sub 

    Shared Sub Main() 
        WriteObject("Enum.xml")
        Console.ReadLine()

    End Sub  


    Shared Sub WriteObject(ByVal path As String) 
        Console.WriteLine("Writing...")
        Dim p As New Person("Denise", "Smith")
        p.Description = Position.Manager

        Dim fs As New FileStream(path, FileMode.Create)

        Try 
            Dim ser As New DataContractSerializer(GetType(Person))
            ser.WriteObject(fs, p)
            Console.WriteLine("Done")
        Catch exc As SerializationException
            Console.WriteLine(exc.Message)
            Console.WriteLine(exc.StackTrace)
        Finally
            fs.Close()
        End Try 

    End Sub  
End Class
[DataContract]
public enum Position
{
    [EnumMember(Value = "Emp")]
    Employee,
    [EnumMember(Value = "Mgr")]
    Manager,
    [EnumMember(Value = "Ctr")]
    Contractor,
    NotASerializableEnumeration
}

[DataContract]
public class Person : IExtensibleDataObject
{
    public Person(string firstNameValue, string lastNameValue)
    {
        LastName = firstNameValue;
        FirstName = lastNameValue;
    }

    private ExtensionDataObject extensioDataValue;
    public ExtensionDataObject ExtensionData
    {
        get { return extensioDataValue; }
        set { extensioDataValue = value; }
    }

    [DataMember]
    internal string FirstName;
    [DataMember]
    internal string LastName;
    [DataMember]
    internal Position Description;
}

public sealed class Test
{
    private Test() { }
    static void Main()
    {

        try
        {

            Test t = new Test();
            t.Serialize("Enum.xml");
            Console.WriteLine("Done");
            Console.ReadLine();
        }
        catch (SerializationException  exc)
        {
            Console.WriteLine(exc.Message);
            Console.ReadLine();

        }

    }



    private void Serialize(string path)
    {
        Console.WriteLine("Serializing...");
        Person p = new Person("Denise", "Smith");
        p.Description = Position.Manager;

        FileStream fs = new FileStream(path, FileMode.Create);

        try
        {
            DataContractSerializer ser =
                new DataContractSerializer(typeof(Person));
            ser.WriteObject(fs, p);
            Console.WriteLine("Done");
        }
        catch (SerializationException exc)
        {
            Console.WriteLine(exc.Message);
            Console.WriteLine(exc.StackTrace);
        }
        finally
        {
            fs.Close();
        }
    }
}
Version Information

.NET Framework

Supported in: 4.5.2, 4.5.1, 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

.NET for Windows Phone apps

Supported in: Windows Phone 8.1, Windows Phone 8, Silverlight 8.1
Platforms

Windows Phone 8.1, Windows Phone 8, Windows 8.1, Windows Server 2012 R2, 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.

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.