String representation of an Enum

String Representation of an Enum: Simplifying Enum Values

🔠💡📊

Have you ever encountered the problem of needing the actual word representation of an enum value instead of its underlying ID? If so, you're not alone! The good news is that there is a solution - and it's easier than you might think. In this blog post, we'll explore a common issue and provide you with an easy solution that will save you time and effort when working with enums.

Understanding the Problem 🤔

Let's start by looking at a specific scenario. Suppose you have the following enum:

public enum AuthenticationMethod
{
    FORMS = 1,
    WINDOWSAUTHENTICATION = 2,
    SINGLESIGNON = 3
}

Now, when you ask for AuthenticationMethod.FORMS, you want to get the string "FORMS" instead of the numeric ID 1. This is where the problem lies. By default, enums only provide the numeric values associated with each enum member. But fear not! We have a solution that will allow you to easily retrieve the desired string representation.

The Solution 🎉

The solution involves the use of custom attributes and a handy utility class. Here's what you need to do:

Step 1: Create the Custom Attribute

First, we need to create a custom attribute called StringValue. This attribute will hold the string representation of each enum value.

public class StringValue : System.Attribute
{
    private readonly string _value;

    public StringValue(string value)
    {
        _value = value;
    }

    public string Value
    {
        get { return _value; }
    }
}

Step 2: Add the Attribute to the Enumerator

Next, we'll add the StringValue attribute to each enum member, along with its corresponding string representation.

public enum AuthenticationMethod
{
    [StringValue("FORMS")]
    FORMS = 1,
    
    [StringValue("WINDOWS")]
    WINDOWSAUTHENTICATION = 2,
    
    [StringValue("SSO")]
    SINGLESIGNON = 3
}

Step 3: Create a Utility Class

To retrieve the string value for an enum member, we'll create a utility class called StringEnum. This class will contain a static method named GetStringValue that receives an enum value as a parameter and returns its string representation.

public static class StringEnum
{
    public static string GetStringValue(Enum value)
    {
        string output = null;
        Type type = value.GetType();
        
        FieldInfo fi = type.GetField(value.ToString());
        StringValue[] attrs = fi.GetCustomAttributes(typeof(StringValue), false) as StringValue[];
        
        if (attrs.Length > 0)
        {
            output = attrs[0].Value;
        }

        return output;
    }
}

Step 4: Utilize the StringEnum Utility

Now that we have all the necessary tools, let's put them to work. To get the string value for an enum member, simply call the GetStringValue method and pass in the desired enum value.

string valueOfAuthenticationMethod = StringEnum.GetStringValue(AuthenticationMethod.FORMS);

Is There a Better Alternative? 🤷‍♀️

You might be wondering if there's a simpler solution to this problem. Well, we considered that too. We tried using a dictionary and static properties, but unfortunately, they didn't prove to be any better.

In the end, even though the solution we provided involves a few extra steps, it's worth the effort. The StringValue attribute and the StringEnum utility class provide a robust and flexible way to retrieve the string representation of enums.

Share Your Thoughts! 📣

Have you encountered this problem before? How did you deal with it? We'd love to hear about your experiences and any alternate solutions you've come across. Leave a comment below and let's discuss! Let's make enum handling a breeze for everyone! 💪🌪

source