Enum localization

C#asp.net Mvc-4Localization

C# Problem Overview


How do you localize enums for a ListBoxFor where multiple options are possible?

For example an enum that contains roles:

public enum RoleType
{
    [Display(Description = "Administrator", ResourceType = typeof(Resource))]
    Administrator = 1,
    [Display(Description = "Moderator", ResourceType = typeof(Resource))]
    Moderator = 2,
    [Display(Description = "Webmaster", ResourceType = typeof(Resource))]
    Webmaster = 3,
    [Display(Description = "Guest", ResourceType = typeof(Resource))]
    Guest = 4,
    Etc.... = 5,
}

I have seen this done with dropdownlist/selectlists. But is there a way to do this for a multi select list?

[EDIT]

This is how I'd like to use it, which is how it works now but doesn't get translated in a different language:

var roles = from role r in Enum.GetValues(typeof(RoleType))
            select new
            {
               Id = (int)Enum.Parse(typeof(RoleType), r.ToString()),
               Name = r.ToString()
            };

searchModel.roles = new MultiSelectList(roles, "Id", "Name");

Note: i have renamed the enum from Role to RoleType.

C# Solutions


Solution 1 - C#

You can implement a description attribute.

public class LocalizedDescriptionAttribute : DescriptionAttribute
{
     private readonly string _resourceKey;
    private readonly ResourceManager _resource;
    public LocalizedDescriptionAttribute(string resourceKey, Type resourceType)
    {
        _resource = new ResourceManager(resourceType);
        _resourceKey = resourceKey;
    }

    public override string Description
    {
        get
        {
            string displayName = _resource.GetString(_resourceKey);

            return string.IsNullOrEmpty(displayName)
                ? string.Format("[[{0}]]", _resourceKey)
                : displayName;
        }
    }
}

public static class EnumExtensions
{
    public static string GetDescription(this Enum enumValue) 
    {
        FieldInfo fi = enumValue.GetType().GetField(enumValue.ToString());

        DescriptionAttribute[] attributes =
            (DescriptionAttribute[])fi.GetCustomAttributes(
            typeof(DescriptionAttribute),
            false);

        if (attributes != null &&
            attributes.Length > 0)
            return attributes[0].Description;
        else
            return enumValue.ToString();
    }
}

Define it like this:

public enum Roles
{
    [LocalizedDescription("Administrator", typeof(Resource))]
    Administrator,
...
}

And use it like this:

var roles = from RoleType role in Enum.GetValues(typeof(RoleType))
                    select new
                    {
                        Id = (int)role,
                        Name = role.GetDescription()
                    };
 searchModel.roles = new MultiSelectList(roles, "Id", "Name");

Solution 2 - C#

I solved the issue by creating a EnumExtension which I use in my view. This extension looks for a resource file called "EnumResources.resx" and looks up the resource by the following naming convention {Name of EnumType}_{Value of enum passed in}. If the resource key is missing it will display the value of the resource encapsulated within double brackets [[EnumValue]]. This way its easy to find a "untranslated" Enum in your view. Also this helps reminding you if you forgot to update the resource file after a rename or such.

public static class EnumExtensions
{
    public static string GetDisplayName(this Enum e)
    {
        var rm = new ResourceManager(typeof (EnumResources));
        var resourceDisplayName = rm.GetString(e.GetType().Name + "_" + e);

        return string.IsNullOrWhiteSpace(resourceDisplayName) ? string.Format("[[{0}]]", e) : resourceDisplayName;
    }
}

The resource file looks like this: Resource file

Usage:

<div>@ContractStatus.Created.GetDisplayName()</div>

Solution 3 - C#

UPDATE 2019

Nowadays its just plain easy, setup your enum:

public enum ContactOptionType
{
    [Display(Description = "ContactOption1", ResourceType = typeof(Globalization.Contact))]
    Demo = 1,
    
    [Display(Description = "ContactOption2", ResourceType = typeof(Globalization.Contact))]
    Callback = 2,
    
    [Display(Description = "ContactOption3", ResourceType = typeof(Globalization.Contact))]
    Quotation = 3,
    
    [Display(Description = "ContactOption4", ResourceType = typeof(Globalization.Contact))]
    Other = 4
}

Each enum value gets a Display attribute with a Description value which is an entry in a resource assembly class called Globalization.Contact. This resource assembly (project) contains various translations for the different contact option types (Demo, Callback, Quotation, Other). It contains files like these: contact.nl.resx (for the Netherlands) and contact.resx (The default which is en-US) in which the different enum values have their localized values (translations).

