簡介 在C#中提起控制項綁定數據,大部分人首先想到的是WPF,其實Winform也支持控制項和數據的綁定。 Winform中的數據綁定按控制項類型可以分為以下幾種: 簡單控制項綁定 列表控制項綁定 表格控制項綁定 綁定基類 綁定數據類必須實現INotifyPropertyChanged介面,否則數據類屬性的變更 ...
目錄
簡介
在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); });
});