DevExpress提供的樹形列表控件TreeList和樹形下拉列表控件TreeListLookupEdit都是很是強大的一個控件,它和咱們傳統Winform的TreeView控件使用上有所不一樣,我通常在Winform開發中根據狀況混合使用這些控件,不過總體來看,基於DevExpress的TreeList和TreeListLookupEdit表現相對比較好看一些,本篇隨筆主要介紹這兩個控件在實際Winform項目中的使用處理。node
例如在菜單管理中,咱們知道菜單通常狀況下是層次節點的,咱們爲了直觀顯示的須要,通常把菜單用樹列表控件進行展現,其中就會用到咱們說的TreeList控件,以下界面所示。異步
其中TreeList和一個輸入SearchControl來一塊兒協同使用,能夠提升界面的友好性,咱們能夠經過輸入關鍵字進行節點的過濾顯示。async
如輸入過濾內容後查詢過濾樹列表節點,以下所示,這樣能夠給用戶快速模糊檢索指定的樹節點。函數
有了大概的感官認識,咱們來了解下TreeList控件的使用狀況this
在菜單界面的設計視圖下,咱們添加一個ContextMenuStrip的右鍵菜單控件,而後編輯一些菜單項目,以下界面所示。spa
而後拖入一個圖片集合的ImageCollection控件,併爲它增長一些控件圖片(也能夠保留爲空,而後動態指定,如本例同樣)設計
初始化樹列表,咱們通常分爲幾個函數,一個是初始化樹列表,一個是綁定查詢過濾的處理,一個是把數據綁定到樹列表上去,以下代碼所示。code
private async void FrmMenu_Load(object sender, EventArgs e) { //列表信息 InitTree(); InitSearchControl(); await BindTree(); }
上面使用了異步操做,咱們通常也能夠不用異步,這裏根據狀況處理吧。orm
初始化樹列表的操做代碼以下所示。blog
/// <summary> /// 初始化樹控件 /// </summary> private void InitTree() { this.tree.Columns.Clear(); //添加顯示列 this.tree.Columns.Add(new TreeListColumn { FieldName = "Id", Caption = "Id" });//增長一個隱藏的字段,存儲須要的ID this.tree.Columns.Add(new TreeListColumn { FieldName = "Name", Caption = "菜單名稱", Width = 160, VisibleIndex = 0 }); //設置樹控件的層次關係及屬性 tree.KeyFieldName = "Id"; tree.ParentFieldName = "PID"; this.tree.OptionsBehavior.Editable = false; this.tree.OptionsView.EnableAppearanceOddRow = true; this.tree.OptionsView.EnableAppearanceEvenRow = true; this.tree.OptionsDragAndDrop.DragNodesMode = DragNodesMode.None;//不容許拖動 //設置樹的圖標集合及逐級圖標 this.tree.SelectImageList = this.imageCollection1; this.tree.CustomDrawNodeImages += (object sender, CustomDrawNodeImagesEventArgs e) => { //int maxCount = this.imageCollection1.Images.Count; //var index = e.Node.Level < maxCount ? e.Node.Level : 0; //e.SelectImageIndex = index; var id = string.Concat(e.Node.GetValue(Id_FieldName)); int index = 0; IdIndexDict.TryGetValue(id, out index); e.SelectImageIndex = index; }; //初始化樹節點選擇事件 this.tree.FocusedNodeChanged += delegate (object sender, FocusedNodeChangedEventArgs e) { this.FocusedNodeChanged(); }; } private async void FocusedNodeChanged() { if (this.tree.FocusedNode != null) { IsNormalSearch = false; await BindData(); } }
初始化樹列表的處理代碼,咱們還可使用擴展函數進一步簡化它,以下所示。
/// <summary> /// 初始化樹控件 /// </summary> private void InitTree() { this.tree.Columns.Clear(); this.tree.OptionsDragAndDrop.DragNodesMode = DragNodesMode.None;//不容許拖動 //控件擴展函數封裝處理 this.tree.CreateColumn("Name", "菜單名稱", 160, true); this.tree.InitTree("Id", "PID", null, false, false); //設置樹的圖標集合及逐級圖標 this.tree.SelectImageList = this.imageCollection1; this.tree.CustomDrawNodeImages += (object sender, CustomDrawNodeImagesEventArgs e) => { //int maxCount = this.imageCollection1.Images.Count; //var index = e.Node.Level < maxCount ? e.Node.Level : 0; //e.SelectImageIndex = index; var id = string.Concat(e.Node.GetValue(Id_FieldName)); int index = 0; IdIndexDict.TryGetValue(id, out index); e.SelectImageIndex = index; }; //初始化樹節點選擇事件 this.tree.FocusedNodeChanged += delegate (object sender, FocusedNodeChangedEventArgs e) { this.FocusedNodeChanged(); }; }
初始化查詢控件SearchControl的代碼以下所示。
/// <summary> /// 實現樹節點的過濾查詢 /// </summary> private void InitSearchControl() { this.searchControl1.Client = this.tree; this.tree.FilterNode += (object sender, FilterNodeEventArgs e) => { if (tree.DataSource == null) return; string nodeText = e.Node.GetDisplayText("Name");//參數填寫FieldName if (string.IsNullOrWhiteSpace(nodeText)) return; bool isExist = nodeText.IndexOf(searchControl1.Text, StringComparison.OrdinalIgnoreCase) >= 0; if (isExist) { var node = e.Node.ParentNode; while (node != null) { if (!node.Visible) { node.Visible = true; node = node.ParentNode; } else break; } } e.Node.Visible = isExist; e.Handled = true; }; }
上面只是初始化樹列表控件,咱們還須要對它進行數據的綁定顯示,樹列表的綁定主要代碼就是數據綁定和圖標的綁定。
this.tree.SelectImageList = this.imageCollection1; this.tree.DataSource = result.Items;
不過咱們圖標因爲是從數據源裏面動態構建的,所以須要存在一個集合裏面,方便賦值給樹列表控件,以下是完整的綁定代碼。
/// <summary> /// 綁定樹的數據源 /// </summary> private async Task BindTree() { var pageDto = new MenuPagedDto(); var result = await MenuApiCaller.Instance.GetAll(pageDto); //用來存放對應ID和index順序的 IdIndexDict = new Dictionary<string, int>(); //從新刷新節點圖片 this.imageCollection1 = new ImageCollection(); this.imageCollection1.ImageSize = new Size(16, 16); if (result != null && result.Items != null) { foreach (var menuInfo in result.Items) { var image = LoadIcon(menuInfo); this.imageCollection1.Images.Add(image); //爲每一個菜單ID添加一個圖片序號,方便查找 if(!IdIndexDict.ContainsKey(menuInfo.Id)) { int index = this.imageCollection1.Images.Count - 1;//最後一個序號 IdIndexDict.Add(menuInfo.Id, index); } } } //imageCollection變化了,須要從新賦值給treeList this.tree.SelectImageList = this.imageCollection1; this.tree.DataSource = result.Items; this.tree.ExpandAll(); }
若是咱們須要獲取指定樹節點的綁定的值,咱們能夠經過當前的FocuseNode獲取字段值,以下代碼所示。
/// <summary> /// 編輯列表數據 /// </summary> private async Task EditTreeData() { string ID = string.Concat(this.tree.FocusedNode.GetValue(Id_FieldName)); if (!string.IsNullOrEmpty(ID)) { FrmEditMenu dlg = new FrmEditMenu(); dlg.ID = ID; dlg.OnDataSaved += new EventHandler(dlg_OnDataSaved); dlg.InitFunction(LoginUserInfo, FunctionDict);//給子窗體賦值用戶權限信息 if (DialogResult.OK == dlg.ShowDialog()) { await BindTree(); } } }
以上就是TreeList控件的使用過程,主要注意的就是數據源的綁定和圖標的綁定操做便可。
若是咱們還容許樹列表拖動,以便進行父位置的調整,那麼能夠對它進行一個拖動的事件處理。
this.tree.CalcNodeDragImageIndex += new DevExpress.XtraTreeList.CalcNodeDragImageIndexEventHandler(this.Tree_CalcNodeDragImageIndex); this.tree.DragDrop += new System.Windows.Forms.DragEventHandler(this.Tree_DragDrop); this.tree.DragOver += new System.Windows.Forms.DragEventHandler(this.Tree_DragOver);
private void Tree_DragOver(object sender, DragEventArgs e) { TreeListNode dragNode = e.Data.GetData(typeof(TreeListNode)) as TreeListNode; e.Effect = GetDragDropEffect(sender as TreeList, dragNode); } private async void Tree_DragDrop(object sender, DragEventArgs e) { TreeListNode dragNode, targetNode; TreeList tl = sender as TreeList; Point p = tl.PointToClient(new Point(e.X, e.Y)); dragNode = e.Data.GetData(typeof(TreeListNode)) as TreeListNode; targetNode = tl.CalcHitInfo(p).Node; //移動後更新數據 var id = string.Concat(dragNode.GetValue("Id")).ToInt64(); var pid = string.Concat(targetNode.GetValue("Id")).ToInt64(); await OrganizationUnitApiCaller.Instance.Move(new MoveOrganizationUnitDto() { Id = id, ParentId = pid }); await BindTree(); e.Effect = DragDropEffects.None; } private void Tree_CalcNodeDragImageIndex(object sender, CalcNodeDragImageIndexEventArgs e) { TreeList tl = sender as TreeList; if (GetDragDropEffect(tl, tl.FocusedNode) == DragDropEffects.None) e.ImageIndex = -1; // no icon else e.ImageIndex = 1; // the reorder icon (a curved arrow) }
TreeList和TreeListLookupEdit通常都會成對出現,通常咱們須要調整父節點的時候,都會涉及到這個樹形的下拉列表TreeListLookupEdit控件的。
爲了方便,咱們通常都定義一個自定義控件來處理這些下拉列表的綁定,所以不須要每次都綁定數據以及初始化代碼。
private void FunctionControl_Load(object sender, EventArgs e) { if (!this.DesignMode) { InitTree(); BindTree(); } } /// <summary> /// 初始化樹 /// </summary> /// <returns></returns> private void InitTree() { this.txtMenu.Properties.ValueMember = "Id"; this.txtMenu.Properties.DisplayMember = "Name"; var tree = this.treeListLookUpEdit1TreeList; tree.Columns.Clear(); //控件擴展函數封裝處理 tree.CreateColumn("Name", "菜單名稱", 160, true); tree.InitTree("Id", "PID", null, false, false); //設置樹的圖標集合及逐級圖標 tree.SelectImageList = this.imageCollection1; tree.CustomDrawNodeImages += (object sender, CustomDrawNodeImagesEventArgs e) => { int maxCount = this.imageCollection1.Images.Count; var index = e.Node.Level < maxCount ? e.Node.Level : 0; e.SelectImageIndex = index; }; } /// <summary> /// 綁定樹列表 /// </summary> /// <returns></returns> public void BindTree() { var tree = this.treeListLookUpEdit1TreeList; //綁定列表數據 var result = AsyncContext.Run(() => MenuApiCaller.Instance.GetAll(new MenuPagedDto() { })); if (result != null && result.Items != null) { tree.DataSource = result.Items; tree.ExpandAll();//展開全部 } //執行綁定後處理 if (DataBinded != null) { DataBinded(null, null); } }
其中 AsyncContext.Run 是把異步函數當作同步使用,通常咱們在用戶控件上,咱們都使用同步操做,避免數據綁定延遲致使沒有處理
經過制定ValueMember和DisplayMember就能夠正常顯示內容,以及在後面存儲須要的值操做。
this.txtMenu.Properties.ValueMember = "Id"; this.txtMenu.Properties.DisplayMember = "Name";
TreeListLookupEdit控件裏面仍是有一個TreeList控件的,這個控件的操做和咱們上面說的TreeList控件操做徹底同樣,咱們按樹列表的方式初始化並綁定它便可。
界面效果以下所示。
樹列表控件展開以下所示。