Now in a static enum helper class we have this method:

public static string GetDisplayDescription(this Enum enumValue)
{
    return enumValue.GetType().GetMember(enumValue.ToString())
        .FirstOrDefault()?
        .GetCustomAttribute<DisplayAttribute>()
        .GetDescription() ?? "unknown";
}

This will get the value for the Description property of the Display attribute. Which will be the translated value if and only if the CurrentUICulture is set. This "glues" everything together.

Thread.CurrentThread.CurrentUICulture = new CultureInfo("en-US");

or

Thread.CurrentThread.CurrentUICulture = new CultureInfo("nl-NL");

Now in a simple Unit Test (XUnit) we can see if it works as expected / desired / designed:

[Theory]
[InlineData("nl-NL", "Terugbelverzoek")]
[InlineData("en-US", "Callback")]
public void TestTranslationOfDescriptionAttribute(string culture, string expectedValue)
{
    // Arrange
    CultureInfo cultureInfo = new CultureInfo(culture);
    Thread.CurrentThread.CurrentCulture = cultureInfo;
    Thread.CurrentThread.CurrentUICulture = cultureInfo;

    ContactOptionType contactOptionType = ContactOptionType.Callback;

    // Act
    string description = contactOptionType.GetDisplayDescription();

    // Assert
    Assert.Equal(expectedValue, description);
}

The above will succeed effortlessly ✅‍♂️

So this solution doesn't use a "complex" LocalizedAttribute anymore only a simple helper that gets the (translated) value of the Description property of the Display attribute. The presence of a ResourceType value in the Display attribute in combination with setting the CurrentUICulture does the trick.

Solution 4 - C#

There is a way of using attributes to specify a string to use for enums when displaying them, but we found it way too fiddly when you had to handle localization.

So what we usually do for enums that need to be localized is to write an extension class that provides a method to obtain the translated name. You can just use a switch that returns strings from the usual resources. That way, you provide translated strings for enums via the resources just like you do for other strings.

For example:

public enum Role
{
    Administrator,
    Moderator,
    Webmaster,
    Guest
}

public static class RoleExt
{
    public static string AsDisplayString(this Role role)
    {
        switch (role)
        {
            case Role.Administrator: return Resources.RoleAdministrator;
            case Role.Moderator:     return Resources.RoleModerator;
            case Role.Webmaster:     return Resources.RoleWebmaster;
            case Role.Guest:         return Resources.RoleGuest;

            default: throw new ArgumentOutOfRangeException("role");
        }
    }
}

Which you can use like this:

var role = Role.Administrator;
Console.WriteLine(role.AsDisplayString());

If you keep the RoleExt class implementation next to the enum Role implementation it will effectively become part of the interface for Role. Of course you could also add to this class any other useful extensions for the enum .

[EDIT]

If you want to handle multiple flags settings ("Administrator AND Moderator AND Webmaster") then you need to do things a little differently:

[Flags]
public enum Roles
{
    None          = 0,
    Administrator = 1,
    Moderator     = 2,
    Webmaster     = 4,
    Guest         = 8
}

public static class RolesExt
{
    public static string AsDisplayString(this Roles roles)
    {
        if (roles == 0)
            return Resources.RoleNone;

        var result = new StringBuilder();

        if ((roles & Roles.Administrator) != 0)
            result.Append(Resources.RoleAdministrator + " ");

        if ((roles & Roles.Moderator) != 0)
            result.Append(Resources.RoleModerator + " ");

        if ((roles & Roles.Webmaster) != 0)
            result.Append(Resources.RoleWebmaster + " ");

        if ((roles & Roles.Guest) != 0)
            result.Append(Resources.RoleGuest + " ");

        return result.ToString().TrimEnd();
    }
}

Which you might use like this:

Roles roles = Roles.Administrator | Roles.Guest | Roles.Moderator;
Console.WriteLine(roles.AsDisplayString());

Resource Files

Resource files are the way that you internationalize your strings. For more information on how to use them, see here:

http://msdn.microsoft.com/en-us/library/vstudio/aa992030%28v=vs.100%29.aspx http://msdn.microsoft.com/en-us/library/vstudio/756hydy4%28v=vs.100%29.aspx

Solution 5 - C#

A version of @eluxen's answer working for certain portable (PCL) libraries (specifically for Profile47) where original solution won't work. Two problems were addressed: DescriptionAttribute is not available in portable libraries, and problem reported by @Jitendra Pancholi with "Could not find any resources" error is solved

