Skip to main content

CSharp - ENUM utility methods

During development sometimes we come across the situation to get the enum specification, means list of available Name, Value or attribute description (if available). 

 Here are the sample methods to get these enum details: (C# code example) 

        ///         /// Get all the values Description of this Enum
        ///         /// enum type
        /// 
        public static List GetDescrptionList() where TEnum : struct
        {
            if (!typeof(TEnum).IsEnum) { throw new ArgumentException("TEnum must be an enumerated type"); }

            var enumType = typeof(TEnum);
            var enumDescriptionList = new List();

            foreach (var value in Enum.GetValues(enumType))
            {
                var enumDescription = GetDescription((Enum)value);

                enumDescriptionList.Add(enumDescription);
            }

            return enumDescriptionList;
        }

        ///         /// Get the description field of this Enum value
        ///         /// Value of enum
        /// 
        public static string GetDescription(Enum value)
        {
            var fi = value.GetType().GetField(value.ToString());

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

            return attributes.Length > 0
                ? attributes[0].Description
                : value.ToString();
        }

        ///         /// Get list of values (1,2,3)
        ///         /// 
        /// 
        public static List GetValues() where TEnum : struct
        {
            if (!typeof(TEnum).IsEnum) { throw new ArgumentException("TEnum must be an enumerated type"); }

            var enumType = typeof(TEnum);
            var enumValues = new List();

            foreach (var value in Enum.GetValues(enumType))
            {
                enumValues.Add((int)value);
            }

            return enumValues;
        }

        ///         /// Get names of Enum (e.g.: Contract, Permanent, Intern...)
        ///         /// 
        /// 
        public static List GetNames() where TEnum : struct
        {
            if (!typeof(TEnum).IsEnum) { throw new ArgumentException("TEnum must be an enumerated type"); }

            var enumType = typeof(TEnum);
            return Enum.GetNames(enumType).ToList();
        }

        ///         /// Get the Name + Value pair list
        ///         /// 
        /// 
        public static List> GetNameValuePairs()
        {
            if (!typeof(TEnum).IsEnum) { throw new ArgumentException("TEnum must be an enumerated type"); }
            var enumType = typeof(TEnum);
            var enumNameDescriptionPair = new List>();

            foreach (var value in Enum.GetValues(enumType))
            {
                var intValue = (int)value;
                enumNameDescriptionPair.Add(new KeyValuePair(value.ToString(), intValue));
            }

            return enumNameDescriptionPair;
        }
    


Assume we've EmployeeTypes as enum like this:

    public enum EmployeeType
    {
        Permanent,
        Intern,

        [Description("Contract type employee")]
        Contract
    }
  

 Example to use this
  
   var desc = EnumUtilities.GetDescription(EmployeeType.Contract);
            // Result:
            //    Contract type employee            

   var names =  EnumUtilities.GetNames();
            // Result:
            //   Permanent
            //   Intern
            //   Contract

   var values = EnumUtilities.GetValues();
            // Result:
            //   0
            //   1
            //   2
  

Comments

Popular posts from this blog

EFCore - Collate function

Search in SQL server query is generally case insensitive (by default or based on database level collation). Suppose we have an employees table with a row having first-name column value as "My-First-Name", so if we want to do the case-sensitive search we have to explicitly use the related collate: In EF 5 (currently in Release Candidate version [RC.2.20475.6]) Collate function got introduced which helps us to use our specific collation based search.  C# with EF5 code sample: var employeeCaseSensitiveSearch = _dbContext.Employees .Where(x => EF.Functions.Collate(x.FirstName, "Latin1_General_CS_AS") == "my-first-name") .FirstOrDefault(); A related database query will be something like this: T-SQL: Case sensitive search (use specific collation e.g.: Latin1_General_CS_AS) SELECT * FROM dbo.Employees AS e WHERE e.FirstName Collate Latin1_General_CS_AS = 'my-first-name' Some of the useful CSharp function which g...

How to install Zen-coding plugin

As a web-developer, irrespective of the technologies (java, c-sharp, python, php e.t.c.…), we used to write CSS code to make our web-pages looks good if not at least we’re involved in write html codes. What if there is some tool to whom you give some instruction and that tool generates a good, well formatted html tags for you. These kind of coding is possible and known as “ Zen coding ” and there are lots of plug-in available from different vendors. We’re going to  discuss the steps to install this “zen-coding” plugin for “visual studio, eclipse, sublime-text & notepad++ in next few lines. Follow the below steps to install "zen-coding" plugin based on your editor.  Steps to install zen-coding plugin for (visual studio, eclipse, sublime-text,notepad++) -- -- For Visual Studio 1. Go to "Tools" -> "Extensions and Updates" 2. It'll open the "Extensions and Updates windows"    Select online form Left hand menu items ent...

EFCore - Scaffold-DbContext how to use

EFCore versions, we don't have GUI to manage the DB-entities & dbContext like we used to have with EF6 (or EF5/4 version). With EFCore we've the Scaffold-DbContext command which helps us to create entities & DB context from our DB-objects.  Let's see how to use Scaffold-DbContext: Assume we're connecting with SQL Server so after creating a sample project you'll have to install EFCore related libraries as mentioned below.  Install entity-framework-core for SQL Server, at this time 3.1.9 is the latest stable version   Microsoft.EntityFrameworkcore   Microsoft.EntityFrameworkCore.SqlServer  To use Scaffold-DbContext, following two NuGet packages are required Microsoft.EntityFrameworkCore.Tools  Microsoft.EntityFrameworkCore.Design Let's say we've two DB tables (e.g. dbo.Employees & dbo.Users )  Now let's see how to use Scaffold-DbContext to create c-...