Is there a way to convert an enum to a list that contains all the enum's options?
-
I think that if you are looking to do this, you might want to think if you really should be using an enum or if you should switch to an object that represents w/e your enum is.Bryan Rowe– Bryan Rowe2009-07-22 18:51:11 +00:00Commented Jul 22, 2009 at 18:51
-
4Strongly related questions: How do I enumerate an enum?, Can You Loop Through All Enum Values? (duplicate).Jeppe Stig Nielsen– Jeppe Stig Nielsen2013-05-07 05:54:40 +00:00Commented May 7, 2013 at 5:54
-
1Checking this answer may useful too: stackoverflow.com/a/12022617/1830909QMaster– QMaster2017-11-22 16:54:07 +00:00Commented Nov 22, 2017 at 16:54
14 Answers
This will return an IEnumerable<SomeEnum> of all the values of an Enum.
Enum.GetValues(typeof(SomeEnum)).Cast<SomeEnum>();
If you want that to be a List<SomeEnum>, just add .ToList() after .Cast<SomeEnum>().
To use the Cast function on an Array you need to have the System.Linq in your using section.
11 Comments
var array = Enum.GetValues(typeof(SomeEnum)).Cast<SomeEnum>().ToArray();Enum.GetValues returns an array already, so you just have to do var values = (SomeEnum[])Enum.GetValues(typeof(SomeEnum))Enum.GetValues(typeof(SomeEnum)).Cast<SomeEnum>().Cast<int>().ToList()Much easier way:
Enum.GetValues(typeof(SomeEnum))
.Cast<SomeEnum>()
.Select(v => v.ToString())
.ToList();
6 Comments
ToList() between Cast and Select? And how is that much easier than the accepted answer? It's identical to it, except you convert to string in the end.Enum.GetNames(typeof(System.Net.HttpStatusCode)) will get all the distinct names, whereas the method from the answer will get some strings duplicated (since v.ToString() will pick the same string representation for each duplicate underlying integer value). See System.Net.HttpStatusCode enum documentation.The short answer is, use:
(SomeEnum[])Enum.GetValues(typeof(SomeEnum))
If you need that for a local variable, it's var allSomeEnumValues = (SomeEnum[])Enum.GetValues(typeof(SomeEnum));.
Why is the syntax like this?!
The static method GetValues was introduced back in the old .NET 1.0 days. It returns a one-dimensional array of runtime type SomeEnum[]. But since it's a non-generic method (generics was not introduced until .NET 2.0), it can't declare its return type (compile-time return type) as such.
.NET arrays do have a kind of covariance, but because SomeEnum will be a value type, and because array type covariance does not work with value types, they couldn't even declare the return type as an object[] or Enum[]. (This is different from e.g. this overload of GetCustomAttributes from .NET 1.0 which has compile-time return type object[] but actually returns an array of type SomeAttribute[] where SomeAttribute is necessarily a reference type.)
Because of this, the .NET 1.0 method had to declare its return type as System.Array. But I guarantee you it is a SomeEnum[].
Everytime you call GetValues again with the same enum type, it will have to allocate a new array and copy the values into the new array. That's because arrays might be written to (modified) by the "consumer" of the method, so they have to make a new array to be sure the values are unchanged. .NET 1.0 didn't have good read-only collections.
If you need the list of all values many different places, consider calling GetValues just once and cache the result in read-only wrapper, for example like this:
public static readonly ReadOnlyCollection<SomeEnum> AllSomeEnumValues
= Array.AsReadOnly((SomeEnum[])Enum.GetValues(typeof(SomeEnum)));
Then you can use AllSomeEnumValues many times, and the same collection can be safely reused.
Why is it bad to use .Cast<SomeEnum>()?
A lot of other answers use .Cast<SomeEnum>(). The problem with this is that it uses the non-generic IEnumerable implementation of the Array class. This should have involved boxing each of the values into an System.Object box, and then using the Cast<> method to unbox all those values again. Luckily the .Cast<> method seems to check the runtime type of its IEnumerable parameter (the this parameter) before it starts iterating through the collection, so it isn't that bad after all. It turns out .Cast<> lets the same array instance through.
If you follow it by .ToArray() or .ToList(), as in:
Enum.GetValues(typeof(SomeEnum)).Cast<SomeEnum>().ToList() // DON'T do this
you have another problem: You create a new collection (array) when you call GetValues and then create yet a new collection (List<>) with the .ToList() call. So that's one (extra) redundant allocation of an entire collection to hold the values.
Update: Since .NET 5.0 (from 2020), the above information is obsolete; there is finally a generic method (generics having been introduced with .NET Framework 2.0 from the year 2005), so now you should simply use:
Enum.GetValues<SomeEnum>()
whose return parameter is strongly typed (as SomeEnum[]).
3 Comments
(SomeEnum[])Enum.GetValues(typeof(SomeEnum)) is also IEnumerable and IEnumerable<SomeEnum>, and it is IList and IList<SomeEnum> as well. But if you need to add or remove entries later, so that the length of the list changes, you can copy to a List<SomeEnum>, but that is not the most usual need.Enum.GetValue<T>().Here is the way I love, using LINQ:
public class EnumModel
{
public int Value { get; set; }
public string Name { get; set; }
}
public enum MyEnum
{
Name1=1,
Name2=2,
Name3=3
}
public class Test
{
List<EnumModel> enums = ((MyEnum[])Enum.GetValues(typeof(MyEnum))).Select(c => new EnumModel() { Value = (int)c, Name = c.ToString() }).ToList();
// A list of Names only, does away with the need of EnumModel
List<string> MyNames = ((MyEnum[])Enum.GetValues(typeof(MyEnum))).Select(c => c.ToString()).ToList();
// A list of Values only, does away with the need of EnumModel
List<int> myValues = ((MyEnum[])Enum.GetValues(typeof(MyEnum))).Select(c => (int)c).ToList();
// A dictionnary of <string,int>
Dictionary<string,int> myDic = ((MyEnum[])Enum.GetValues(typeof(MyEnum))).ToDictionary(k => k.ToString(), v => (int)v);
}
Hope it helps
5 Comments
((IEnumerable<EnumModel>)Enum.GetValues should be ((IEnumerable<MyEnum>)Enum.GetValuesList <SomeEnum> theList = Enum.GetValues(typeof(SomeEnum)).Cast<SomeEnum>().ToList();
1 Comment
very simple answer
Here is a property I use in one of my applications
public List<string> OperationModes
{
get
{
return Enum.GetNames(typeof(SomeENUM)).ToList();
}
}
1 Comment
I've always used to get a list of enum values like this:
Array list = Enum.GetValues(typeof (SomeEnum));
1 Comment
Here for usefulness... some code for getting the values into a list, which converts the enum into readable form for the text
public class KeyValuePair
{
public string Key { get; set; }
public string Name { get; set; }
public int Value { get; set; }
public static List<KeyValuePair> ListFrom<T>()
{
var array = (T[])(Enum.GetValues(typeof(T)).Cast<T>());
return array
.Select(a => new KeyValuePair
{
Key = a.ToString(),
Name = a.ToString().SplitCapitalizedWords(),
Value = Convert.ToInt32(a)
})
.OrderBy(kvp => kvp.Name)
.ToList();
}
}
.. and the supporting System.String extension method:
/// <summary>
/// Split a string on each occurrence of a capital (assumed to be a word)
/// e.g. MyBigToe returns "My Big Toe"
/// </summary>
public static string SplitCapitalizedWords(this string source)
{
if (String.IsNullOrEmpty(source)) return String.Empty;
var newText = new StringBuilder(source.Length * 2);
newText.Append(source[0]);
for (int i = 1; i < source.Length; i++)
{
if (char.IsUpper(source[i]))
newText.Append(' ');
newText.Append(source[i]);
}
return newText.ToString();
}
1 Comment
(T[])(Enum.GetValues(typeof(T)).Cast<T>()), looking carefully at the parentheses, we see that you actually cast the return value of Cast<T> to a T[]. That's quite confusing (and maybe surprising it will even work). Skip the Cast<T> call. See my new answer for details.public class NameValue
{
public string Name { get; set; }
public object Value { get; set; }
}
public class NameValue
{
public string Name { get; set; }
public object Value { get; set; }
}
public static List<NameValue> EnumToList<T>()
{
var array = (T[])(Enum.GetValues(typeof(T)).Cast<T>());
var array2 = Enum.GetNames(typeof(T)).ToArray<string>();
List<NameValue> lst = null;
for (int i = 0; i < array.Length; i++)
{
if (lst == null)
lst = new List<NameValue>();
string name = array2[i];
T value = array[i];
lst.Add(new NameValue { Name = name, Value = value });
}
return lst;
}
Convert Enum To a list more information available here.
1 Comment
T[] the return value of Cast<T> is unnecessarily confusing. See my recent answer.private List<SimpleLogType> GetLogType()
{
List<SimpleLogType> logList = new List<SimpleLogType>();
SimpleLogType internalLogType;
foreach (var logtype in Enum.GetValues(typeof(Log)))
{
internalLogType = new SimpleLogType();
internalLogType.Id = (int) (Log) Enum.Parse(typeof (Log), logtype.ToString(), true);
internalLogType.Name = (Log)Enum.Parse(typeof(Log), logtype.ToString(), true);
logList.Add(internalLogType);
}
return logList;
}
in top Code , Log is a Enum and SimpleLogType is a structure for logs .
public enum Log
{
None = 0,
Info = 1,
Warning = 8,
Error = 3
}
1 Comment
foreach variable has compile-time type object (written as var), but it really is a Log value (runtime type). There's no need to call ToString and then Enum.Parse. Start your foreach with this instead: foreach (var logtype in (Log[])Enum.GetValues(typeof(Log))) { ... }/// <summary>
/// Method return a read-only collection of the names of the constants in specified enum
/// </summary>
/// <returns></returns>
public static ReadOnlyCollection<string> GetNames()
{
return Enum.GetNames(typeof(T)).Cast<string>().ToList().AsReadOnly();
}
where T is a type of Enumeration; Add this:
using System.Collections.ObjectModel;
Comments
If you want Enum int as key and name as value, good if you storing the number to database and it is from Enum!
void Main()
{
ICollection<EnumValueDto> list = EnumValueDto.ConvertEnumToList<SearchDataType>();
foreach (var element in list)
{
Console.WriteLine(string.Format("Key: {0}; Value: {1}", element.Key, element.Value));
}
/* OUTPUT:
Key: 1; Value: Boolean
Key: 2; Value: DateTime
Key: 3; Value: Numeric
*/
}
public class EnumValueDto
{
public int Key { get; set; }
public string Value { get; set; }
public static ICollection<EnumValueDto> ConvertEnumToList<T>() where T : struct, IConvertible
{
if (!typeof(T).IsEnum)
{
throw new Exception("Type given T must be an Enum");
}
var result = Enum.GetValues(typeof(T))
.Cast<T>()
.Select(x => new EnumValueDto { Key = Convert.ToInt32(x),
Value = x.ToString(new CultureInfo("en")) })
.ToList()
.AsReadOnly();
return result;
}
}
public enum SearchDataType
{
Boolean = 1,
DateTime,
Numeric
}
Comments
You could use the following generic method:
public static List<T> GetItemsList<T>(this int enums) where T : struct, IConvertible
{
if (!typeof (T).IsEnum)
{
throw new Exception("Type given must be an Enum");
}
return (from int item in Enum.GetValues(typeof (T))
where (enums & item) == item
select (T) Enum.Parse(typeof (T), item.ToString(new CultureInfo("en")))).ToList();
}
3 Comments
int, then calls ToString with a weird culture on that int, then parses the string back to type T? Downvoted.