在Winform開發中中，我們為了方便客戶選擇，往往使用系統的字典數據選擇，畢竟選擇總比輸入來的快捷、統一，一般我們都會簡單封裝一下，以便方便對控件的字典值進行展示處理，本文介紹DevExpress控件的幾種常見的字典綁定展示方式，希望我們在實際WinForm項目中使用到。

DevExpress WinForms能完美構建流暢、美觀且易于使用的應用程序，無論是Office風格的界面，還是分析處理大批量的業務數據，它都能輕松勝任！

常規下拉列表的處理

常規的處理方式，可能會使用ComboBoxEdit 控件來承載下拉列表，下拉列表的值可以是固定的列表，也可以來自字典的方式，具體根據實際情況而定，大概的效果如下所示。

單擊下拉列表，會展示一些常規的字典項目，如下效果所示。

如果使用控件原始方式，我們綁定控件的下拉列表值的做法如下所示。

combo.Properties.BeginUpdate();//可以加快
combo.Properties.Items.Clear();
combo.Properties.Items.AddRange(itemList);
combo.Properties.EndUpdate();//可以加快

不過我們一般傾向于高效率的界面處理，一般會編寫各類型的界面控件的擴展函數用于快速處理。

不同類型的控件我們用一個獨立的擴展文件來處理，這樣方便維護的同時，也方便借鑒完善。

例如對于上面的控件，我們的綁定方法的擴展函數如下所示。

/// <summary>
/// 綁定下拉列表控件為指定的數據字典列表
/// </summary>
/// <param name="combo">下拉列表控件</param>
/// <param name="itemList">數據字典列表</param>
/// <param name="defaultValue">控件默認值</param>
/// <param name="emptyFlag">是否加入空值選項</param>
public static void BindDictItems(this ComboBoxEdit combo, List<CListItem> itemList, string defaultValue, bool emptyFlag = true)
{
combo.Properties.BeginUpdate();//可以加快
combo.Properties.Items.Clear();
combo.Properties.Items.AddRange(itemList);
if (emptyFlag)
{
combo.Properties.Items.Insert(0, new CListItem(""));
}

if (itemList.Count > 0)
{
if (!string.IsNullOrEmpty(defaultValue))
{
combo.SetComboBoxItem(defaultValue);
}
else
{
combo.SelectedIndex = 0;
}
}

combo.Properties.EndUpdate();//可以加快
}

其中方法增加了一些默認值以及是否追加空白項目的處理。

當然，我們為了適應各種數據源的綁定方式，我們重載了很多不同的函數處理，如下截圖所示。

當然對于其他同類型的下列列表控件也是這樣處理即可。這樣界面上，我們就可以指定調用綁定的處理操作了。

private void InitDictItem()
{
this.txtManufacture.Items.Clear();
this.txtManufacture.Items.AddRange(DictItemUtil.GetDictByDictType("供貨商"));

this.txtBigType.Items.Clear();
this.txtBigType.Items.AddRange(DictItemUtil.GetDictByDictType("備件屬類"));
}

或者，我們可以根據字典的類型，來進一步做一個擴展函數，來簡化綁定的處理。

/// <summary>
/// 綁定下拉列表控件為指定的數據字典列表
/// </summary>
/// <param name="control">下拉列表控件</param>
/// <param name="dictTypeName">數據字典類型名稱</param>
/// <param name="defaultValue">控件默認值</param>
/// <param name="emptyFlag">是否添加空行</param>
public static void BindDictItems(this ComboBoxEdit control, string dictTypeName, string defaultValue, bool emptyFlag = true)
{
Dictionary<string, string> dict = BLLFactory<DictData>.Instance.GetDictByDictType(dictTypeName);
List<CListItem> itemList = new List<CListItem>();
foreach (string key in dict.Keys)
{
itemList.Add(new CListItem(key, dict[key]));
}

control.BindDictItems(itemList, defaultValue, emptyFlag);
}

使用了這些簡化的擴展函數，我們可以對系統的字典，根據字典類型來進行綁定了。

private void InitDictItem()
{
this.txtManufacture.BindDictItems("供貨商");
this.txtSearchManufacture.BindDictItems("供貨商");
this.txtSearchDept.BindDictItems("部門");
}

如上代碼所示，簡化了很多處理，就一個函數就可以綁定了系統字典類型的下拉列表了。

帶序號的GridLookUpEdit下拉列表

