Click here to Skip to main content

Enum Display Extension

Often, we use enums for some selection process (switch statements, etc.), but when we display them to the UI, we need it formatted differently (not camel hump or dash separated).

To start, attributes can be used to store the description, and should be stored in the DescriptionAttribute:

public enum EmployeeType
{
   [DescriptionAttribute("The Big Boss Man")]
   Boss,
 
   [DescriptionAttribute("Boss's lacky")]
   AdministrativeAssistant,
   
   Janitor,
 
   [DescriptionAttribute("Everyone Else")]
   StandardEmployee
}

Here, we have defined a simple enum called EmployeeType and added a description attribute to the ones we want to be displayed differently.

Now the interesting part. In case you are unfamiliar with Extensions, here is a link to the MSDN[^].

public static string DisplayString(this Enum value)
{
    //Using reflection to get the field info
    FieldInfo info = value.GetType().GetField(value.ToString());
 
    //Get the Description Attributes
    DescriptionAttribute[] attributes = (DescriptionAttribute[])info.GetCustomAttributes(typeof(DescriptionAttribute), false);
    
    //Only capture the description attribute if it is a concrete result (i.e. 1 entry)
    if (attributes.Length == 1)
    {
        return attributes[0].Description;
    }
    else //Use the value for display if not concrete result
    {
        return value.ToString();
    }
}

This extension to Enum can then be used like this:

EmployeeType emp = EmplyeeType.Boss;
...
string display = emp.DisplayString();//Retrieves "The Big Boss Man"
string janDisplay = EmployeeType.Janitor.DisplayString(); //retrieves "Janitor"

In addition, if you have the description, you can easily extend the string as well to get back to the actual enum value.

public static object EnumValueOf<t>(this string descriptionOrValue)
{
   //Get all possible values of this enum type
   Array tValues = Enum.GetValues(typeof(T));
 
   //Cycle through all values searching for a match (description or value)
   foreach (Enum val in tValues)
   {
       if (val.DisplayString().Equals(descriptionOrValue) || val.ToString().Equals(descriptionOrValue))
       {
          return val;
       }
    }
 
    throw new ArgumentException(string.Format("The string value is not of type {0}.", typeof(T).ToString()));
}</t>

Usage:
string display = "The Big Boss Man";
EmployeeType emp = (EmployeeType)display.EnumValueType<employeetype();>

Web02 | 2.8.160207.1 | Advertise | Privacy
Copyright © CodeProject, 1999-2016
All Rights Reserved. Terms of Service