XmlEnumAttribute Classe

Referência

Definição

Namespace:: System.Xml.Serialization

Assembly:: System.Xml.XmlSerializer.dll

Assembly:: System.Xml.ReaderWriter.dll

Assembly:: System.Xml.dll

Assembly:: netstandard.dll

Importante

Algumas informações se referem a produtos de pré-lançamento que podem ser substancialmente modificados antes do lançamento. A Microsoft não oferece garantias, expressas ou implícitas, das informações aqui fornecidas.

Controla como o XmlSerializer serializa um membro de enumeração.

public ref class XmlEnumAttribute : Attribute

[System.AttributeUsage(System.AttributeTargets.Field)]
public class XmlEnumAttribute : Attribute

[<System.AttributeUsage(System.AttributeTargets.Field)>]
type XmlEnumAttribute = class
    inherit Attribute

Public Class XmlEnumAttribute
Inherits Attribute

Herança: Object

Attribute
XmlEnumAttribute

Atributos: AttributeUsageAttribute

Exemplos

O exemplo a seguir aplica os XmlEnumAttribute membros de uma enumeração. Quando os XmlSerializer dados XML são gerados para essa enumeração, os dados estão em conformidade com os valores das Name propriedades.

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 tempo XmlEnumAttribute.

Comentários

Pertence XmlEnumAttribute a uma família de atributos que controla como o XmlSerializer serializa ou desserializa um objeto. Para obter uma lista completa de atributos semelhantes, consulte Atributos que controlam a serialização XML.

Use a XmlEnumAttribute para alterar a enumeração que a XmlSerializer gera ou reconhece (quando ela serializa ou desserializa uma classe, respectivamente). Por exemplo, se uma enumeração contiver um membro nomeado One, mas você preferir que a saída XML seja nomeada Single, aplique o XmlEnumAttribute membro de enumeração e defina a Name propriedade como "Única".

Você pode substituir o Name valor da propriedade de uma XmlEnumAttribute criando uma instância da XmlEnumAttribute classe e atribuindo-a XmlEnum à propriedade de um XmlAttributes objeto. Para obter detalhes, consulte a XmlAttributeOverrides classe.

Observação

Você pode usar a palavra XmlEnum em seu código em vez de mais tempo XmlEnumAttribute.

Construtores

XmlEnumAttribute()	Inicializa uma nova instância da classe XmlEnumAttribute.
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).

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.
TypeId	Quando implementado em uma classe derivada, obtém um identificador exclusivo para este Attribute. (Herdado de Attribute)

Métodos

Equals(Object)	Retorna um valor que indica se essa instância é igual a um objeto especificado. (Herdado de Attribute)
GetHashCode()	Retorna o código hash para a instância. (Herdado de Attribute)
GetType()	Obtém o Type da instância atual. (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. (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. (Herdado de Attribute)
MemberwiseClone()	Cria uma cópia superficial do Object atual. (Herdado de Object)
ToString()	Retorna uma cadeia de caracteres que representa o objeto atual. (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. (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. (Herdado de Attribute)
_Attribute.GetTypeInfoCount(UInt32)	Retorna o número de interfaces de informações do tipo que um objeto fornece (0 ou 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. (Herdado de Attribute)

Aplica-se a

Compartilhar via