有時候，我們在一些常見的系統里面，經常看到一些帶有序號的下拉列表，其實里面就是一個GridControl的控件，我們只需要賦值對應的列表數據源，以及設置顯示的列內容，并重寫下序號的展示處理就可以實現了。

我們先來看看實際的效果。

上面的列表是一個GridControl的內在控件，我們使用這個 GridLookUpEdit下拉列表控件的時候，設置好GridControl的數據源和顯示的列就基本上可以了。

//綁定數據源和顯示的內容、隱藏值
this.txtProjectList.Properties.DataSource = list;
this.txtProjectList.Properties.ValueMember = "Value";
this.txtProjectList.Properties.DisplayMember = "Text";

//設置Grid顯示的列信息
var columns = new List<LookUpColumnInfo>()
{
new LookUpColumnInfo("Value", "顯示名稱")
};
for (int i = 0; i < columns.Count; i++)
{
this.txtProjectList.Properties.View.CreateColumn(columns[i].FieldName, columns[i].Caption,
columns[i].Width, true, UnboundColumnType.Bound, DefaultBoolean.False, FixedStyle.None);
}

//其他屬性設置
this.txtProjectList.Properties.ImmediatePopup = true;
this.txtProjectList.Properties.TextEditStyle = TextEditStyles.Standard;
this.txtProjectList.Properties.PopupWidthMode = DevExpress.XtraEditors.PopupWidthMode.ContentWidth;

//設定列表的序號的寬度和顯示文本
this.txtProjectList.Properties.View.IndicatorWidth = 40;
this.txtProjectList.Properties.View.CustomDrawRowIndicator += (s, e) =>
{
if (e.Info.IsRowIndicator && e.RowHandle >= 0)
{
e.Info.DisplayText = (e.RowHandle + 1).ToString();
}
};

那么如果我們需要使用擴展函數來簡化實際的代碼，那么應該如何封裝這個GridLookupEdit的下列控件呢，我們編寫的擴展函數代碼如下所示。

/// <summary>
/// 綁定控件的數據源
/// </summary>
/// <param name="lookup">控件對象</param>
/// <param name="dataSource">數據源</param>
/// <param name="displayMember">顯示字段</param>
/// <param name="valueMember">值字段</param>
/// <param name="showRowIndicator">是否顯示序號</param>
/// <param name="lookUpColumnInfos">顯示的列</param>
/// <returns></returns>
public static object BindDictItems(this GridLookUpEdit lookup, object dataSource, string displayMember, string valueMember, bool showRowIndicator = true, params LookUpColumnInfo[] lookUpColumnInfos)
{
lookup.Properties.DataSource = dataSource;
lookup.Properties.DisplayMember = displayMember;
lookup.Properties.ValueMember = valueMember;

lookup.Properties.View.Columns.Clear();
for (int i = 0; i < lookUpColumnInfos.Length; i++)
{
lookup.Properties.View.CreateColumn(lookUpColumnInfos[i].FieldName, lookUpColumnInfos[i].Caption,
lookUpColumnInfos[i].Width, true, UnboundColumnType.Bound, DefaultBoolean.False, FixedStyle.None);
}
lookup.Properties.ImmediatePopup = true;
lookup.Properties.TextEditStyle = TextEditStyles.Standard;

if (showRowIndicator)
{
lookup.Properties.View.IndicatorWidth = 40;
//重寫序號顯示，默認不顯示數值
lookup.Properties.View.CustomDrawRowIndicator += (s, e) =>
{
if (e.Info.IsRowIndicator && e.RowHandle >= 0)
{
e.Info.DisplayText = (e.RowHandle + 1).ToString();
}
};
}

return dataSource;
}

這樣處理后，界面上簡化了不少代碼，如下使用代碼所示。

var list = DictItemUtil.GetDictByDictType("備件類別");
var columns = new List<LookUpColumnInfo>()
{
new LookUpColumnInfo("Value", "顯示名稱")
};

this.txtProjectList2.BindDictItems(list, "Text", "Value", true, columns.ToArray());

通過上面的兩種方式，我們可以得到常見的兩種下拉列表的數據綁定展示方式。

而對于其他類似的下拉列表，如樹形列表，帶搜索的SearchLookupEdit等控件，我們也可以用類似的方式編寫自定義的擴展函數，這樣我們使用起來就非常方便的了。類似我們下面的做法方式，分門別類的對它們進行一些簡單的封裝處理。

本文轉載自：

DevExpress技術交流群6：600715373      歡迎一起進群討論