public class LocalizedDescriptionAttribute : Attribute
{
    private readonly string _resourceKey;
    private readonly Type _resourceType;
    public LocalizedDescriptionAttribute(string resourceKey, Type resourceType)
    {
        _resourceType = resourceType;
        _resourceKey = resourceKey;
    }

    public string Description
    {
        get
        {
            string displayName = String.Empty;
            ResourceManager resMan = _resourceType.GetProperty(
                @"ResourceManager", BindingFlags.Static | BindingFlags.Public | BindingFlags.NonPublic).GetValue(null, null) as ResourceManager;
            CultureInfo culture = _resourceType.GetProperty(
                    @"Culture", BindingFlags.Static | BindingFlags.Public | BindingFlags.NonPublic).GetValue(null, null) as CultureInfo;

            if (resMan != null)
            {
                displayName = resMan.GetString(_resourceKey, culture);
            }

            var ret = string.IsNullOrEmpty(displayName) ? string.Format("[[{0}]]", _resourceKey) : displayName;
            return ret;
        }
    }
}

For usage see the original answer. And if you are not encountering any problems, I would still use the original answer because it does not contain workarounds through reflection

Solution 6 - C#

You can use your enum value to do what you want.

public enum Roles
{
    Administrator = 0,
    Moderator = 1 ,
    Webmaster  = 2,
    Guest = 3 ,
    Etc.... = 4 
}

When you want to get the selected enum on the listbox, you retrieve the listbox item and then you retrieve the associated enum number.

Then you will convert that to an enum item like this

Roles myrol = (Roles) i

(i is associated int vale for this example)

Converting enum item to Integer and integer value back to enum item

 Enum Item to Integer----- 
    int i =  (int)Roles.Admin ;
    Integer to enum Itenm
    Roles r = (Roles)i ; 

     //Getting the name of the enum
     string role =  Role.Admin.ToString() 

IF you are adding to a Hashtable then you can do it this way

Hashtable h = new Hashtable() ; 
h.Items.Add((int)Roles.Admin , Roles.Admin.ToStrinng() ) ;
h.Items.Add((int)Roles.Local , Roles.Local.ToStrinng() ) ; 

when you pick an item from the hashtable , convert it back to Enum item and use it where you want. You can use the same way to populate Datatables / Comboboxes , dropdown lists and so on

Solution 7 - C#

The extension method of bellow it's worked to me.

    public static string GetDisplayValue(this Enum value)
    {
        try
        {
            var fieldInfo = value.GetType().GetField(value.ToString());
            var descriptionAttributes = fieldInfo.GetCustomAttributes(typeof(DisplayAttribute), false) as DisplayAttribute[];

            if (descriptionAttributes == null || descriptionAttributes.Length == 0) return value.ToString();

            if (descriptionAttributes[0].ResourceType != null)
            {
                var resource = descriptionAttributes[0].ResourceType.GetProperty("ResourceManager").GetValue(null) as ResourceManager;
                return resource.GetString(descriptionAttributes[0].Name);
            }
            else
            {
                return descriptionAttributes[0].Name;
            }
        }
        catch
        {
            return value.ToString();
        }
    }

I holpe helps.

Solution 8 - C#

One of the problems with translating/localizing enums is that not only do you have to translate them to show, but also parse the translations back to the enum value. The following C# file contains how I overcame the issues of two way translations of enums. Pardon the excessive comments, but I do get rather verbose on my creations.

//
// EnumExtensions.cs  
//
using System;
using System.Collections.Generic;

namespace EnumExtensionsLibrary
{
	/// <summary>
	/// The functions in this class use the localized strings in the resources
	/// to translate the enum value when output to the UI and reverse--
	/// translate when receiving input from the UI to store as the actual
	/// enum value.
	/// </summary>
	/// 
	/// <Note>
	/// Some of the exported functions assume that the ParserEnumLocalizationHolder
	/// and ToStringEnumLocalizationHolder dictionaries (maps) may contain the enum 
	/// types since they callthe Initialize methods with the input type before executing.
	/// </Note>
	public static class EnumExtensions
	{
		#region Exported methods
		/// <summary>
		/// Save resource from calling project so that we can look up enums as needed.
		/// </summary>
		/// <param name="resourceManager">Where we fish the translated strings from</param>
		/// <remarks>
		/// We do not have access to all of the resources from the other projects directly,
		/// so they must be loaded from the code from within the project.
		/// </remarks>
		public static void RegisterResource(System.Resources.ResourceManager resourceManager)
		{
			if (!MapOfResourceManagers.Contains(resourceManager))
				MapOfResourceManagers.Add(resourceManager);
		}

