EnumMemberAttribute Class

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

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

Inheritance Hierarchy

System.Object
  System.Attribute
    System.Runtime.Serialization.EnumMemberAttribute

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

Syntax

'Declaration
<AttributeUsageAttribute(AttributeTargets.Field, Inherited := False, AllowMultiple := False)> _
Public NotInheritable Class EnumMemberAttribute _
    Inherits Attribute

[AttributeUsageAttribute(AttributeTargets.Field, Inherited = false, AllowMultiple = false)]
public sealed class EnumMemberAttribute : Attribute

The EnumMemberAttribute type exposes the following members.

Constructors

	Name	Description
	EnumMemberAttribute	Initializes a new instance of the EnumMemberAttribute class.

Top

Properties

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

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 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 must be in the serialization stream.

Examples

    Partial Public Class Page
        Inherits UserControl
        Public Sub New()
            InitializeComponent()
        End Sub

        'This uses an event handler, not Silverlight data binding
        Private Sub OnClick(ByVal sender As Object, ByVal args As EventArgs)
            ' Initialize a serializer for a User type.
            Dim serializer As New DataContractJsonSerializer(GetType(User))

            Dim responseStream As System.IO.Stream = New FileStream("pathToFile", FileMode.Create)
            Dim user As User = CType(serializer.ReadObject(responseStream), User)

            ' Create a User object and serialize it.
            Dim json As String = WriteFromObject()

            ' Deserialize the data to a User object.
            Dim jsonString As String = "{'Name':'Bill', 'Age':53}"
            Dim deserializedUser As User = ReadToObject(jsonString)
        End Sub

        Public Shared Function WriteFromObject() As String
            ' Create User object.
            Dim user As New User("Bob", 42)

            ' Create a stream to serialize the object to.
            Dim ms As New MemoryStream()

            ' Create a serializer for objects of type User
            Dim ser As New DataContractJsonSerializer(GetType(User))

            ' Write from the User object to the stream
            ser.WriteObject(ms, user)
            Dim json() As Byte = ms.ToArray()
            ms.Close()
            Return Encoding.UTF8.GetString(json, 0, json.Length)

        End Function


        Public Shared Function ReadToObject(ByVal json As String) As User
            ' Create the User object to read the serialized user into to.
            Dim deserializedUser As New User()

            ' Pass the string into a stream
            Dim ms As New MemoryStream(Encoding.UTF8.GetBytes(json))

            ' Deserializer the stream to the user object and return it.
            Dim ser As New DataContractJsonSerializer(deserializedUser.GetType())

            ' Read the stream
            deserializedUser = TryCast(ser.ReadObject(ms), User)

            ms.Close()
            Return deserializedUser
        End Function



        ' Define the data contract.
        <DataContract(Name := "Customer", Namespace := "https://www.contoso.com")> _
        Public Class User
            Private privateName As String
            <DataMember(Name := "Last", EmitDefaultValue := True, IsRequired := True, Order := 2)> _
            Public Property Name() As String
                Get
                    Return privateName
                End Get
                Set(ByVal value As String)
                    privateName = value
                End Set
            End Property

            Private privateAge As Integer
            <DataMember(Order := 1)> _
            Public Property Age() As Integer
                Get
                    Return privateAge
                End Get
                Set(ByVal value As Integer)
                    privateAge = value
                End Set
            End Property

            <DataMember()> _
            Public Description As Position

            Public Sub New()
            End Sub

            Public Sub New(ByVal newName As String, ByVal newAge As Integer)
                Name = newName
                Age = newAge
            End Sub
        End Class

        <DataContract> _
        Public Enum Position
            <EnumMember(Value := "Emp")> _
            Employee

            <EnumMember(Value := "Mgr")> _
            Manager

            <EnumMember(Value := "Ctr")> _
            Contractor

        End Enum


    End Class

public partial class Page : UserControl
{
    public Page()
    {
        InitializeComponent();
    }

    //This uses an event handler, not Silverlight data binding
    void OnClick(object sender, EventArgs args)
    {
        // Initialize a serializer for a User type.
        DataContractJsonSerializer serializer = new DataContractJsonSerializer(typeof(User));

        System.IO.Stream responseStream = new FileStream("pathToFile", FileMode.Create);
        User user = (User)serializer.ReadObject(responseStream);

        // Create a User object and serialize it.
        string json = WriteFromObject();

        // Deserialize the data to a User object.
        string jsonString = "{'Name':'Bill', 'Age':53}";
        User deserializedUser = ReadToObject(jsonString);
    }

    public static string WriteFromObject()
    {
        // Create User object.
        User user = new User("Bob", 42);

        // Create a stream to serialize the object to.
        MemoryStream ms = new MemoryStream();

        // Create a serializer for objects of type User
        DataContractJsonSerializer ser = new DataContractJsonSerializer(typeof(User));

        // Write from the User object to the stream
        ser.WriteObject(ms, user);
        byte[] json = ms.ToArray();
        ms.Close();
        return Encoding.UTF8.GetString(json, 0, json.Length);

    }


    public static User ReadToObject(string json)
    {
        // Create the User object to read the serialized user into to.
        User deserializedUser = new User();

        // Pass the string into a stream
        MemoryStream ms = new MemoryStream(Encoding.UTF8.GetBytes(json));

        // Deserializer the stream to the user object and return it.
        DataContractJsonSerializer ser = new DataContractJsonSerializer(deserializedUser.GetType());

        // Read the stream
        deserializedUser = ser.ReadObject(ms) as User;

        ms.Close();
        return deserializedUser;
    }



    // Define the data contract.
    [DataContract(Name = "Customer", Namespace = "https://www.contoso.com")]
    public class User
    {
        [DataMember(Name = "Last", EmitDefaultValue = true, IsRequired = true, Order = 2)]
        public string Name { get; set; }

        [DataMember(Order = 1)]
        public int Age { get; set; }

        [DataMember()]
        public Position Description;

        public User() { }

        public User(string newName, int newAge)
        {
            Name = newName;
            Age = newAge;
        }
    }

    [DataContract]
    public enum Position
    {
        [EnumMember(Value = "Emp")]
        Employee,

        [EnumMember(Value = "Mgr")]
        Manager,

        [EnumMember(Value = "Ctr")]
        Contractor

    }


}

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: 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.

See Also

Reference

System.Runtime.Serialization Namespace

DataContractAttribute