HOWTO · Csharp
Converter Enum em String em C#
Além de `ToString()`, que retorna o nome declarado do membro, você pode usar `DescriptionAttribute` ou uma instrução `switch` para fornecer um rótulo personalizado.
Nesta página
Um valor de enum pode ser convertido em string de algumas maneiras, dependendo de você querer o nome declarado ou um rótulo separado, mais fácil de ler. ToString() basta para obter o nome do membro. Use DescriptionAttribute quando os rótulos devem ficar junto às declarações do enum, ou uma instrução switch quando quiser manter o mapeamento explícito. Os exemplos a seguir mostram as diferenças e o que acontece quando um valor não tem um rótulo personalizado. (C#)
Converta um valor de enum em string com ToString()
Chamar ToString() em um enum retorna o nome do membro declarado. Isso é útil em logs, diagnósticos e interfaces nas quais nomes como InProgress são adequados como texto exibido. A conversão não insere espaços nem altera maiúsculas e minúsculas. Console.WriteLine também converte um valor de enum em seu nome, mas chamar ToString() deixa a conversão explícita quando você atribui o resultado a uma string.
Execute este exemplo:
O código e os rótulos ou saídas exibidos nesta seção permanecem em inglês.
using System;
enum Status { InProgress, Completed }
class Program
{
static void Main()
{
Status status = Status.Completed;
string name = status.ToString();
Console.WriteLine(name);
}
}
Para esse valor declarado, o programa escreve Completed. Um valor numérico que não corresponde ao nome de um membro declarado é representado pelo próprio número. Para um enum de flags, ToString() pode exibir os nomes das flags correspondentes unidos; a conversão não cria uma frase personalizada para a combinação.
Adicione rótulos mais claros para o leitor com DescriptionAttribute
Associe um DescriptionAttribute a cada membro quando o rótulo precisar ser diferente do identificador. A reflexão pode localizar o campo de um valor nomeado e ler sua descrição. O auxiliar a seguir usa o nome do membro como alternativa quando não há descrição e a representação numérica quando o valor não corresponde a nenhum campo declarado.
O código e os rótulos ou saídas exibidos nesta seção permanecem em inglês.
using System;
using System.ComponentModel;
using System.Reflection;
enum Status
{
[Description("In progress")]
InProgress,
[Description("Successfully completed")]
Completed
}
static class EnumLabels
{
public static string GetLabel(Status value)
{
string name = Enum.GetName(typeof(Status), value);
if (name == null)
return value.ToString();
FieldInfo field = typeof(Status).GetField(name);
DescriptionAttribute attribute = (DescriptionAttribute)Attribute.GetCustomAttribute(
field, typeof(DescriptionAttribute));
return attribute == null ? name : attribute.Description;
}
}
class Program
{
static void Main()
{
Console.WriteLine(EnumLabels.GetLabel(Status.Completed));
}
}
Essa abordagem mantém os rótulos junto aos membros do enum, mas recuperá-los exige reflexão, e o comportamento alternativo precisa ser escolhido com cuidado. Neste exemplo, um valor numérico sem membro declarado não pode ter um atributo, então o auxiliar retorna sua representação numérica em string. Se os rótulos mudarem com frequência ou precisarem ser localizados, mantenha esse mapeamento na camada apropriada da aplicação, em vez de tratar um atributo como um sistema de localização.
Mapeie valores de enum para strings com uma instrução switch
Uma instrução switch deixa cada rótulo aceito e o caso alternativo visíveis em um só lugar. Ela é adequada para um mapeamento pequeno e estável ou quando o texto exibido deve ficar separado da declaração do enum. Adicione um caso quando incluir um membro; o caso alternativo abaixo retorna a representação padrão do enum em string para qualquer valor não listado.
O código e os rótulos ou saídas exibidos nesta seção permanecem em inglês.
using System;
enum Status { InProgress, Completed }
static class EnumLabels
{
public static string GetLabel(Status value)
{
switch (value)
{
case Status.InProgress:
return "In progress";
case Status.Completed:
return "Successfully completed";
default:
return value.ToString();
}
}
}
class Program
{
static void Main()
{
Console.WriteLine(EnumLabels.GetLabel(Status.Completed));
}
}
Um caso alternativo explícito é importante porque variáveis de enum podem conter valores numéricos que não são membros declarados. Em um enum de flags, um valor combinado pode não corresponder a nenhum caso individual; nesse caso, esse mapeamento retorna a representação padrão do enum, a menos que você adicione uma lógica para combinações.
Escolha uma abordagem e trate os casos especiais
Escolha ToString() quando o nome do membro do enum já for adequado. Escolha DescriptionAttribute quando cada membro tiver um rótulo estável para exibição e um pequeno auxiliar com reflexão for apropriado. Escolha um mapeamento com switch quando preferir controlar explicitamente os rótulos e o comportamento alternativo no código comum. Os exemplos com atributo e com switch usam rótulos diferentes dos identificadores do enum; nenhum deles altera o valor do enum.
Nas duas abordagens com rótulos personalizados, considere os valores que não correspondem a um membro declarado e as combinações de flags. Decida se esses casos devem exibir o valor numérico ou a representação padrão do enum em string, usar um rótulo genérico ou ser tratados por uma lógica específica. Mantenha essa decisão consistente em todos os lugares onde o valor for exibido. Essas abordagens tratam do texto de exibição; a serialização e as representações no banco de dados têm contratos próprios e devem ser configuradas separadamente.