簡介
在C#中提起控制元件繫結資料，大部分人首先想到的是WPF，其實Winform也支援控制元件和資料的繫結。
Winform中的資料繫結按控制元件型別可以分為以下幾種：
- 簡單控制元件繫結
- 列表控制元件繫結
- 表格控制元件繫結
繫結基類
繫結資料類必須實現INotifyPropertyChanged介面，否則資料類屬性的變更無法實時重新整理到介面，但可以從介面重新整理到類。
為了方便，我們設計一個繫結基類：
/// <summary>
/// 資料繫結基類
/// </summary>
public abstract class BindableBase : INotifyPropertyChanged
{
public event PropertyChangedEventHandler PropertyChanged;
protected bool SetProperty<T>(ref T field, T newValue, [CallerMemberName] string propertyName = null)
{
if (!EqualityComparer<T>.Default.Equals(field, newValue))
{
field = newValue;
PropertyChanged?.Invoke(this, new PropertyChangedEventArgs(propertyName));
return true;
}
return false;
}
}
需要繫結的資料類繼承繫結基類即可：
/// <summary>
/// 資料類
/// </summary>
public class Data : BindableBase
{
private int id = 0;
private string name = string.Empty;
public int ID { get => id; set => SetProperty(ref id, value); }
public string Name { get => name; set => SetProperty(ref name, value); }
}
功能擴充套件
主要為繫結基類擴充套件了以下兩個功能：
- 獲取屬性的Description特性內容
- 從指定類載入屬性值，物件直接賦值是賦值的引用，控制元件繫結的資料來源還是之前的物件
這兩個功能不屬於繫結基類的必要功能，但可以為繫結提供方便，所以單獨放在擴充套件方法類裡面。
程式碼如下：
/// <summary>
/// 資料繫結基類的擴充套件方法
/// </summary>
public static class BindableBaseExtension
{
/// <summary>
/// 獲取屬性的描述，返回元組格式為 Item1:描述資訊 Item2:屬性名稱
/// </summary>
/// <param name="type"></param>
/// <returns></returns>
public static Tuple<string, string>[] GetDescription(this BindableBase bindData)
{
var proAry = bindData.GetType().GetProperties();
var desAry = new Tuple<string, string>[proAry.Length];
string desStr;
for (int i = 0; i < proAry.Length; i++)
{
var attrs = (DescriptionAttribute[])proAry[i].GetCustomAttributes(typeof(DescriptionAttribute), false);
desStr = proAry[i].Name;
foreach (DescriptionAttribute attr in attrs)
{
desStr = attr.Description;
}
desAry[i] = Tuple.Create(desStr, proAry[i].Name);
}
return desAry;
}
/// <summary>
/// 載入同型別指定物件的屬性值，如果當前屬性值或目標屬性值為null則不執行賦值操作
/// </summary>
/// <param name="data"></param>
public static void Load(this BindableBase source, BindableBase dest)
{
if (source == null || dest == null)
{
//不執行操作
return;
}
Type type = source.GetType();
if (type != dest.GetType())
{
throw new ArgumentNullException("引數型別不一致");
}
var proAry = type.GetProperties();
for (int i = 0; i < proAry.Length; i++)
{
var proType = proAry[i].PropertyType;
if (proType.IsSubclassOf(typeof(BindableBase)))
{
//檢測到內部巢狀的繫結基類，建議不處理直接跳過，這種情況應該單獨處理內嵌物件的資料載入
//var childData = (BindableBase)(proAry[i].GetValue(source));
//childData.Load((BindableBase)(proAry[i].GetValue(dest)));
}
else
{
proAry[i].SetValue(source, proAry[i].GetValue(dest));
}
}
}
}
簡單控制元件繫結
簡單屬性繫結是指某物件屬性值和某控制元件屬性值之間的簡單繫結，需要了解以下內容：
- Control.DataBindings 屬性：代表控制元件的資料繫結的集合。
- Binding 類：代表某物件屬性值和某控制元件屬性值之間的簡單繫結。
使用方法如下：
Data data = new Data() { ID=1,Name="test"};
//常規繫結方法
textBox1.DataBindings.Add("Text", data, "ID");
//使用這種方式避免硬編碼
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是一個可用來建立雙向資料繫結機制的泛型集合，使用方法如下：
BindingList<Data> list = new BindingList<Data>();
list.Add(new Data() { ID = 1, Name = "name1" });
list.Add(new Data() { ID = 2, Name = "name2" });
comboBox1.DataSource = list;
comboBox1.ValueMember = "ID";
comboBox1.DisplayMember = "Name";
注：如果使用List泛型集合則不支援雙向繫結。同理，如果Data沒有繼承繫結基類，則屬性值的變更也不會實時更新到介面。
繫結DataTable表格
DataTable支援雙向繫結，使用方法如下：
DataTable dt = new DataTable();
DataColumn[] dcAry = new DataColumn[]
{
new DataColumn("ID"),
new DataColumn("Name")
};
dt.Columns.AddRange(dcAry);
dt.Rows.Add(1, "name1Dt");
dt.Rows.Add(2, "name2Dt");
comboBox1.DataSource = dt;
comboBox1.ValueMember = "ID";
comboBox1.DisplayMember = "Name";
繫結BindingSource源
BindingSource 類封裝窗體的資料來源，旨在簡化將控制元件繫結到基礎資料來源的過程，詳細內容可檢視 BindingSource 元件概述。
有時候資料型別可能沒有實現INotifyPropertyChanged介面，並且這個資料型別我們還修改不了，這種情況就只能使用BindingSource來將控制元件繫結到資料了。
假設Data類沒有繼承BindableBase，繫結方法如下：
List<Data> list = new List<Data>();
list.Add(new Data() { ID = 1, Name = "name1" });
list.Add(new Data() { ID = 2, Name = "name2" });
BindingSource bs = new BindingSource();
bs.DataSource = list;
comboBox1.DataSource = bs;
comboBox1.ValueMember = "ID";
comboBox1.DisplayMember = "Name";
關鍵是下面的步驟，改變集合內容時手動觸發變更：
//單項資料變更
list[0].Name = "test";
bs.ResetItem(0);
//新增資料項
list.Add(new Data() { ID = 3, Name = "name3" });
bs.ResetBindings(false);
//在BindingSource上新增或使用BindingList列表，則可以不用手動觸發變更通知
bs.Add(new Data() { ID = 4, Name = "name4" });
表格控制元件繫結
繫結DataTable
方法如下：
DataColumn c1 = new DataColumn("ID", typeof(string));
DataColumn c2 = new DataColumn("名稱", typeof(string));
dt.Columns.Add(c1);
dt.Columns.Add(c2);
dt.Rows.Add(11, 22);
//禁止新增行，防止顯示空白行
dataGridView1.AllowUserToAddRows = false;
//選擇是否自動建立列
dataGridView1.AutoGenerateColumns = true;
dataGridView1.DataSource = dt.DefaultView;
繫結BindingList
方法如下：
//填充資料
BindingList<Data> dataList = new BindingList<Data>();
for (int i = 0; i < 5; i++)
{
dataList.Add(new Data() { ID = i, Name = "Name" + i.ToString() });
}
//禁止新增行，防止顯示空白行
dataGridView1.AllowUserToAddRows = false;
//選擇是否自動建立列
dataGridView1.AutoGenerateColumns = false;
//手動建立列
var desAry = dataList[0].GetDescription();
int idx = 0;
foreach (var des in desAry)
{
idx = dataGridView1.Columns.Add($"column{idx}", des.Item1); // 手動新增某列
dataGridView1.Columns[idx].DataPropertyName = des.Item2; // 設定為某列的欄位
}
//繫結集合
dataGridView1.DataSource = dataList;
//集合變更事件
dataList.ListChanged += DataList_ListChanged;
注：上面的GetDescription()是繫結基類的擴充套件方法。
BindingList提供集合的變更通知，Data透過繼承繫結基類提供屬性值的變更通知。
UI執行緒全域性類
上面所有繫結的資料來源都不支援非UI執行緒的寫入，會引起不可預知的問題，運氣好的話也不會報異常出來。
為了方便多執行緒情況下更新資料來源，設計一個UIThread類封裝UI執行緒SynchronizationContext的Post、Send的操作，用來處理所有的UI更新操作，關於SynchronizationContext可以參考SynchronizationContext 綜述。
程式碼如下：
/// <summary>
/// UI執行緒全域性類
/// </summary>
public static class UIThread
{
private static SynchronizationContext context;
/// <summary>
/// 同步更新UI控制元件的屬性及繫結資料來源
/// </summary>
/// <param name="act"></param>
/// <param name="state"></param>
public static void Send(Action<object> act, object state)
{
context.Send(obj=> { act(obj); }, state);
}
/// <summary>
/// 同步更新UI控制元件的屬性及繫結資料來源
/// </summary>
/// <param name="act"></param>
public static void Send(Action act)
{
context.Send(obj => { act(); }, null);
}
/// <summary>
/// 非同步更新UI控制元件的屬性及繫結資料來源
/// </summary>
/// <param name="act"></param>
/// <param name="state"></param>
public static void Post(Action<object> act, object state)
{
context.Post(obj => { act(obj); }, state);
}
/// <summary>
/// 非同步更新UI控制元件的屬性及繫結資料來源
/// </summary>
/// <param name="act"></param>
public static void Post(Action act)
{
context.Post(obj => { act(); }, null);
}
/// <summary>
/// 在UI執行緒中初始化，只取第一次初始化時的同步上下文
/// </summary>
public static void Init()
{
if (context == null)
{
context = SynchronizationContext.Current;
}
}
}
直接在主介面的建構函式里面初始化即可：
UIThread.Init();
使用方法如下：
Task.Run(() =>
{
//同步更新UI
UIThread.Send(() => { dataList.RemoveAt(0); });
});