Enum ToString with user friendly strings

by

I use the Description attribute from the System.ComponentModel namespace. Simply decorate the enum:

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

Then use this code to retrieve it:

public static string GetDescription<T>(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();
}

More Related Contents:

  1. How to declare enums in C#
  2. Convert a string to an enum in C#
  3. Enum “Inheritance”
  4. How to get C# Enum description from value? [duplicate]
  5. Can my enums have friendly names? [duplicate]
  6. C# vs Java Enum (for those new to C#)
  7. Non-unique enum values
  8. How can I cast int to enum in C#?
  9. How does the .ToString() method work?
  10. What is the tilde (~) in the enum definition?
  11. WPF Binding a ListBox to an enum, displaying the Description Attribute
  12. How to set enum to null
  13. Set up dot instead of comma in numeric values
  14. Why enums require an explicit cast to int type?
  15. How to check if any flags of a flag combination are set?
  16. How do you pass multiple enum values in C#?
  17. How to make JSON.Net serializer to call ToString() when serializing a particular type?
  18. How to convert a character in to equivalent System.Windows.Input.Key Enum value?
  19. How to define an enum with string value?
  20. Enum to Dictionary in C#
  21. How to prevent duplicate values in enum?
  22. C# int, Int32 and enums
  23. Binding an enum to a WinForms combo box, and then setting it
  24. Enum to Dictionary in C#
  25. Total number of items defined in an enum
  26. Deserialize Dictionary with enum values in C#
  27. How to convert from System.Enum to base integer?
  28. Model Binding to Enums in ASP.NET MVC 3
  29. How can I use enum types in XAML?
  30. C# Converting 20 digit precision double to string and back again

Leave a Comment