		/// <summary>
		/// Parses the localized string value of the enum by mapping it 
		/// to the saved enum value
		/// </summary>
		/// <remarks>
		/// In some cases, string for enums in the applications may not be translated to the
		/// localized version (usually when the program presets parameters).  If the enumMap
		/// doesn't contain the value string, we call to Enum.Parse() to handle the conversion
		/// or throw an exception.
		/// </remarks>
		/// <typeparam name="T"></typeparam>
		/// <param name="value"></param>
		/// <exception cref="ArgumentNullException"> enumType or value is null.</exception>
		/// <exception cref="ArgumentException"> enumType is not an Enum. value is either an 
		/// empty string or only contains white space, value is a name, but not one of the 
		/// named constants defined for the enumeration.</exception>
		/// <exception cref="ArgumentNullException">enumType or value is null.</exception>
		/// <returns>
		/// The enum value that matched the input string if found.  If not found, we call 
		/// Enum.Parse to handle the value.
		/// </returns>
		public static T ParseEnum<T>(this string value) where T : struct
		{
			ParserInitialize(typeof(T));
			var enumMap = ParserEnumLocalizationHolder[typeof(T)];
			if (enumMap.ContainsKey(value))
				return (T) enumMap[value];
			return (T)Enum.Parse(typeof(T), value); 
		}

		/// <summary>
		/// Parses the localized string value of the enum by mapping it 
		/// to the saved enum value.  
		/// </summary>
		/// <remarks>
		/// In some cases, string for enums in the applications may not be translated to the
		/// localized version (usually when the program presets parameters).  If the enumMap
		/// doesn't contain the value string, we call to Enum.TryParse() to handle the 
		/// conversion. and return.
		/// </remarks>
		/// <typeparam name="T"></typeparam>
		/// <param name="value"></param>
		/// <param name="result"></param>
		/// <returns>
		/// Returns true if the enum mapping contains the localized string value and the data 
		/// in the returned result parameter will be a valid value of that enum type. if the
		/// string value is not mapped, then calls Enum.TryParse to handle the conversion and 
		/// return result.
		/// </returns>
		public static bool TryParseEnum<T>(this string value, out T result) where T : struct
		{
			ParserInitialize(typeof(T));
			var enumMap = ParserEnumLocalizationHolder[typeof(T)];
			if (!enumMap.ContainsKey(value))
				return Enum.TryParse(value, out result);
			result = (T)enumMap[value];
			return true;
		}

		/// <summary>
		/// Converts the enum value to a localized string.
		/// </summary>
		/// <typeparam name="T">must be an enum to work</typeparam>
		/// <param name="value">is an enum</param>
		/// <returns>
		/// The localized string equivalent of the input enum value
		/// </returns>
		public static string EnumToString<T>(this T value) where T : struct
		{
			ToStringInitialize(typeof(T));
			var toStringMap = ToStringEnumLocalizationHolder[typeof(T)];
			return toStringMap.ContainsKey(value) ? toStringMap[value] : value.ToString();

			//return EnumDescription(value);
		}

		/// <summary>
		/// Gathers all of the localized translations for each 
		/// value of the input enum type into an array
		/// </summary>
		/// <remarks>
		/// The return array from Type.GetEnumValues(), the array elements are sorted by 
		/// the binary values (that is, the unsigned values) of the enumeration constants.
		/// </remarks>
		/// <param name="enumType"></param>
		/// <exception cref="ArgumentException"> The current type is not an enumeration.</exception>
		/// <returns>
		/// A string array with the localized strings representing
		/// each of the values of the input enumType.
		/// </returns>
		public static string[] AllDescription(this Type enumType)
		{
			ToStringInitialize(enumType);
			var descriptions = new List<string>();
			var values = enumType.GetEnumValues();
			var toStringMap = ToStringEnumLocalizationHolder[enumType];
			foreach (var value in values)
			{
				descriptions.Add(toStringMap.ContainsKey(value) ? toStringMap[value] : value.ToString());
			}
			return descriptions.ToArray();
		}
		#endregion

