超简单的枚举类型与ComboBox动态关联方法

需求

在C#项目中，经常会有枚举型与ComboBox进行关联的需求。这样的需求如果使用字符串来处理，则每次都要转换比较麻烦。本文给出了一种基于泛型的窗体数据动态绑定与读取的方法，从而能够在大部分情况下可以一劳永逸地解决问题。

示例

为了便于读者快速上手，我们先看一个示例，然后再给出定义的源代码。
以下枚举型为示例。显示窗体为默认Form1，然后在上面添加一个ComboBox对象comboBox1。

 public enum LogType
 {
     Debug,
     Info,
     Warning,
     Error,
 }

绑定方法及结果

绑定时，只需要以下一行代码。

// 将LogType与comboBox1绑定
BindEnumToComboBox<LogType>(comboBox1);

显示效果如下所示。

获取值

当我们需要获取用户选择的值只，只需要调用以下代码即可。

LogType lt = GetEnumFromComboBox<LogType>(comboBox1);

如果类型错误，则返回缺省值。

设置值

如果需要使用LogType的值对对ComboBox设置指定的值，可以使用以下函数。

SetEnumInComboBox(comboBox1, LogType.Info);

函数定义

主要提供了三个函数

• 绑定：初始化时使用，用于将枚举型与指定的ComboBox绑定
• 读取：用于从ComboBox中读取相应的枚举值
• 设置：用于将指定的枚举值设置至ComboBox中。

主要定义如下所示。

/// <summary>
/// 将指定的枚举型绑定至指定的ComboBox，结果表示是否绑定成功。
/// 用法示例：Bind<LogType>(comboBox1);
/// </summary>
/// <param name="cb">下拉框。</param>
/// <param name="type">枚举类型。</param>
/// <returns></returns>
public static bool BindEnumToComboBox<T>(ComboBox cb)
{
    Type type = typeof(T);
    if (!type.IsEnum || Enum.GetValues(type).Length == 0 || cb == null)
        return false;

    cb.Items.Clear();
    foreach (var item in Enum.GetValues(type))
    {
        cb.Items.Add(item.ToString());
    }

    // 默认选择第0项。
    cb.SelectedIndex = 0;
    // 这里不是必需的，但是由于枚举型不能有额外的，所以设置为 DrawDownList.
    cb.DropDownStyle = ComboBoxStyle.DropDownList;

    return true;
}



/// <summary>
/// 根据ComboBox的选定字符串，返回指定的枚举类型。如果转换失败，则返回缺少值。
/// 用法示例：LogType lt = GetEnumFromComboBox<LogType>(comboBox1);
/// </summary>
/// <typeparam name="T"></typeparam>
/// <param name="cb"></param>
/// <returns></returns>
public static T GetEnumFromComboBox<T>(ComboBox cb)
{
    T t = default(T); // 先初始化的默认值。
    try
    {
        t = (T)Enum.Parse(typeof(T), cb.SelectedItem.ToString()); // 进行类型转换。
    } catch (Exception ex) {
        Console.WriteLine(ex.Message); // 可以根据需要做相应的异常处理。 
    }

    return t;
}

/// <summary>
/// 根据枚举型值，在ComboBox中选择相应的选项。
/// 用法示例：SetEnumInComboBox(comboBox1, LogType.Info);
/// </summary>
/// <typeparam name="T"></typeparam>
/// <param name="cb"></param>
/// <returns></returns>
public static void SetEnumInComboBox(ComboBox cb, object value)
{
    cb.Text = value?.ToString();
}

总结

通过使用自动化的绑定，能够使代码的编写更加简易强壮。我们只需要简单的调用这两个函数即可实现相应的功能。同时，如果枚举类型发生变化，客户端不需要做任何变化，即可自动实现新的变更后的内容的改变。