[WinForm] DataGridView 绑定 DT && ComboBox 列绑定 Dict

一  需求介绍

一般像枚举类型的数据，我们在数据库里存储着诸如（1、2、3、4…）或者（“001”、“002”、“003”…）此类，但是界面上我们想要显示的是具体的文本内容，以便用户理解使用。所以在从数据库中加载出来的数据 DataTable 绑定到 DataGridView 上时，就需要其中一些枚举列采用下拉框，并绑定对应的枚举数据源。

二  具体实现

首先，如果 DataGridView 的 AutoGenerateColumns 为 true 时，在绑定 DataTable 到 DataGridView 上时，会自动生成绑定数据中的各列，且默认均为普通的 DataGridViewTextBoxColumn 。所以如果要设置 DataGridView 中的下拉列，首先要把 AutoGenerateColumns 设置为 false。

/// <summary>
/// Sample
/// DataGridView绑定DataTable，ComboBox列绑定enum枚举
/// </summary>
public MainForm()
{
    InitializeComponent();

    DataTable dataTable = CreateDataTable();
    dataGridView.AutoGenerateColumns = true;// 默认设置
    dataGridView.DataSource = dataTable;
    // SetGridView(dataTable);
}

/// <summary>
/// 构建数据源
/// 可以从数据库读取出来构建DataTable数据源
/// </summary>
/// <returns>DataTable数据表</returns>
public DataTable CreateDataTable()
{
    DataTable dt = new DataTable();
    dt.Columns.Add(new DataColumn("Id", typeof(int)));
    dt.Columns.Add(new DataColumn("Name", typeof(string)));
    dt.Columns.Add(new DataColumn("EnumCol1", typeof(int)));
    dt.Columns.Add(new DataColumn("EnumCol2", typeof(string)));
    Random r = new Random();
    for (int i = 0; i < 50; i++)
    {
        DataRow dr = dt.NewRow();
        dr[0] = r.Next();
        dr[1] = "Name = " + r.Next();
        dr[2] = r.Next(1, 5);
        dr[3] = "EnumCol_" + r.Next(1, 5);
        dt.Rows.Add(dr);
    }

    return dt;
}

效果图(AutoGenerateColumns = true)：

    在将 AutoGenerateColumns 属性设置为 false 后，就要手动生成各列了。其中 EnumCol1 列要绑定一个枚举类型，EnumCol2 要绑定一个字典类型（Dictionary<string, string>）。

/// <summary>
/// 枚举1
/// </summary>
private enum EnumCol1
{
    A = 1,
    B = 2,
    C = 3,
    D = 4,
    E = 5
}
/// <summary>
/// 枚举转字典
/// </summary>
/// <typeparam name="T"></typeparam>
/// <param name="enumType"></param>
/// <returns></returns>
private Dictionary<int, string> EnumToDictionary(Type enumType)
{
    Dictionary<int, string> result = new Dictionary<int, string>();
    foreach (int key in Enum.GetValues(enumType))
    {
        string value = Enum.GetName(enumType, key);
        result.Add(key, value);
    }

    return result;
}

通过上面的代码中 EnumToDictionary 方法把枚举类型转换为字典类型，这样就可以统一处理数据绑定了。

/// <summary>
/// 设置DataGridView视图
/// </summary>
/// <param name="dt">数据源表</param>
public void SetGridView(DataTable dt)
{
    // 在放弃绑定时自动生成列，并且还未初始化DataGridView的列时
    // 手动生成各列
    if (!dataGridView.AutoGenerateColumns && dataGridView.Columns.Count == 0)
    {
        Dictionary<int, string> dic = EnumToDictionary(typeof(EnumCol1));
        foreach (DataColumn dc in dt.Columns)
        {
            string colName = dc.ColumnName;
            DataGridViewColumn dgvc = null;
            if (colName.StartsWith("EnumCol"))// 生成下拉列
            {
                dgvc = new DataGridViewComboBoxColumn();
                BindingSource bs = new BindingSource();
                if (colName.EndsWith("1"))// 绑定枚举1
                {
                    bs.DataSource = dic;
                    dgvc.ValueType = typeof(int);
                }
                else if (colName.EndsWith("2"))// 绑定枚举2
                {
                    bs.DataSource = new Dictionary<string, string>()
                    {
                        {"EnumCol_1", "AA"},
                        {"EnumCol_2", "BB"},
                        {"EnumCol_3", "CC"},
                        {"EnumCol_4", "DD"},
                        {"EnumCol_5", "EE"}
                    };
                    dgvc.ValueType = typeof(string);
                }
                ((DataGridViewComboBoxColumn)dgvc).DisplayMember = "Value";
                ((DataGridViewComboBoxColumn)dgvc).ValueMember = "Key";
                ((DataGridViewComboBoxColumn)dgvc).DataSource = bs;
                ((DataGridViewComboBoxColumn)dgvc).DisplayStyle = DataGridViewComboBoxDisplayStyle.Nothing;
                ((DataGridViewComboBoxColumn)dgvc).FlatStyle = FlatStyle.Flat;
            }
            else// 生成普通列
            {
                dgvc = new DataGridViewTextBoxColumn();
            }
            dgvc.Name = colName;
            dgvc.DataPropertyName = colName;// 保证该列的值绑定到DataTable中colName列上
            dataGridView.Columns.Add(dgvc);
        }
    }
}

在列类型为 DataGridViewComboBoxColumn，且要绑定字典数据源（Dictionary）时，需要通过 BindingSource 。即：

BindingSource bs = new BindingSource();
bs.DataSource = dic;
((DataGridViewComboBoxColumn)dgvc).DataSource = bs;

需要特别注意的是==>

48行代码：

dgvc.DataPropertyName = colName;  表示该下拉列的值绑定对应于数据源 DataTable 中 colName 列数据；

37行、38行代码：

((DataGridViewComboBoxColumn)dgvc).DisplayMember = "Value";

((DataGridViewComboBoxColumn)dgvc).ValueMember = "Key";

DisplayMember 是表示下拉框显示的值绑定于 dgvc 的数据源的某个位置（字典的Value）；

ValueMember 是表示下拉框实际值绑定于 dgvc 的数据源的某个位置（字典的Key）；

23行、35行代码：

dgvc.ValueType = typeof(int);

dgvc.ValueType = typeof(string);

这两句则是指定该列绑定数据源里该列的类型。此时，必须保证数据源 DataTable 里该列的值类型，必须和该列的 ValueMember 属性绑定的数据源类型一致。以文中例子，即 datagridview 的列 EnumCol1 和列 EnumCol2 的数据类型必须和所绑定的 Dictionary 的 Key 类型一致（因为 dgvc 的 ValueMember 属性绑定于 Key）。

效果图：

三  追加几句

1、SQLite 数据库中的 INTEGER 和 INT 类型区别需要通过“Tools –> Options –> Type Mappings”来确定。

但是实际上，其中 INT 类型是与C#的 Int32 对应，如果将 INTEGER 类型的列绑定到 Dictionary<int, string>上，是会报如下错误的：

2、本文以 DataGridViewComboBoxColumn 列绑定 Dictionary 字典数据源为例说明具体绑定细节，当然该类型列也可以绑定于 DataTable 等其他类型数据，只要设置好绑定细节就可以了。