		#region Helper methods
		/// <summary>
		/// Translates an enum value into its localized string equivalent
		/// </summary>
		/// <remarks>
		/// This assumes that the "name" for the localized string in the 
		/// resources will look like "enum-type-name""value".  For example,  
		/// if I have an enum setup as:
		/// 
		///     enum Days {Sat, Sun, Mon, Tue, Wed, Thu, Fri};
		/// 
		/// the value "Sun" in the enum must have the name: "DaysSun"
		/// in the resources. The localized (translated) string will
		/// be in the value field.  E.g.,
		///
		///  <data name="DaysSun" xml:space="preserve">
		///	<value>Sunday</value>
		///  </data>	
		/// 
		/// 2nd note: there may be multiple resources to pull from.
		/// Will look in each resource until we find a match or 
		/// return null.
		/// </remarks>
		/// <typeparam name="T"></typeparam>
		/// <param name="enumType">the enum type</param>
		/// <param name="value">the specific enum value</param>
		/// <returns>
		/// If the enum value is found in the resources, then return 
		/// that string.  If not, then return null. 
		/// </returns>
		private static string LocalEnumDescription<T>(Type enumType, T value)
		{
			foreach (var resourceManager in MapOfResourceManagers)
			{
				// The following live line uses string interpolation to perform:
				//var rk = string.Format("{0}{1}", enumType.Name, value);
				var rk = $"{enumType.Name}{value}";

				// Given the above string formatting/interpolation, neither the enum.Name 
				// nor the value will have a '.' so we do not have to remove it.
				var result = resourceManager.GetString(rk);
				if (!string.IsNullOrEmpty(result))
					return result;
			}
			return null;
		}

		/// <summary>
		/// Initializes the mapping of the enum type to its mapping of localized strings to 
		/// the enum's values.
		/// </summary>
		/// <remarks>
		/// The reason for each enum type to have a mapping from the localized string back 
		/// to its values is for ParseEnum and TryParseEnum to quickly return a value rather
		/// than doing a lengthy loop comparing each value in the resources.
		/// 
		/// Also, we only map the corresponding resource string if it exists in the resources.
		/// If not in the resources, then we call the Enum methods Parse() and TryParse() to
		/// figure the results and throw the appropriate exception as needed.
		/// </remarks>
		/// 
		/// <param name="enumType"></param>
		private static void ParserInitialize(Type enumType)
		{
			if (!ParserEnumLocalizationHolder.ContainsKey(enumType))
			{
				var values = enumType.GetEnumValues();  // See remark for AllDescription().
				var enumMap = new Dictionary<string, object>();
				foreach (var value in values)
				{
					var description = LocalEnumDescription(enumType, value);
					if (description != null)
						enumMap[description] = value;
				}
				ParserEnumLocalizationHolder[enumType] = enumMap;
			}
		}

		/// <summary>
		/// Initializes the mapping of the enum type to its mapping of the enum's values
		/// to their localized strings.
		/// </summary>
		/// <remarks>
		/// The reason for each enum type to have a mapping from the localized string to its
		/// values is for AllDescription and EnumToString to quickly return a value rather 
		/// than doing a lengthy loop runing through each of the resources.
		/// 
		/// Also, we only map the corresponding resource string if it exists in the resources.
		/// See the EnumDescription method for more information.
		/// </remarks>
		/// 
		/// <param name="enumType"></param>
		private static void ToStringInitialize(Type enumType)
		{
			if (!ToStringEnumLocalizationHolder.ContainsKey(enumType))
			{
				var values = enumType.GetEnumValues();  // See remark for AllDescription().
				var enumMap = new Dictionary<object, string>();
				foreach (var value in values)
				{
					var description = LocalEnumDescription(enumType, value);
					if (description != null)
						enumMap[value] = description;
				}
				ToStringEnumLocalizationHolder[enumType] = enumMap;
			}
		}
		#endregion

		#region Data
		private static readonly List<System.Resources.ResourceManager> MapOfResourceManagers =
			new List<System.Resources.ResourceManager>();
		private static readonly Dictionary<Type, Dictionary<string, object>> ParserEnumLocalizationHolder =
			new Dictionary<Type, Dictionary<string, object>>();
		private static readonly Dictionary<Type, Dictionary<object, string>> ToStringEnumLocalizationHolder =
			new Dictionary<Type, Dictionary<object, string>>();
		#endregion
	}
}

This doesn't require an attribute ahead of each enum value but does require that the name attribute of your translated enum string in the resources is formatted such that it is a concatenation of the enum-type-name and enum value. See the comment above the LocalEnumDescription method for more information. In addition, it preserves the translations of the enums (both forwards and backwards) by mapping their translations such that we don't need to search for the translation each time we encounter an enum value.

Hopefully, it is easy enough to understand and use.

Solution 9 - C#

