Specifies that the field is an enumeration member and should be serialized.
Namespace:
System.Runtime.Serialization
Assembly:
System.Runtime.Serialization (in System.Runtime.Serialization.dll)
Visual Basic (Declaration)
<AttributeUsageAttribute(AttributeTargets.Field, Inherited := False, AllowMultiple := False)> _
Public NotInheritable Class EnumMemberAttribute _
Inherits Attribute
Dim instance As EnumMemberAttribute
[AttributeUsageAttribute(AttributeTargets.Field, Inherited = false, AllowMultiple = false)]
public sealed class EnumMemberAttribute : Attribute
[AttributeUsageAttribute(AttributeTargets::Field, Inherited = false, AllowMultiple = false)]
public ref class EnumMemberAttribute sealed : public Attribute
public final class EnumMemberAttribute extends Attribute
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.
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();
}
}
}
System..::.Object
System..::.Attribute
System.Runtime.Serialization..::.EnumMemberAttribute
Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Windows 7, Windows Vista, Windows XP SP2, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003
The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
.NET Framework
Supported in: 3.5, 3.0
Reference