EnumMemberAttribute Clase

Definición

Espacio de nombres:

System.Runtime.Serialization

Ensamblado:

System.Runtime.Serialization.Primitives.dll

Ensamblado:

System.Runtime.Serialization.dll

Ensamblado:

netstandard.dll

Especifica que el campo es un miembro de enumeración y se debe serializar.

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

Herencia

Object

Attribute

EnumMemberAttribute

Atributos

AttributeUsageAttribute

Ejemplos

En el siguiente ejemplo, se muestra EnumMemberAttribute aplicado a los miembros de una enumeración.

[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

Comentarios

EnumMemberAttribute habilita un control preciso de los nombres de las enumeraciones a medida que se serializan.

Para usar EnumMemberAttribute, cree una enumeración y aplique el atributo DataContractAttribute a la enumeración. A continuación, aplique el atributo EnumMemberAttribute a cada miembro que deba estar en la secuencia de la serialización.

Constructores

EnumMemberAttribute()

Inicializa una nueva instancia de la clase EnumMemberAttribute.

Propiedades

IsValueSetExplicitly	Obtiene si Value se estableció explícitamente.
TypeId	Cuando se implementa en una clase derivada, obtiene un identificador único para este Attribute. (Heredado de Attribute)
Value	Obtiene o establece el valor asociado al miembro de enumeración al que se aplica el atributo.

Métodos

Equals(Object)	Devuelve un valor que indica si esta instancia es igual que un objeto especificado. (Heredado de Attribute)
GetHashCode()	Devuelve el código hash de esta instancia. (Heredado de Attribute)
GetType()	Obtiene el Type de la instancia actual. (Heredado de Object)
IsDefaultAttribute()	Si se reemplaza en una clase derivada, indica si el valor de esta instancia es el valor predeterminado de la clase derivada. (Heredado de Attribute)
Match(Object)	Cuando se invalida en una clase derivada, devuelve un valor que indica si esta instancia es igual a un objeto especificado. (Heredado de Attribute)
MemberwiseClone()	Crea una copia superficial del Object actual. (Heredado de Object)
ToString()	Devuelve una cadena que representa el objeto actual. (Heredado de Object)

Implementaciones de interfaz explícitas

_Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr)	Asigna un conjunto de nombres a un conjunto correspondiente de identificadores de envío. (Heredado de Attribute)
_Attribute.GetTypeInfo(UInt32, UInt32, IntPtr)	Obtiene la información de tipos de un objeto, que puede utilizarse para obtener la información de tipos de una interfaz. (Heredado de Attribute)
_Attribute.GetTypeInfoCount(UInt32)	Recupera el número de interfaces de información de tipo que proporciona un objeto (0 ó 1). (Heredado de Attribute)
_Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr)	Proporciona acceso a las propiedades y los métodos expuestos por un objeto. (Heredado de Attribute)

Consulte también

• DataContractAttribute