XmlEnumAttribute Clase

Definición

Controla el modo en que XmlSerializer serializa un miembro de enumeración.Controls how the XmlSerializer serializes an enumeration member.

public ref class XmlEnumAttribute : Attribute
[System.AttributeUsage(System.AttributeTargets.Field)]
public class XmlEnumAttribute : Attribute
type XmlEnumAttribute = class
    inherit Attribute
Public Class XmlEnumAttribute
Inherits Attribute
Herencia
XmlEnumAttribute
Atributos

Ejemplos

XmlEnumAttribute En el ejemplo siguiente se aplica a los miembros de una enumeración.The following example applies the XmlEnumAttribute to the members of an enumeration. Cuando genera datos XML para esta enumeración, los datos se ajustan a los valores de las Name propiedades. XmlSerializerWhen the XmlSerializer generates XML data for this enumeration, the data conforms to the values of the Name properties.

public enum class EmployeeStatus
{
   [XmlEnum(Name = "Single")]
   One,
   [XmlEnum(Name = "Double")]
   Two,
   [XmlEnum(Name = "Triple")]
   Three
};

public enum EmployeeStatus
{
   [XmlEnum(Name = "Single")]
   One,
   [XmlEnum(Name = "Double")]
   Two,
   [XmlEnum(Name = "Triple")]
   Three
}
   
Public Enum EmployeeStatus
   <XmlEnum("Single")> One = 1
   <XmlEnum("Double")> Two = 2
   <XmlEnum("Triple")> Three = 3
End Enum

Nota

Puede usar la palabra XmlEnum en el código en lugar de la más larga. XmlEnumAttributeYou can use the word XmlEnum in your code instead of the longer XmlEnumAttribute.

Comentarios

Pertenece a una familia de atributos que controla XmlSerializer cómo serializa o deserializa un objeto. XmlEnumAttributeThe XmlEnumAttribute belongs to a family of attributes that controls how the XmlSerializer serializes or deserializes an object. Para obtener una lista completa de atributos similares, vea atributos que controlan la serialización XML.For a complete list of similar attributes, see Attributes That Control XML Serialization.

Utilice para cambiar la enumeración XmlSerializer que genera o reconoce (cuando serializa o deserializa una clase, respectivamente). XmlEnumAttributeUse the XmlEnumAttribute to change the enumeration that the XmlSerializer generates or recognizes (when it serializes or deserializes a class, respectively). Por ejemplo, si una enumeración contiene un miembro Onedenominado, pero prefiere que la salida XML se denomine Single, aplique XmlEnumAttribute al miembro de enumeración y establezca Name la propiedad en "single".For example, if an enumeration contains a member named One, but you prefer that the XML output be named Single, apply the XmlEnumAttribute to the enumeration member and set the Name property to "Single".

Puede invalidar el Name valor XmlEnumAttribute de la propiedad de mediante la creación de una XmlEnumAttribute instancia de la clase y su asignación a XmlEnum la propiedad de XmlAttributes un objeto.You can override the Name property value of an XmlEnumAttribute by creating an instance of the XmlEnumAttribute class and assigning it to the XmlEnum property of an XmlAttributes object. Para obtener más información, XmlAttributeOverrides vea la clase.For details, see the XmlAttributeOverrides class.

Nota

Puede usar la palabra XmlEnum en el código en lugar de la más larga. XmlEnumAttributeYou can use the word XmlEnum in your code instead of the longer XmlEnumAttribute.

Constructores

XmlEnumAttribute()

Inicializa una nueva instancia de la clase XmlEnumAttribute.Initializes a new instance of the XmlEnumAttribute class.

XmlEnumAttribute(String)

Inicializa una nueva instancia de la clase XmlEnumAttribute y especifica el valor XML que XmlSerializer genera o reconoce al serializar o deserializar la enumeración, respectivamente.Initializes a new instance of the XmlEnumAttribute class, and specifies the XML value that the XmlSerializer generates or recognizes (when it serializes or deserializes the enumeration, respectively).

Propiedades

Name

Obtiene o establece el valor generado en una instancia de documento XML cuando XmlSerializer serializa una enumeración o el valor reconocido cuando deserializa el miembro de enumeración.Gets or sets the value generated in an XML-document instance when the XmlSerializer serializes an enumeration, or the value recognized when it deserializes the enumeration member.

TypeId

Cuando se implementa en una clase derivada, obtiene un identificador único para este Attribute.When implemented in a derived class, gets a unique identifier for this Attribute.

(Heredado de Attribute)

Métodos

Equals(Object)

Devuelve un valor que indica si esta instancia es igual que un objeto especificado.Returns a value that indicates whether this instance is equal to a specified object.

(Heredado de Attribute)
GetHashCode()

Devuelve el código hash de esta instancia.Returns the hash code for this instance.

(Heredado de Attribute)
GetType()

Obtiene el Type de la instancia actual.Gets the Type of the current instance.

(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.When overridden in a derived class, indicates whether the value of this instance is the default value for the derived class.

(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.When overridden in a derived class, returns a value that indicates whether this instance equals a specified object.

(Heredado de Attribute)
MemberwiseClone()

Crea una copia superficial del objeto Object actual.Creates a shallow copy of the current Object.

(Heredado de Object)
ToString()

Devuelve una cadena que representa el objeto actual.Returns a string that represents the current object.

(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.Maps a set of names to a corresponding set of dispatch identifiers.

(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.Retrieves the type information for an object, which can be used to get the type information for an interface.

(Heredado de Attribute)
_Attribute.GetTypeInfoCount(UInt32)

Recupera el número de interfaces de información de tipo que proporciona un objeto (0 ó 1).Retrieves the number of type information interfaces that an object provides (either 0 or 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.Provides access to properties and methods exposed by an object.

(Heredado de Attribute)

Se aplica a

Consulte también: