在Winform开发框架中使用DevExpress的TreeList和TreeListLookupEdit控件

时间 2019-11-05

标签 winform 开发框架使用 devexpress treelist treelistlookupedit 控件繁體版

原文原文链接

DevExpress提供的树形列表控件TreeList和树形下拉列表控件TreeListLookupEdit都是很是强大的一个控件，它和咱们传统Winform的TreeView控件使用上有所不一样，我通常在Winform开发中根据状况混合使用这些控件，不过总体来看，基于DevExpress的TreeList和TreeListLookupEdit表现相对比较好看一些，本篇随笔主要介绍这两个控件在实际Winform项目中的使用处理。node

一、DevExpress的TreeList控件使用

例如在菜单管理中，咱们知道菜单通常状况下是层次节点的，咱们为了直观显示的须要，通常把菜单用树列表控件进行展现，其中就会用到咱们说的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)
        }

二、DevExpress的TreeListLookupEdit控件使用

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控件操做彻底同样，咱们按树列表的方式初始化并绑定它便可。

界面效果以下所示。

树列表控件展开以下所示。