EnumMemberAttribute Class

July 28, 2014

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

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

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

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

The EnumMemberAttribute type exposes the following members.

  NameDescription
Public methodEnumMemberAttributeInitializes a new instance of the EnumMemberAttribute class.
Top

  NameDescription
Public propertyValueGets or sets the value associated with the enumeration member the attribute is applied to.
Top

  NameDescription
Public methodEqualsInfrastructure. Returns a value that indicates whether this instance is equal to a specified object. (Inherited from Attribute.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetHashCodeReturns the hash code for this instance. (Inherited from Attribute.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodMatchWhen overridden in a derived class, returns a value that indicates whether this instance equals a specified object. (Inherited from Attribute.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Top

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.


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

    //This uses an event handler, not 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 = "http://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

    }


}


Windows Phone OS

Supported in: 8.1, 8.0, 7.1, 7.0

Windows Phone

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Show:
© 2014 Microsoft