XmlEnumAttribute Classe

Definição

Controla como o XmlSerializer serializa um membro de enumeração.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
Herança
XmlEnumAttribute
Atributos

Exemplos

O exemplo a seguir aplica XmlEnumAttribute o aos membros de uma enumeração.The following example applies the XmlEnumAttribute to the members of an enumeration. Quando o XmlSerializer gera dados XML para essa enumeração, os dados estão em conformidade com os valores Name das propriedades.When 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

Observação

Você pode usar a palavra XmlEnum em seu código em vez de mais XmlEnumAttributelonga.You can use the word XmlEnum in your code instead of the longer XmlEnumAttribute.

Comentários

O XmlEnumAttribute pertence a uma família de atributos que controla como o XmlSerializer serializa ou desserializa um objeto.The XmlEnumAttribute belongs to a family of attributes that controls how the XmlSerializer serializes or deserializes an object. Para obter uma lista completa de atributos semelhantes, consulte atributos que controlam a serialização de XML.For a complete list of similar attributes, see Attributes That Control XML Serialization.

Use o XmlEnumAttribute para alterar a enumeração que o XmlSerializer gera ou reconhece (quando ele serializa ou desserializa uma classe, respectivamente).Use the XmlEnumAttribute to change the enumeration that the XmlSerializer generates or recognizes (when it serializes or deserializes a class, respectively). Por exemplo, se uma enumeração contiver um membro Onechamado, mas você preferir que a saída XML seja Singlenomeada, aplique XmlEnumAttribute o ao membro de enumeração e defina Name a propriedade como "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".

Você pode substituir o Name valor da propriedade de XmlEnumAttribute um XmlEnumAttribute criando uma instância da XmlEnum classe e atribuindo-a à propriedade de um XmlAttributes 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 obter detalhes, consulte XmlAttributeOverrides a classe.For details, see the XmlAttributeOverrides class.

Observação

Você pode usar a palavra XmlEnum em seu código em vez de mais XmlEnumAttributelonga.You can use the word XmlEnum in your code instead of the longer XmlEnumAttribute.

Construtores

XmlEnumAttribute()

Inicializa uma nova instância da classe XmlEnumAttribute.Initializes a new instance of the XmlEnumAttribute class.

XmlEnumAttribute(String)

Inicializa uma nova instância da classe XmlEnumAttribute e especifica o valor de XML que o XmlSerializer gera ou reconhece (quando ele serializa ou desserializa a enumeração, 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).

Propriedades

Name

Obtém ou define o valor gerado em uma instância de documento XML quando o XmlSerializer serializa uma enumeração ou o valor reconhecido quando ele desserializa o membro da enumeração.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

Quando implementado em uma classe derivada, obtém um identificador exclusivo para este Attribute.When implemented in a derived class, gets a unique identifier for this Attribute.

(Herdado de Attribute)

Métodos

Equals(Object)

Retorna um valor que indica se essa instância é igual a um objeto especificado.Returns a value that indicates whether this instance is equal to a specified object.

(Herdado de Attribute)
GetHashCode()

Retorna o código hash para essa instância.Returns the hash code for this instance.

(Herdado de Attribute)
GetType()

Obtém o Type da instância atual.Gets the Type of the current instance.

(Herdado de Object)
IsDefaultAttribute()

Quando substituído em uma classe derivada, indica se o valor dessa instância é o valor padrão para a classe derivada.When overridden in a derived class, indicates whether the value of this instance is the default value for the derived class.

(Herdado de Attribute)
Match(Object)

Quando substituído em uma classe derivada, retorna um valor que indica se essa instância é igual a um objeto especificado.When overridden in a derived class, returns a value that indicates whether this instance equals a specified object.

(Herdado de Attribute)
MemberwiseClone()

Cria uma cópia superficial do Object atual.Creates a shallow copy of the current Object.

(Herdado de Object)
ToString()

Retorna uma cadeia de caracteres que representa o objeto atual.Returns a string that represents the current object.

(Herdado de Object)

Implantações explícitas de interface

_Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr)

Mapeia um conjunto de nomes para um conjunto correspondente de identificadores de expedição.Maps a set of names to a corresponding set of dispatch identifiers.

(Herdado de Attribute)
_Attribute.GetTypeInfo(UInt32, UInt32, IntPtr)

Recupera as informações de tipo para um objeto, que pode ser usado para obter as informações de tipo para uma interface.Retrieves the type information for an object, which can be used to get the type information for an interface.

(Herdado de Attribute)
_Attribute.GetTypeInfoCount(UInt32)

Retorna o número de interfaces de informações do tipo que um objeto fornece (0 ou 1).Retrieves the number of type information interfaces that an object provides (either 0 or 1).

(Herdado de Attribute)
_Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr)

Fornece acesso a propriedades e métodos expostos por um objeto.Provides access to properties and methods exposed by an object.

(Herdado de Attribute)

Aplica-se a

Veja também