EnumMemberAttribute Class

Definition

public ref class EnumMemberAttribute sealed : Attribute

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

[<System.AttributeUsage(System.AttributeTargets.Field, AllowMultiple=false, Inherited=false)>]
type EnumMemberAttribute = class
 inherit Attribute

Public NotInheritable Class EnumMemberAttribute
Inherits Attribute

Inheritance

Object

Attribute

EnumMemberAttribute

Attributes

AttributeUsageAttribute

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
}

[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();
 }
 }
}

<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

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.

See also

• DataContractAttribute