SmartEnums 2.1.3-alpha

This is a prerelease version of SmartEnums.
There is a newer version of this package available.
See the version list below for details.
dotnet add package SmartEnums --version 2.1.3-alpha
NuGet\Install-Package SmartEnums -Version 2.1.3-alpha
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="SmartEnums" Version="2.1.3-alpha" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add SmartEnums --version 2.1.3-alpha
#r "nuget: SmartEnums, 2.1.3-alpha"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install SmartEnums as a Cake Addin
#addin nuget:?package=SmartEnums&version=2.1.3-alpha&prerelease

// Install SmartEnums as a Cake Tool
#tool nuget:?package=SmartEnums&version=2.1.3-alpha&prerelease


GitHub license NuGet Badge Lates release


SmartEnums is a simple library, written in C#.NET, which enables you to enhancing the capabilities of standard enum.


Either checkout this Github repository or install SmartEnums via NuGet Package Manager.

If you want to use NuGet just search for SmartEnums or run the following command in the NuGet Package Manager console:

PM> Install-Package SmartEnums


SmartEnums works on the basis of attributes, which means that now it becomes possible to store custom data for enumeration fields without resorting to writing classes.

Adding fields

First, let's describe the enumeration we want to work with:

public enum UserSubscription

Now using attribute

EnumValueAttribute(string key, object value)

adding custom information in enumeration:

public enum UserSubscription
    [EnumValue("Price", 169.0)]
    [EnumValue("Description", "One month subscribe")]
    [EnumValue("Subscribe period", 31)]
    [EnumValue("Price", 600.50)]
    [EnumValue("Description", "Six month subscribe")]
    [EnumValue("Subscribe period", 31 * 6)]
    [EnumValue("Price", 1000.0)]
    [EnumValue("Description", "One year subscribe")]
    [EnumValue("Subscribe period", 31 * 12)]
//I know that the date count is incorrect, I just gave an example that you can store any data

Now you add custom fields in enumeration.

An attribute can store expressions. It's means that you can hold simple value types, typeof() expressions and other enum.

public enum Gender
    [EnumValue("Description", "he/him")]
    [EnumValue("Description", "she/her")]

public enum TemplateUser
    [EnumValue("Age", 20)]
    [EnumValue("Gender", Gender.Male)]

    [EnumValue("Age", 25)]
    [EnumValue("Gender", Gender.Male)]

    [EnumValue("Age", 15)]
    [EnumValue("Gender", Gender.Female)]

Getting value

In order to get the value of a custom field, you need to use the extension method

public static T GetValueOf<T>(this Enum element, string key)

In order not to duplicate the code, let's take the enumeration declared above:

var age = TemplateUser.Claus.GetValueOf<int>("Age"); //return 25
var genderDescription = TemplateUser.Claus.GetValueOf<Gender>("Gender").GetValueOf<string>("Description"); //return "he/him"

And now you got values of custom attribute fields.

Attribute versions

You can add your versions for attributes using same attribute with string version parameter

public enum UserSubscription
    [EnumValue("Price", 169.0, "1.0.0")]
    [EnumValue("Price", 300.0, "2.0.0")]
    [EnumValue("Price", 169.0, "2.0.1")]
    [EnumValue("Price", 300.0, "3.0.0")]

Versions implemented just as string type and you can make your own versions. But must remember that versions use standard strings comparison.

Getting versioned value

In order to get the versioned value of a custom field, you need to use the same extension method like without version but add version parameter

public static T GetValueOf<T>(this Enum element, string key, string version)

and get needed versioned value:

var price = UserSubscription.OneMonth.GetValueOf<double>("Price", "1.0.0"); //return 169.0

If you use method GetValueOf<T> without version for field that has some versions it return value of newest version.

Also you can get newest versions using keyword implemented in config class.

There are two keywords for get newest versions:


If you need to get a specific version or newer, you can use the ^ sign at the beginning of the parameter.

With this knowledge, you can get the value for the desired version.

var priceLatest = UserSubscription.OneMonth.GetValueOf<double>("Price", "latest"); //return 300.0
var priceNewest = UserSubscription.OneMonth.GetValueOf<double>("Price", "newest"); //return 300.0
var price = UserSubscription.OneMonth.GetValueOf<double>("Price", "^2.0.0"); //return 300.0

Some more good features


By default, C# does not have an enumeration for enums. I suggest this big omission and added a method that implements this functionality.

public static IEnumerable<T> GetEnumerator<T>()

public enum Gender

var genders = SmartEnum.GetEnumerator<Gender>(); //return IEnumerable<Gender> [Male, Female]


Sometimes need get full information about used EnumValueAttribute in enum. For this situations you can get metadata of enum serialized to json or xml:

For get metadata in json format use next extension method:

public static string GetJsonMetadata(this Enum obj) 

For get metadata in xml format use next extansion method:

public static string GetXmlMetadata(this Enum obj)

That's all Folks!

Product Compatible and additional computed target framework versions.
.NET net6.0 is compatible.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.
  • net6.0

    • No dependencies.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
3.0.2 1,417 10/6/2022
3.0.0 532 3/17/2022
2.1.3 418 2/23/2022
2.1.3-alpha 145 2/23/2022
2.1.2 395 2/23/2022
2.1.1 417 1/20/2022
2.1.0 226 1/10/2022
2.0.0 231 1/6/2022
1.1.1 253 1/2/2022
1.1.0 244 1/2/2022

Fixed documentation