Compartilhar via

Sequências de Caracteres de Formatação de Enumeração

  • Artigo

Você pode usar o método Enum.ToString para criar um novo objeto de sequência de caracteres que representa o valor numérico, hexadecimal, ou valor da sequência de caracteres de um membro de enumeração. Este método usa uma das sequências de caracateres de formatação de enumeração para especificar o valor que você deseja que seja retornado.

A tabela a seguir lista as sequências de caracteres de formatação de enumeração e os valores que elas retornam. Esses especificadores de formato não diferenciam maiúsculas de minúsculas.

Sequência de caracteres de formatação

Resultado

G ou g

Exibe a entrada de enumeração como um valor de sequência de caracteres, se possível; caso contrário, exibe o valor inteiro da instância atual. Se a enumeração for definida com o atributo Flags definido, os valores da sequência de caracteres de cada entrada válida são concatenados, separados por vírgulas. Se o atributo Flags não é definido, um valor inválido é exibido como uma entrada numérica. O exemplo a seguir ilustra o especificador de formato G.

F ou f

Exibe a entrada de enumeração como um valor da sequência de caracteres, se possível. Se o valor puder ser totalmente exibido como uma soma das entradas na enumeração (mesmo se o atributo Flags não estiver presente), os valores da sequência de caracteres de cada entrada válida são concatenados, separados por vírgulas. Se o valor não puder ser completamente determinado pelas entradas de enumeração, então o valor é formatado como o valor inteiro. O exemplo a seguir ilustra o especificador de formato F.

D ou d

Exibe a entrada de enumeração como um valor inteiro na representação mais curta possível. O exemplo a seguir ilustra o especificador de formato D.

X ou x

Exibe a entrada de enumeração como um valor hexadecimal. O valor é representado com zeros à esquerda, conforme necessário, para garantir que o valor tenha no mínimo oito dígitos de tamanho. O exemplo a seguir ilustra o especificador de formato X.

Exemplo

O exemplo a seguir define uma enumeração denominada Colors que consiste em três entradas: Red, Blue, and Green.

Public Enum Color
   Red = 1
   Blue = 2
   Green = 3
End Enum

public enum Color {Red = 1, Blue = 2, Green = 3}

Após a enumeração estar definida, uma instância pode ser declarada da maneira a seguir.

Dim myColor As Color = Color.Green      

Color myColor = Color.Green;

O método Color.ToString(System.String) pode então ser usado para exibir o valor de enumeração de diferentes maneiras, dependendo do especificador de formato passado para ele.

Console.WriteLine("The value of myColor is {0}.", _
                  myColor.ToString("G"))
Console.WriteLine("The value of myColor is {0}.", _
                  myColor.ToString("F"))
Console.WriteLine("The value of myColor is {0}.", _
                  myColor.ToString("D"))
Console.WriteLine("The value of myColor is 0x{0}.", _
                  myColor.ToString("X"))
' The example displays the following output to the console:
'       The value of myColor is Green.
'       The value of myColor is Green.
'       The value of myColor is 3.
'       The value of myColor is 0x00000003.      

Console.WriteLine("The value of myColor is {0}.", 
                  myColor.ToString("G"));
Console.WriteLine("The value of myColor is {0}.", 
                  myColor.ToString("F"));
Console.WriteLine("The value of myColor is {0}.", 
                  myColor.ToString("D"));
Console.WriteLine("The value of myColor is 0x{0}.", 
                  myColor.ToString("X"));
// The example displays the following output to the console:
//       The value of myColor is Green.
//       The value of myColor is Green.
//       The value of myColor is 3.
//       The value of myColor is 0x00000003.

Consulte também

Conceitos

Tipos de Formatação