You could use Lexical.Localization¹ which allows embedding default value and culture specific values into the code, and be expanded in external localization files (like .json, .resx or .ini) for futher cultures.

namespace Library
{
    enum Permissions
    {
        Create = 1,
        Drop = 2,
        Modify = 4,
        GrantCreate = 8,
        GrantDrop = 16,
        GrantModify = 32
    }
}

In Program code:

// Load localization.ini
LineRoot.Builder.AddLocalizationFile("localization.ini").Build();
// Create key for enum
ILine key = LineRoot.Global.Assembly("ConsoleApp4").Type<Permissions>().Format("{0}");
// Print 
Console.WriteLine(key.Value(Permissions.Create | Permissions.Drop));
Console.WriteLine(key.Value(Permissions.Create | Permissions.Drop).Culture("en"));
Console.WriteLine(key.Value(Permissions.Create | Permissions.Drop).Culture("fi"));

localization.ini:

[Assembly:ConsoleApp4:Type:Library.Permissions:Culture:fi]
Key:Create = Luonti
Key:Drop = Poisto
Key:Modify = Muutos
Key:GrantCreate = Luonnin myöntö
Key:GrantDrop = Poiston myöntö
Key:GrantModify = Muutoksen myöntö

[Assembly:ConsoleApp4:Type:Library.Permissions:Culture:en]
Key:Create = Create
Key:Drop = Drop
Key:Modify = Modify
Key:GrantCreate = Grant Create
Key:GrantDrop = Grant Drop
Key:GrantModify = Grant Modify 

¹

Solution 10 - C#

Yet another possibility is to create a global display name storage as class extension over Enum class:

// Enum display names
public static class EnumDisplayNames {
  // Display name storage
  private static Dictionary<Type, Dictionary<Enum, String>> s_Names = 
    new Dictionary<Type, Dictionary<Enum, String>>();

  // Display name for the single enum's option
  private static String CoreAsDisplayName(Enum value) {
    Dictionary<Enum, String> dict = null;

    if (s_Names.TryGetValue(value.GetType(), out dict)) {
      String result = null;

      if (dict.TryGetValue(value, out result))
        return result;
      else
        return Enum.GetName(value.GetType(), value);
    }
    else
      return Enum.GetName(value.GetType(), value);
  }

  // Register new display name
  public static void RegisterDisplayName(this Enum value, String name) {
    Dictionary<Enum, String> dict = null;

    if (!s_Names.TryGetValue(value.GetType(), out dict)) {
      dict = new Dictionary<Enum, String>();

      s_Names.Add(value.GetType(), dict);
    }

    if (dict.ContainsKey(value))
      dict[value] = name;
    else
      dict.Add(value, name);
  }
  
  // Get display name
  public static String AsDisplayName(this Enum value) {
    Type tp = value.GetType();

    // If enum hasn't Flags attribute, just put vaue's name 
    if (Object.ReferenceEquals(null, Attribute.GetCustomAttribute(tp, typeof(FlagsAttribute))))
      return CoreAsDisplayName(value);

    // If enum has Flags attribute, enumerate all set options
    Array items = Enum.GetValues(tp);

    StringBuilder Sb = new StringBuilder();

    foreach (var it in items) {
      Enum item = (Enum) it;

      if (Object.Equals(item, Enum.ToObject(tp, 0)))
        continue;

      if (value.HasFlag(item)) {
        if (Sb.Length > 0)
          Sb.Append(", ");
        Sb.Append(CoreAsDisplayName(item));
      }
    }

    Sb.Insert(0, '[');

    Sb.Append(']');

    return Sb.ToString();
  }
}

Possible use is very simple, for instance:

  public enum TestEnum {
    None,
    One,
    Two,
    Three
  }

  [Flags]
  public enum TestOptions {
    None = 0,
    One = 1,
    Two = 2,
    Three = 4
  }

  ...

  // Let them be in German (for demonstration only)... 
  TestEnum.None.RegisterDisplayName("Nichts");
  TestEnum.One.RegisterDisplayName("Eins");
  TestEnum.Two.RegisterDisplayName("Zwei");
  TestEnum.Three.RegisterDisplayName("Drei");

  // Usually, you obtain display names from resources:
  // TestEnum.None.RegisterDisplayName(Resources.NoneName);
  // ...

  TestOptions.None.RegisterDisplayName("-");
  TestOptions.One.RegisterDisplayName("bit 0 set");
  TestOptions.Two.RegisterDisplayName("bit 1 set");
  TestOptions.Three.RegisterDisplayName("bit 2 set");
  TestOptions.Four.RegisterDisplayName("bit 3 set");

  ...

  TestEnum v = TestEnum.Two;
  String result = v.AsDisplayName(); // <- "Zwei"

  TestOptions o = TestOptions.One | TestOptions.Three | TestOptions.Four;
  String result2 = o.AsDisplayName(); // <- "[bit 0 set, bit 2 set, bit 3 set]"

