HOWTO · Csharp
Converti Enum in stringa in C#
In C# puoi convertire un'enumerazione in stringa con ToString() per ottenere il nome del membro; per le etichette personalizzate, usa DescriptionAttribute oppure un'istruzione switch.
In questa pagina
Un valore di enumerazione può diventare una stringa in diversi modi, a seconda che si voglia usare il nome dichiarato o un’etichetta distinta, più leggibile. Per ottenere il nome del membro basta ToString(). Usa DescriptionAttribute se vuoi associare le etichette alle dichiarazioni dell’enumerazione, oppure un’istruzione switch se preferisci mantenere esplicita la corrispondenza. Gli esempi seguenti illustrano le differenze e cosa accade quando un valore non ha un’etichetta personalizzata. (C#)
Convertire un valore di enumerazione in stringa con ToString()
Chiamando ToString() su un’enumerazione si ottiene il nome del membro dichiarato. È utile per i log, la diagnostica e le interfacce in cui nomi come InProgress sono adatti come testo visualizzato. Non inserisce spazi né modifica le maiuscole. Anche Console.WriteLine converte un valore dell’enumerazione nel suo nome, ma chiamare ToString() rende esplicita la conversione quando si assegna il risultato a una stringa.
Esegui questo esempio:
Il codice e le etichette o gli output visibili in questa sezione restano in inglese.
using System;
enum Status { InProgress, Completed }
class Program
{
static void Main()
{
Status status = Status.Completed;
string name = status.ToString();
Console.WriteLine(name);
}
}
Per questo valore dichiarato, il programma stampa Completed. Un valore numerico che non corrisponde al nome di un membro dichiarato viene rappresentato come numero. Per un’enumerazione di flag, ToString() può mostrare i nomi dei flag corrispondenti uniti tra loro; non crea una frase personalizzata per la combinazione.
Aggiungere etichette più leggibili con DescriptionAttribute
Aggiungi un DescriptionAttribute a ogni membro quando l’etichetta deve essere diversa dall’identificatore. La reflection può individuare il campo corrispondente a un valore con nome e leggerne la descrizione. Il metodo di supporto seguente restituisce il nome del membro se manca la descrizione e la rappresentazione numerica se il valore non corrisponde a un campo dichiarato.
Il codice e le etichette o gli output visibili in questa sezione restano in inglese.
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));
}
}
Questo approccio mantiene le etichette accanto ai membri dell’enumerazione, ma per recuperarle serve la reflection e occorre scegliere con attenzione il comportamento di fallback. In questo esempio, un valore numerico senza nome non può avere un attributo, quindi il metodo restituisce la sua rappresentazione numerica come stringa. Se le etichette cambiano spesso o devono essere localizzate, gestisci la corrispondenza nel livello applicativo appropriato invece di trattare un attributo come un sistema di localizzazione.
Mappare i valori dell’enumerazione a stringhe con un’istruzione switch
Un’istruzione switch mostra in un unico punto ogni etichetta supportata e il relativo fallback. È adatta a una mappatura piccola e stabile oppure quando il testo visualizzato deve restare separato dalla dichiarazione dell’enumerazione. Aggiungi un caso quando aggiungi un membro; per i valori non elencati, il fallback seguente restituisce la rappresentazione predefinita dell’enumerazione come stringa.
Il codice e le etichette o gli output visibili in questa sezione restano in inglese.
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));
}
}
Un fallback esplicito è importante perché le variabili di enumerazione possono contenere valori numerici che non corrispondono a membri dichiarati. Per un’enumerazione di flag, un valore combinato potrebbe non corrispondere a nessun singolo caso; quindi, se non aggiungi una logica per le combinazioni, questa mappatura restituisce la rappresentazione predefinita dell’enumerazione.
Scegliere un approccio e gestire i casi limite
Scegli ToString() quando il nome del membro dell’enumerazione è già adatto. Scegli DescriptionAttribute quando ogni membro ha un’etichetta stabile da visualizzare e un piccolo metodo di supporto basato sulla reflection è appropriato. Scegli una mappatura switch quando preferisci controllare esplicitamente le etichette e il comportamento di fallback nel codice ordinario. Gli esempi con attributo e con switch usano etichette diverse dagli identificatori dell’enumerazione; nessuno dei due modifica il valore dell’enumerazione.
Per entrambi gli approcci con etichette personalizzate, considera i valori che non corrispondono a un membro dichiarato e le combinazioni di flag. Decidi se questi casi devono mostrare il valore numerico o la rappresentazione predefinita dell’enumerazione, usare un’etichetta generica oppure essere gestiti con una logica dedicata. Applica la stessa scelta ovunque venga visualizzato il valore. Questi approcci riguardano il testo mostrato; la serializzazione e le rappresentazioni nel database seguono contratti distinti e vanno configurate separatamente.