Winform控件绑定数据

目录

• 简介
  
• 绑定基类
  
  
  
  • 功能扩展
    
  
  
• 简单控件绑定
  
• 列表控件绑定
  
  
  
  • 绑定BindingList集合
    
  • 绑定DataTable表格
    
  • 绑定BindingSource源
    
  
  
• 表格控件绑定
  
  
  
  • 绑定DataTable
    
  • 绑定BindingList
    
  
  
• UI线程全局类
  

简介

在C#中提起控件绑定数据，大部分人首先想到的是WPF，其实Winform也支持控件和数据的绑定。
Winform中的数据绑定按控件类型可以分为以下几种：

• 简单控件绑定
  
• 列表控件绑定
  
• 表格控件绑定
  

绑定基类

绑定数据类必须实现INotifyPropertyChanged接口，否则数据类属性的变更无法实时刷新到界面，但可以从界面刷新到类。
为了方便，我们设计一个绑定基类：

1. /// <summary>
2. /// 数据绑定基类
3. /// </summary>
4. public abstract class BindableBase : INotifyPropertyChanged
5. {
6.     public event PropertyChangedEventHandler PropertyChanged;
7.     protected bool SetProperty<T>(ref T field, T newValue, [CallerMemberName] string propertyName = null)
8.     {
9.         if (!EqualityComparer<T>.Default.Equals(field, newValue))
10.         {
11.             field = newValue;
12.             PropertyChanged?.Invoke(this, new PropertyChangedEventArgs(propertyName));
13.             return true;
14.         }
15.         return false;
16.     }
17. }

复制代码

需要绑定的数据类继承绑定基类即可：

1. /// <summary>
2. /// 数据类
3. /// </summary>
4. public class Data : BindableBase
5. {
6.     private int id = 0;
7.     private string name = string.Empty;
9.     public int ID      { get => id;   set => SetProperty(ref id, value); }
10.     public string Name { get => name; set => SetProperty(ref name, value); }
11. }

复制代码

功能扩展

主要为绑定基类扩展了以下两个功能：

• 获取属性的Description特性内容
  
• 从指定类加载属性值，对象直接赋值是赋值的引用，控件绑定的数据源还是之前的对象
  

这两个功能不属于绑定基类的必要功能，但可以为绑定提供方便，所以单独放在扩展方法类里面。
代码如下：

1. /// <summary>
2. /// 数据绑定基类的扩展方法
3. /// </summary>
4. public static class BindableBaseExtension
5. {
6.    
7.     /// <summary>
8.     /// 获取属性的描述，返回元组格式为 Item1:描述信息 Item2:属性名称
9.     /// </summary>
10.     /// <param name="type"></param>
11.     /// <returns></returns>
12.     public static Tuple<string, string>[] GetDescription(this BindableBase bindData)
13.     {
14.         var proAry = bindData.GetType().GetProperties();
15.         var desAry = new Tuple<string, string>[proAry.Length];
16.         string desStr;
17.         for (int i = 0; i < proAry.Length; i++)
18.         {
19.             var attrs = (DescriptionAttribute[])proAry[i].GetCustomAttributes(typeof(DescriptionAttribute), false);
20.             desStr = proAry[i].Name;
21.             foreach (DescriptionAttribute attr in attrs)
22.             {
23.                 desStr = attr.Description;
24.             }
25.             desAry[i] = Tuple.Create(desStr, proAry[i].Name);
26.         }
27.         return desAry;
28.     }
31.     /// <summary>
32.     /// 加载同类型指定对象的属性值，如果当前属性值或目标属性值为null则不执行赋值操作
33.     /// </summary>
34.     /// <param name="data"></param>
35.     public static void Load(this BindableBase source, BindableBase dest)
36.     {
38.         if (source == null || dest == null)
39.         {
40.             //不执行操作
41.             return;
42.         }
43.         Type type = source.GetType();
44.         if (type != dest.GetType())
45.         {
46.             throw new ArgumentNullException("参数类型不一致");
47.         }
48.         var proAry = type.GetProperties();
49.         for (int i = 0; i < proAry.Length; i++)
50.         {
51.             var proType = proAry[i].PropertyType;
52.            
53.             if (proType.IsSubclassOf(typeof(BindableBase)))
54.             {
55.                 //检测到内部嵌套的绑定基类，建议不处理直接跳过，这种情况应该单独处理内嵌对象的数据加载
56.                 //var childData = (BindableBase)(proAry[i].GetValue(source));
57.                 //childData.Load((BindableBase)(proAry[i].GetValue(dest)));
58.             }
59.             else
60.             {
61.                 proAry[i].SetValue(source, proAry[i].GetValue(dest));
62.             }
63.         }
64.     }
65. }

