Enum ToString con cadenas amigables para el usuario

Mi enumeración consta de los siguientes valores:

private enum PublishStatusses{ NotCompleted, Completed, Error }; 

Sin embargo, quiero poder mostrar estos valores de una manera fácil de usar.
No necesito poder pasar de cadena a valor nuevamente.

Uso el atributo Description del espacio de nombres System.ComponentModel. Simplemente decora la enumeración:

 private enum PublishStatusValue { [Description("Not Completed")] NotCompleted, Completed, Error }; 

Luego usa este código para recuperarlo:

 public static string GetDescription(this T enumerationValue) where T : struct { Type type = enumerationValue.GetType(); if (!type.IsEnum) { throw new ArgumentException("EnumerationValue must be of Enum type", "enumerationValue"); } //Tries to find a DescriptionAttribute for a potential friendly name //for the enum MemberInfo[] memberInfo = type.GetMember(enumerationValue.ToString()); if (memberInfo != null && memberInfo.Length > 0) { object[] attrs = memberInfo[0].GetCustomAttributes(typeof(DescriptionAttribute), false); if (attrs != null && attrs.Length > 0) { //Pull out the description value return ((DescriptionAttribute)attrs[0]).Description; } } //If we have no description attribute, just return the ToString of the enum return enumerationValue.ToString(); } 

Lo hago con métodos de extensión:

 public enum ErrorLevel { None, Low, High, SoylentGreen } public static class ErrorLevelExtensions { public static string ToFriendlyString(this ErrorLevel me) { switch(me) { case ErrorLevel.None: return "Everything is OK"; case ErrorLevel.Low: return "SNAFU, if you know what I mean."; case ErrorLevel.High: return "Reaching TARFU levels"; case ErrorLevel.SoylentGreen: return "ITS PEOPLE!!!!"; default: return "Get your damn dirty hands off me you FILTHY APE!"; } } } 

Tal vez me esté perdiendo algo, pero ¿qué pasa con Enum.GetName?

 public string GetName(PublishStatusses value) { return Enum.GetName(typeof(PublishStatusses), value) } 

editar: para cadenas fáciles de usar, necesita ir a .resource para lograr la internacionalización / localización, y podría decirse que sería mejor usar una clave fija basada en la clave enum que un atributo de decorador en la misma.

La solución más fácil aquí es usar un método de extensión personalizado (en .NET 3.5 como mínimo; puede convertirlo en un método de ayuda estático para versiones anteriores del framework).

 public static string ToCustomString(this PublishStatusses value) { switch(value) { // Return string depending on value. } return null; } 

Supongo que desea devolver algo que no sea el nombre real del valor enum (que puede obtener simplemente llamando a ToString).

Creé un método de extensión inversa para convertir la descripción a un valor enum:

  public static T ToEnumValue(this string enumerationDescription) where T : struct { Type type = typeof(T); if (!type.IsEnum) throw new ArgumentException("ToEnumValue(): Must be of enum type", "T"); foreach (object val in System.Enum.GetValues(type)) if (val.GetDescription() == enumerationDescription) return (T)val; throw new ArgumentException("ToEnumValue(): Invalid description for enum " + type.Name, "enumerationDescription"); } 

Esa otra publicación es Java. No puede poner métodos en Enums en C #.

solo haz algo como esto:

 PublishStatusses status = ... String s = status.ToString(); 

Si desea utilizar diferentes valores de visualización para sus valores enum, puede usar Atributos y Reflexión.

Algunas otras opciones más primitivas que evitan clases / tipos de referencia:

  • Método de matriz
  • Método de estructura anidada

Método de matriz

 private struct PublishStatusses { public static string[] Desc = { "Not Completed", "Completed", "Error" }; public enum Id { NotCompleted = 0, Completed, Error }; } 

Uso

 string desc = PublishStatusses.Desc[(int)PublishStatusses.Id.Completed]; 

Método de estructura anidada

 private struct PublishStatusses { public struct NotCompleted { public const int Id = 0; public const string Desc = "Not Completed"; } public struct Completed { public const int Id = 1; public const string Desc = "Completed"; } public struct Error { public const int Id = 2; public const string Desc = "Error"; } } 

Uso

 int id = PublishStatusses.NotCompleted.Id; string desc = PublishStatusses.NotCompleted.Desc; 

Actualización (03/09/2018)

Un híbrido de métodos de extensión y la primera técnica anterior.

Prefiero que las enumeraciones se definan donde “pertenecen” (más cercanas a su fuente de origen y no en un espacio de nombres común y global).

 namespace ViewModels { public class RecordVM { //public enum Enum { Minutes, Hours } public struct Enum { public enum Id { Minutes, Hours } public static string[] Name = { "Minute(s)", "Hour(s)" }; } } } 

El método de extensión parece adecuado para un área común, y la definición “localizada” de la enumeración ahora hace que el método de extensión sea más detallado.

 namespace Common { public static class EnumExtensions { public static string Name(this RecordVM.Enum.Id id) { return RecordVM.Enum.Name[(int)id]; } } } 

Un ejemplo de uso de la enumeración y su método de extensión.

 namespace Views { public class RecordView { private RecordDataFieldList _fieldUnit; public RecordView() { _fieldUnit.List = new IdValueList { new ListItem((int)RecordVM.Enum.Id.Minutes, RecordVM.Enum.Id.Minutes.Name()), new ListItem((int)RecordVM.Enum.Id.Hours, RecordVM.Enum.Id.Hours.Name()) }; } private void Update() { RecordVM.Enum.Id eId = DetermineUnit(); _fieldUnit.Input.Text = _fieldUnit.List.SetSelected((int)eId).Value; } } } 

Nota: de hecho decidí eliminar Enum wrapper (y Name array), ya que es mejor que las cadenas de nombre provengan de un recurso (es decir, archivo de configuración o DB) en lugar de estar codificadas, y porque terminé poniendo el método de extensión en el espacio de nombres ViewModels (solo en un archivo diferente, “CommonVM.cs”). Además, todo el asunto .Id vuelve .Id e incómodo.

 namespace ViewModels { public class RecordVM { public enum Enum { Minutes, Hours } //public struct Enum //{ // public enum Id { Minutes, Hours } // public static string[] Name = { "Minute(s)", "Hour(s)" }; //} } } 

CommonVM.cs

 //namespace Common namespace ViewModels { public static class EnumExtensions { public static string Name(this RecordVM.Enum id) { //return RecordVM.Enum.Name[(int)id]; switch (id) { case RecordVM.Enum.Minutes: return "Minute(s)"; case RecordVM.Enum.Hours: return "Hour(s)"; default: return null; } } } } 

Un ejemplo de uso de la enumeración y su método de extensión.

 namespace Views { public class RecordView { private RecordDataFieldList _fieldUnit public RecordView() { _fieldUnit.List = new IdValueList { new ListItem((int)RecordVM.Enum.Id.Minutes, RecordVM.Enum.Id.Minutes.Name()), new ListItem((int)RecordVM.Enum.Id.Hours, RecordVM.Enum.Id.Hours.Name()) }; } private void Update() { RecordVM.Enum eId = DetermineUnit(); _fieldUnit.Input.Text = _fieldUnit.List.SetSelected((int)eId).Value; } } } 

Con respecto a Ray Booysen, hay un error en el código: Enum ToString con cadenas amigables para el usuario

Debe contabilizar múltiples atributos en los valores enum.

 public static string GetDescription(this object enumerationValue) where T : struct { Type type = enumerationValue.GetType(); if (!type.IsEnum) { throw new ArgumentException("EnumerationValue must be of Enum type", "enumerationValue"); } //Tries to find a DescriptionAttribute for a potential friendly name //for the enum MemberInfo[] memberInfo = type.GetMember(enumerationValue.ToString()); if (memberInfo != null && memberInfo.Length > 0) { object[] attrs = memberInfo[0].GetCustomAttributes(typeof(DescriptionAttribute), false); if (attrs != null && attrs.Length > 0 && attrs.Where(t => t.GetType() == typeof(DescriptionAttribute)).FirstOrDefault() != null) { //Pull out the description value return ((DescriptionAttribute)attrs.Where(t=>t.GetType() == typeof(DescriptionAttribute)).FirstOrDefault()).Description; } } //If we have no description attribute, just return the ToString of the enum return enumerationValue.ToString(); 
 public enum MyEnum { [Description("Option One")] Option_One } public static string ToDescriptionString(this Enum This) { Type type = This.GetType(); string name = Enum.GetName(type, This); MemberInfo member = type.GetMembers() .Where(w => w.Name == name) .FirstOrDefault(); DescriptionAttribute attribute = member != null ? member.GetCustomAttributes(true) .Where(w => w.GetType() == typeof(DescriptionAttribute)) .FirstOrDefault() as DescriptionAttribute : null; return attribute != null ? attribute.Description : name; } 

La forma más simple es simplemente incluir esta clase de extensión en su proyecto, funcionará con cualquier enumeración en el proyecto:

 public static class EnumExtensions { public static string ToFriendlyString(this Enum code) { return Enum.GetName(code.GetType(), code); } } 

Uso:

 enum ExampleEnum { Demo = 0, Test = 1, Live = 2 } 

 ExampleEnum ee = ExampleEnum.Live; Console.WriteLine(ee.ToFriendlyString()); 

Puede usar el paquete Humanizer con Humanize Enums possiblity. Un ejemplo:

 enum PublishStatusses { [Description("Custom description")] NotCompleted, AlmostCompleted, Error }; 

entonces puedes usar el método de extensión Humanize en enum directamente:

 var st1 = PublishStatusses.NotCompleted; var str1 = st1.Humanize(); // will result in Custom description var st2 = PublishStatusses.AlmostCompleted; var str2 = st2.Humanize(); // will result in Almost completed (calculated automaticaly) 

Limpiar el resumen de las sugerencias anteriores con la muestra:

 namespace EnumExtensions { using System; using System.Reflection; public class TextAttribute : Attribute { public string Text; public TextAttribute( string text ) { Text = text; }//ctor }// class TextAttribute public static class EnumExtender { public static string ToText( this Enum enumeration ) { MemberInfo[] memberInfo = enumeration.GetType().GetMember( enumeration.ToString() ); if ( memberInfo != null && memberInfo.Length > 0 ) { object[] attributes = memberInfo[ 0 ].GetCustomAttributes( typeof(TextAttribute), false ); if ( attributes != null && attributes.Length > 0 ) { return ( (TextAttribute)attributes[ 0 ] ).Text; } }//if return enumeration.ToString(); }//ToText }//class EnumExtender }//namespace 

USO:

 using System; using EnumExtensions; class Program { public enum Appearance { [Text( "left-handed" ) ] Left, [Text( "right-handed" ) ] Right, }//enum static void Main( string[] args ) { var appearance = Appearance.Left; Console.WriteLine( appearance.ToText() ); }//Main }//class 

En lugar de usar una enumeración, utiliza una clase estática.

reemplazar

 private enum PublishStatuses{ NotCompleted, Completed, Error }; 

con

 private static class PublishStatuses{ public static readonly string NotCompleted = "Not Completed"; public static readonly string Completed = "Completed"; public static readonly string Error = "Error"; }; 

se usará así

 PublishStatuses.NotCompleted; // "Not Completed" 

Emita utilizando las mejores soluciones de “método de extensión”:

Una enumeración privada a menudo se usa dentro de otra clase. La solución del método de extensión no es válida allí, ya que debe estar en su propia clase. Esta solución puede ser privada e incrustada en otra clase.

Esta es una actualización del código de Ray Booysen que utiliza el método genérico GetCustomAttributes y LINQ para poner las cosas un poco más ordenadas.

  ///  /// Gets the value of the  on an struct, including enums. ///  /// The type of the struct. /// A value of type  /// If the struct has a Description attribute, this method returns the description. Otherwise it just calls ToString() on the struct. /// Based on http://stackoverflow.com/questions/479410/enum-tostring/479417#479417, but useful for any struct. public static string GetDescription(this T enumerationValue) where T : struct { return enumerationValue.GetType().GetMember(enumerationValue.ToString()) .SelectMany(mi => mi.GetCustomAttributes(false), (mi, ca) => ca.Description) .FirstOrDefault() ?? enumerationValue.ToString(); } 

Resulta que soy un fan de VB.NET, así que aquí está mi versión, combinando el método DescriptionAttribute con un método de extensión. Primero, los resultados:

 Imports System.ComponentModel ' For  Module Module1 '''  ''' An Enum type with three values and descriptions '''  Public Enum EnumType  V1 = 1 ' This one has no description V2 = 2  V3 = 3 End Enum Sub Main() ' Description method is an extension in EnumExtensions For Each v As EnumType In [Enum].GetValues(GetType(EnumType)) Console.WriteLine("Enum {0} has value {1} and description {2}", v, CInt(v), v.Description ) Next ' Output: ' Enum V1 has value 1 and description One ' Enum V2 has value 2 and description V2 ' Enum V3 has value 3 and description Three End Sub End Module 

Cosas básicas: una enumeración llamada EnumType con tres valores V1, V2 y V3. La “magia” ocurre en la llamada Console.WriteLine en Sub Main (), donde el último argumento es simplemente v.Description . Esto devuelve “Uno” para V1, “V2” para V2 y “Tres” para V3. Este método de descripción es, de hecho, un método de extensión, definido en otro módulo llamado EnumExtensions:

 Option Strict On Option Explicit On Option Infer Off Imports System.Runtime.CompilerServices Imports System.Reflection Imports System.ComponentModel Module EnumExtensions Private _Descriptions As New Dictionary(Of String, String) '''  ''' This extension method adds a Description method ''' to all enum members. The result of the method is the ''' value of the Description attribute if present, else ''' the normal ToString() representation of the enum value. '''   Public Function Description(e As [Enum]) As String ' Get the type of the enum Dim enumType As Type = e.GetType() ' Get the name of the enum value Dim name As String = e.ToString() ' Construct a full name for this enum value Dim fullName As String = enumType.FullName + "." + name ' See if we have looked it up earlier Dim enumDescription As String = Nothing If _Descriptions.TryGetValue(fullName, enumDescription) Then ' Yes we have - return previous value Return enumDescription End If ' Find the value of the Description attribute on this enum value Dim members As MemberInfo() = enumType.GetMember(name) If members IsNot Nothing AndAlso members.Length > 0 Then Dim descriptions() As Object = members(0).GetCustomAttributes(GetType(DescriptionAttribute), False) If descriptions IsNot Nothing AndAlso descriptions.Length > 0 Then ' Set name to description found name = DirectCast(descriptions(0), DescriptionAttribute).Description End If End If ' Save the name in the dictionary: _Descriptions.Add(fullName, name) ' Return the name Return name End Function End Module 

Debido a que buscar atributos de descripción usando Reflection es lento, las búsquedas también se almacenan en caché en un Dictionary privado, que se llena según demanda.

(Perdón por la solución VB.NET – debería ser relativamente directo traducirla a C #, y mi C # está oxidada en nuevos temas como extensiones)

Incluso un resumen más limpio:

 using System; using System.Reflection; public class TextAttribute : Attribute { public string Text; public TextAttribute(string text) { Text = text; } } public static class EnumExtender { public static string ToText(this Enum enumeration) { var memberInfo = enumeration.GetType().GetMember(enumeration.ToString()); if (memberInfo.Length <= 0) return enumeration.ToString(); var attributes = memberInfo[0].GetCustomAttributes(typeof(TextAttribute), false); return attributes.Length > 0 ? ((TextAttribute)attributes[0]).Text : enumeration.ToString(); } } 

El mismo uso que describe el subrayado.

Para banderas enum incluyendo.

  public static string Description(this Enum value) { Type type = value.GetType(); List res = new List(); var arrValue = value.ToString().Split(',').Select(v=>v.Trim()); foreach (string strValue in arrValue) { MemberInfo[] memberInfo = type.GetMember(strValue); if (memberInfo != null && memberInfo.Length > 0) { object[] attrs = memberInfo[0].GetCustomAttributes(typeof(DescriptionAttribute), false); if (attrs != null && attrs.Length > 0 && attrs.Where(t => t.GetType() == typeof(DescriptionAttribute)).FirstOrDefault() != null) { res.Add(((DescriptionAttribute)attrs.Where(t => t.GetType() == typeof(DescriptionAttribute)).FirstOrDefault()).Description); } else res.Add(strValue); } else res.Add(strValue); } return res.Aggregate((s,v)=>s+", "+v); } 

Creo que la mejor (y más fácil) manera de resolver su problema es escribir un Método de extensión para su enumeración:

 public static string GetUserFriendlyString(this PublishStatusses status) { } 

Si quieres algo completamente personalizable, prueba mi solución aquí:

http://www.kevinwilliampang.com/post/Mapping-Enums-To-Strings-and-Strings-to-Enums-in-NET.aspx

Básicamente, la publicación describe cómo adjuntar atributos de Descripción a cada una de sus enumeraciones y proporciona una forma genérica de asignar de enumeración a descripción.