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...

Git - Update submodule

Sometimes in the large project when we separate it in different repositories we need to take reference of one repository in another where some the sub-module concepts. Now if we move our submodule to a different repository or renaming its repo-path then we've to also update the repository where this sub-module is getting referenced. Let's see how to update the git submodule.  Step-1: First clone the repo Step-2: Open git UI to create a new local branch from master  Step-3: Open git bash -- Now run below command to (remove submodules & add them):  -- Remove submodule git submodule deinit YOUR_FIRST_REPO git rm YOUR_FIRST_REPO git commit -m "Removed submodule YOUR_FIRST_REPO" rm -rf .git/modules/YOUR_FIRST_REPO -- Add submodule git submodule add <<..YOUR_FIRST_REPO git URL>> Step-4: All good, let's push our changes to the master

EFCore - Update command is not updating the underlying data

Why my update command using EFCore is not updating the underlying data in the database though in middle-tier code it's successful, not throwing any error? Let's try to get the root cause and how to solve this.  When creating the model class of related database object if the primary key name is Id then no need to explicitly mention the Key in ef-core OnModelCreating.  But if we've key name different from Id then we have to explicitly mention it in our OnModelCreating. Something like this:  entity.HasKey(c => new {c.CustId }); Assume in the database we've Customers table like this: CREATE TABLE [dbo].[Customers]( [CustId] [INT] IDENTITY(1,1) NOT NULL Primary Key, [FirstName] [VARCHAR](50) NULL ) Point to ponder: In the database table, column CustId is already defined as Primary key.  In EFCore model setup, it's up to us to configure the Key as (custId) or configure it as HasNoKey() Assume we've set our entity with Ha...