复制代码

简单控件绑定

简单属性绑定是指某对象属性值和某控件属性值之间的简单绑定，需要了解以下内容：

• Control.DataBindings 属性：代表控件的数据绑定的集合。
  
• Binding 类：代表某对象属性值和某控件属性值之间的简单绑定。
  

使用方法如下：

1. Data data = new Data() { ID=1,Name="test"};
2. //常规绑定方法        
3. textBox1.DataBindings.Add("Text", data, "ID");
4. //使用这种方式避免硬编码
5. textBox2.DataBindings.Add("Text", data, nameof(data.Name));

复制代码

注：这种绑定会自动处理字符串到数据的类型转换，转换失败会自动恢复原值。
列表控件绑定

列表控件绑定主要用于 ListBox 与 ComboBox 控件，它们都属于 ListControl 类的派生类。ListControl 类为 ListBox 类和 ComboBox 类提供一个共同的成员实现方法。
注：CheckedListBox 类派生于 ListBox 类，不再单独说明。
使用列表控件绑定前，需要了解以下内容：

• ListControl.DataSource 属性：获取或设置此 ListControl 的数据源，值为实现 IList 或 IListSource 接口的对象，如 DataSet 或 Array。
  
• ListControl.DisplayMember 属性：获取或设置要为此 ListControl 显示的属性，指定 DataSource 属性指定的集合中包含的对象属性的名称，默认值为空字符串("")。
  
• ListControl.ValueMember 属性：获取或设置属性的路径，它将用作 ListControl 中的项的实际值，表示 DataSource 属性值的单个属性名称，或解析为最终数据绑定对象的属性名、单个属性名或句点分隔的属性名层次结构, 默认值为空字符串("")。
  

注：最终的选中值只能通过ListControl.SelectedValue 属性获取，目前还没找到可以绑定到数据的方法。
绑定BindingList集合

BindingList是一个可用来创建双向数据绑定机制的泛型集合，使用方法如下：

1. BindingList<Data> list = new BindingList<Data>();
2. list.Add(new Data() { ID = 1, Name = "name1" });
3. list.Add(new Data() { ID = 2, Name = "name2" });
5. comboBox1.DataSource = list;
6. comboBox1.ValueMember = "ID";
7. comboBox1.DisplayMember = "Name";

复制代码

注：如果使用List泛型集合则不支持双向绑定。同理，如果Data没有继承绑定基类，则属性值的变更也不会实时更新到界面。
绑定DataTable表格

DataTable支持双向绑定，使用方法如下：

1. DataTable dt = new DataTable();
2. DataColumn[] dcAry = new DataColumn[]
3. {
4.     new DataColumn("ID"),
5.     new DataColumn("Name")
6. };
7. dt.Columns.AddRange(dcAry);
8. dt.Rows.Add(1, "name1Dt");
9. dt.Rows.Add(2, "name2Dt");
11. comboBox1.DataSource = dt;
12. comboBox1.ValueMember = "ID";
13. comboBox1.DisplayMember = "Name";

复制代码

绑定BindingSource源

BindingSource 类封装窗体的数据源，旨在简化将控件绑定到基础数据源的过程，详细内容可查看 BindingSource 组件概述。
有时候数据类型可能没有实现INotifyPropertyChanged接口，并且这个数据类型我们还修改不了，这种情况就只能使用BindingSource来将控件绑定到数据了。
假设Data类没有继承BindableBase，绑定方法如下：

1. List<Data> list = new List<Data>();            
2. list.Add(new Data() { ID = 1, Name = "name1" });
3. list.Add(new Data() { ID = 2, Name = "name2" });
5. BindingSource bs = new BindingSource();
6. bs.DataSource = list;
7. comboBox1.DataSource = bs;
8. comboBox1.ValueMember = "ID";
9. comboBox1.DisplayMember = "Name";

复制代码

关键是下面的步骤，改变集合内容时手动触发变更：