Solution 11 - C#

public enum RoleEnum
{
    Administrator = 4,
    Official = 1,
    Trader = 3,
    HeadOfOffice = 2
}
public static class RoleEnumExtension
{
    private static readonly ResourceManager Resource =
        new ResourceManager("Project.CommonResource", typeof(CommonResource).Assembly);

    public static string Display(this RoleEnum role)
    {
        return Resource.GetString("RoleType_" + role);
    }
}

You can use this as

RoleEnum.Administrator.Display()

Hope this will help to someone

Solution 12 - C#

Same answer as accepted answer but without code analysis warnings

 [System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Design", "CA1019:DefineAccessorsForAttributeArguments", Justification ="Resourcetype is only needed to instantiate Resource manager, and ResourceManager is exposed")]
[AttributeUsage(AttributeTargets.All)]
public sealed class LocalizedDescriptionAttribute 
    : DescriptionAttribute
{
    private readonly string _resourceKey;
    private readonly ResourceManager _resourceManager;

    public LocalizedDescriptionAttribute(string resourceKey, Type resourceType)
    {
        _resourceManager = new ResourceManager(resourceType);
        _resourceKey = resourceKey;
    }

    public string ResourceKey
    {
        get { return _resourceKey; }
    }

    public ResourceManager ResourceManager
    {
        get { return _resourceManager; }
    }

    public override string Description
    {
        get
        {
            string displayName = _resourceManager.GetString(_resourceKey);
            return string.IsNullOrEmpty(displayName)? string.Format(CultureInfo.CurrentUICulture ,"[[{0}]]", _resourceKey) : displayName;
        }
    }
}

public static class EnumExtensions
{
    public static string GetDescription(this Enum enumValue)
    {
        if (enumValue == null)
        {
            throw new ArgumentNullException("enumValue");
        }
        FieldInfo fi = enumValue.GetType().GetField(enumValue.ToString());

        DescriptionAttribute[] attributes = (DescriptionAttribute[])fi.GetCustomAttributes(typeof(DescriptionAttribute), false);

        if (attributes != null && attributes.Length > 0)
        {
            return attributes[0].Description;
        }
        else
        {
            return enumValue.ToString();
        }
    }
}

Solution 13 - C#

The solutions above with the LocalizedDescriptionAttribute read it from the current language of the program. Perfect for a client, not so flexible for a server side when you want to pass the language as parameter.

So I extended eluxen solution with the LocalizedDescriptionAttribute by adding another method:

    /// <summary>
    /// Gets the description, stored in this attribute, reading from the resource using the cultureInfo defined by the language!
    /// </summary>
    /// <param name="language">The language.</param>
    /// <returns>Description for the given language if found; the default Description or ressourceKey otherwise</returns>
    public string GetDescription(string language)
    {
        return resource.GetStringFromResourceForLanguage(resourceKey, language, Description);
    }

    public static string GetStringFromResourceForLanguage(this ResourceManager resourceManager, string resourceKey, string language, string defaultValue = null)
    {
        if (string.IsNullOrEmpty(defaultValue))
            defaultValue = resourceKey;
        try
        {
            CultureInfo culture = CultureInfo.GetCultureInfo(language);
            string displayName = resourceManager.GetString(resourceKey, culture);
            return !string.IsNullOrEmpty(displayName) ? displayName : defaultValue;
        }
        catch // any, not only CultureNotFoundException
        {
            return defaultValue;
        }
    }

With the GetDescription extension also with the language parameter:

            bool hasLanguage = !string.IsNullOrEmpty(language);
            if (hasLanguage)
            {
                var attribute = (LocalizedDescriptionAttribute)Attribute.GetCustomAttribute(fieldInfo, typeof(LocalizedDescriptionAttribute));
                if (attribute != null)
                {
                    description = attribute.GetDescription(language);
                }
                else
                    hasLanguage = false;
            }
            if (!hasLanguage)
            {
                var attribute = (DescriptionAttribute)Attribute.GetCustomAttribute(fieldInfo, typeof(DescriptionAttribute));
                if (attribute != null)
                {
                    description = attribute.Description;
                }
            }

And eventually, I prefer to avoid any string in the attribue usage, using nameof.

public enum QualityPersonInfo
{
    Ok = 0,
    [LocalizedDescription(nameof(QualityStrings.P1), typeof(QualityStrings))]
    Duplicate = 1,
    [LocalizedDescription(nameof(QualityStrings.P2), typeof(QualityStrings))]
    IdMissing = 2,
}

which I use in my code as follow:

 QualityPersonInfo status = QualityPersonInfo.IdMissing; 
 var description = status.GetDescription("ch-DE");

Solution 14 - C#

I use this currently, hope it helps!:

    /// <summary>
    ///  Retrieves a translated value from an enumerated list.
    /// </summary>
    /// <param name="value">Enum</param>
    /// <param name="resource">string</param>
    /// <returns>string</returns>
    protected string GetTranslatedEnum(Enum value, string resource)
    {
        string path = String.Format("Resources.{0}", resource);

        ResourceManager resources = new ResourceManager(path, global::System.Reflection.Assembly.Load("App_GlobalResources"));

        if (resources != null) {
            return resources.GetString(value.ToString());
        } else {
            return value.ToString();
        }
    }

Created a .resx file named "App_GlobalResources\ProductNames.resx".

Usage:

// Convert the ProductId integer on the item to its Enum equivalent.
Products product = (Products) item.ProductId;

string productName = this.GetTranslatedEnum(product, "ProductNames");

Solution 15 - C#

I have used the accepted answer but changed it little bit. It is shorter and doesn't have custom class.

This is my enum. All items have DisplayAttribute

public enum OvertimeRequestedProvisionFor
{
    [Display(ResourceType = typeof(Localization), Name = LocalizationKeys.General_Fee)]
    Fee = 1,

    [Display(ResourceType = typeof(Localization), Name = LocalizationKeys.General_Permit)]
    Permit = 2,
}

And this is the extension method

public static string GetDisplayName(this Enum enumValue)
{
    var fi = enumValue.GetType().GetField(enumValue.ToString());

    var attributes = (DisplayAttribute[])fi.GetCustomAttributes(typeof(DisplayAttribute), false);

    return attributes != null && attributes.Length > 0
            ? attributes[0].GetName()
            : enumValue.ToString();
}

Now all have to do:

var localization = OvertimeRequestedProvisionFor.Fee.GetDisplayName();

Solution 16 - C#

isnt the answer to the question but if someone looking for get Enum by resource value (already traslated)...

    public static T GetEnumIntByResource<T>(string valueResource)
    {
        var enumType = typeof(T);
        var enumRet = enumType;

    if (enumType == typeof(Enum))
            throw new ArgumentException("typeof(TEnum) == System.Enum", "T");

        if (!(enumType.IsEnum))
            throw new ArgumentException(String.Format("typeof({0}).IsEnum == false", enumType), "T");

        var list = Enum.GetValues(enumType).OfType<T>().ToList();
            
        foreach(T value in list)
        {
            string traduccion = GetDisplayDescription(value as Enum);
            if(traduccion == valueResource)
            {
                return value;
            }
        }
        return default(T);
    }

Attributions

All content for this solution is sourced from the original question on Stackoverflow.

The content on this page is licensed under the Attribution-ShareAlike 4.0 International (CC BY-SA 4.0) license.

Content TypeOriginal AuthorOriginal Content on Stackoverflow
QuestionQuoterView Question on Stackoverflow
Solution 1 - C#eluxenView Answer on Stackoverflow
Solution 2 - C#discoView Answer on Stackoverflow
Solution 3 - C#Bernoulli ITView Answer on Stackoverflow
Solution 4 - C#Matthew WatsonView Answer on Stackoverflow
Solution 5 - C#avitenbergView Answer on Stackoverflow
Solution 6 - C#KasView Answer on Stackoverflow
Solution 7 - C#jmsandyView Answer on Stackoverflow
Solution 8 - C#Jim LoneroView Answer on Stackoverflow
Solution 9 - C#TagView Answer on Stackoverflow
Solution 10 - C#Dmitry BychenkoView Answer on Stackoverflow
Solution 11 - C#tech-gayanView Answer on Stackoverflow
Solution 12 - C#MartijnView Answer on Stackoverflow
Solution 13 - C#EricBDevView Answer on Stackoverflow
Solution 14 - C#Steve BaumanView Answer on Stackoverflow
Solution 15 - C#bafsarView Answer on Stackoverflow
Solution 16 - C#Martín FernandezView Answer on Stackoverflow