C#中通過反射將枚舉元素加載到ComboBo的實現方法

Posted on by

一、前言

       做過系統參數設置的同學們，肯定遇到過要提供一系列具有相同特點的選項供用戶選擇。最初級的做法是在窗體上增加一個下拉框控件，手工填寫Items選項。然後運行時可以下拉選擇。那如果有百八十個參數都是這種方式怎麼辦？

        上述做法弊端很明顯。那麼如何靈活的實現這個需求呢？

二、思路

        在代碼中定義枚舉類型，然後在窗體加載時，將枚舉類型的元素(描述信息)加載到下拉框中，這樣以後增加或修改瞭枚舉元素後，下拉框中時刻保持的是最新的數據。再運用上反射機制，多個下拉框可以復用同一個加載方法。代碼量會大幅度減少，同時可讀性和可維護性提高瞭許多。

三、上代碼

        1. 首先定義一個枚舉，例如：

using SharedBaseProject.Utils;
using System;
using System.Collections.Generic;
using System.ComponentModel;
using System.Linq;
using System.Reflection;
using System.Text;
using System.Threading.Tasks;
 
namespace SharedBaseProject.Common.CarPosition
{
    public class Direction
    {
        /// <summary>
        /// 方向
        /// </summary>
        public enum Enum_Direction
        {
            /// <summary>
            /// 默認值
            /// </summary>
            [Description("未指定")]
            None = -1,
            /// <summary>
            /// 上
            /// </summary>
            [Description("上")]
            Up = 0,
            /// <summary>
            /// 下
            /// </summary>
            [Description("下")]
            Down = 1,
            /// <summary>
            /// 左
            /// </summary>
            [Description("左")]
            Left = 2,
            /// <summary>
            /// 右
            /// </summary>
            [Description("右")]
            Right = 3
        }
 
    }
}

2. 引入模板方法，將枚舉轉換為List的代碼封裝為靜態方法：

using System;
using System.Collections.Generic;
using System.Text;
 
namespace SharedBaseProject.CustomType
{
    public class EnumberEntity
    {
        /// <summary>  
        /// 枚舉的描述  
        /// </summary>  
        public string Description { set; get; }
 
        /// <summary>  
        /// 枚舉名稱  
        /// </summary>  
        public string EnumName { set; get; }
 
        /// <summary>  
        /// 枚舉對象的值  
        /// </summary>  
        public int EnumValue { set; get; }
    }
}
using SharedBaseProject.CustomType;
using System;
using System.Collections.Generic;
using System.ComponentModel;
using System.Reflection;
 
namespace SharedBaseProject.Utils
{
    public class EnumUtil
    {
        /// <summary>
        /// 枚舉轉換為List
        /// </summary>
        /// <typeparam name="T"></typeparam>
        /// <param name="startValue">從哪個一個元素開始獲取</param>
        /// <returns></returns>
        public static List<EnumberEntity> EnumToList<T>(int startValue = 0)
        {
            List<EnumberEntity> list = new List<EnumberEntity>();
 
            foreach (var e in Enum.GetValues(typeof(T)))
            {
                if (Convert.ToInt32(e) < startValue)
                {
                    continue;
                }
 
                EnumberEntity m = new EnumberEntity();
                object[] objArr = e.GetType().GetField(e.ToString()).GetCustomAttributes(typeof(DescriptionAttribute), true);
                if (objArr != null && objArr.Length > 0)
                {
                    DescriptionAttribute da = objArr[0] as DescriptionAttribute;
                    m.Description = da.Description;
                }
                m.EnumValue = Convert.ToInt32(e);
                m.EnumName = e.ToString();
                list.Add(m);
            }
            return list;
        }
    }
}

3. 封裝一個方法，通過反射將獲取到的List賦予下拉框。

入參為下拉框、以及具體的枚舉類型：

        /// <summary>
        /// 加載下拉框選項
        /// </summary>
        private void loadComboBoxItems(ComboBox comboBox, Type type, int startValue = 0)
        {
            // Get the generic type definition
            MethodInfo method = typeof(EnumUtil).GetMethod("EnumToList", BindingFlags.Public | BindingFlags.Static);
 
            // Build a method with the specific type argument you're interested in
            method = method.MakeGenericMethod(type);
            // The "null" is because it's a static method
            List<EnumberEntity> listBaiduPositionMode = (List<EnumberEntity>)method.Invoke(null, new object[] { startValue });
            if (listBaiduPositionMode == null || listBaiduPositionMode.Count < 1)
            {
                return;
            }
 
            int iCount = listBaiduPositionMode.Count;
            for (int i = 0; i < iCount; i++)
            {
                comboBox.Items.Add(listBaiduPositionMode.ElementAt(i).Description);
            }
        }

4. 在窗體上設置一個下拉框，命名direction：

5. 調用，參數1為下拉框控件名稱，參數2的Enum_Direction為之前定義的枚舉類型： 

loadComboBoxItems(direction, typeof(Enum_Direction));

運行後效果如圖：

如果有多個類似參數，每個隻需一句代碼調用即可。怎麼樣，是不是很方便？

到此這篇關於C#中通過反射將枚舉元素加載到ComboBo的實現方法的文章就介紹到這瞭,更多相關C# 枚舉加載到ComboBo內容請搜索WalkonNet以前的文章或繼續瀏覽下面的相關文章希望大傢以後多多支持WalkonNet！

推薦閱讀：