1. //单项数据变更
2. list[0].Name = "test";
3. bs.ResetItem(0);
5. //添加数据项
6. list.Add(new Data() { ID = 3, Name = "name3" });
7. bs.ResetBindings(false);
8. //在BindingSource上添加或使用BindingList列表，则可以不用手动触发变更通知
9. bs.Add(new Data() { ID = 4, Name = "name4" });

复制代码

表格控件绑定

绑定DataTable

方法如下：

1. DataColumn c1 = new DataColumn("ID", typeof(string));
2. DataColumn c2 = new DataColumn("名称", typeof(string));
3. dt.Columns.Add(c1);
4. dt.Columns.Add(c2);
5. dt.Rows.Add(11, 22);
7. //禁止添加行，防止显示空白行
8. dataGridView1.AllowUserToAddRows = false;
9. //选择是否自动创建列
10. dataGridView1.AutoGenerateColumns = true;
12. dataGridView1.DataSource = dt.DefaultView;

复制代码

绑定BindingList

方法如下：

1. //填充数据
2. BindingList<Data> dataList = new BindingList<Data>();
3. for (int i = 0; i < 5; i++)
4. {
5.      dataList.Add(new Data() { ID = i, Name = "Name" + i.ToString() });
6. }
9. //禁止添加行，防止显示空白行
10. dataGridView1.AllowUserToAddRows = false;
11. //选择是否自动创建列
12. dataGridView1.AutoGenerateColumns = false;
13. //手动创建列
14. var desAry = dataList[0].GetDescription();
15. int idx = 0;
16. foreach (var des in desAry)
17. {
18.      idx = dataGridView1.Columns.Add($"column{idx}", des.Item1);     // 手动添加某列
19.      dataGridView1.Columns[idx].DataPropertyName = des.Item2;        // 设置为某列的字段
20. }
21. //绑定集合
22. dataGridView1.DataSource = dataList;
23. //集合变更事件
24. dataList.ListChanged += DataList_ListChanged;

复制代码

注：上面的GetDescription()是绑定基类的扩展方法。
BindingList提供集合的变更通知，Data通过继承绑定基类提供属性值的变更通知。
UI线程全局类

上面所有绑定的数据源都不支持非UI线程的写入，会引起不可预知的问题，运气好的话也不会报异常出来。
为了方便多线程情况下更新数据源，设计一个UIThread类封装UI线程SynchronizationContext的Post、Send的操作，用来处理所有的UI更新操作，关于SynchronizationContext可以参考SynchronizationContext 综述。
代码如下：

1. /// <summary>
2. /// UI线程全局类
3. /// </summary>
4. public static class UIThread
5. {
6.     private static SynchronizationContext context;
9.     /// <summary>
10.     /// 同步更新UI控件的属性及绑定数据源
11.     /// </summary>
12.     /// <param name="act"></param>
13.     /// <param name="state"></param>
14.     public static void Send(Action<object> act, object state)
15.     {
16.         context.Send(obj=> { act(obj); }, state);
17.     }
19.     /// <summary>
20.     /// 同步更新UI控件的属性及绑定数据源
21.     /// </summary>
22.     /// <param name="act"></param>
23.     public static void Send(Action act)
24.     {
25.         context.Send(obj => { act(); }, null);
26.     }
28.     /// <summary>
29.     /// 异步更新UI控件的属性及绑定数据源
30.     /// </summary>
31.     /// <param name="act"></param>
32.     /// <param name="state"></param>
33.     public static void Post(Action<object> act, object state)
34.     {
35.         context.Post(obj => { act(obj); }, state);
36.     }
38.     /// <summary>
39.     /// 异步更新UI控件的属性及绑定数据源
40.     /// </summary>
41.     /// <param name="act"></param>
42.     public static void Post(Action act)
43.     {
44.         context.Post(obj => { act(); }, null);
45.     }
48.     /// <summary>
49.     /// 在UI线程中初始化，只取第一次初始化时的同步上下文
50.     /// </summary>
51.     public static void Init()
52.     {
53.         if (context == null)
54.         {
55.             context = SynchronizationContext.Current;
56.         }
57.     }
58. }

复制代码

直接在主界面的构造函数里面初始化即可：

1. UIThread.Init();

复制代码

使用方法如下：

1. Task.Run(() =>
2. {
3.     //同步更新UI
4.     UIThread.Send(() => { dataList.RemoveAt(0); });
5. });

复制代码

免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！