使用扩展函数方式，在Winform界面中快捷的绑定树形列表TreeList控件和TreeListLookUpEdit控件

使用,扩展,函数,方式,winform,界面,快捷,绑定,树形,列表,treelist,控件,treelistlookupedit · 浏览次数 : 798

小编点评

**在Winform开发中，我们使用的几种下拉列表展示字典数据的方式** **1.通过属性设置** ```csharp //属性 public List DisplayItems { get; set; } //设置属性 DisplayItems = new List() { "1", "2", "3" }; ``` **2.通过构造方法设置** ```csharp //构造方法 public string DisplayItems { get; set; } //设置构造方法 public DisplayItems() { DisplayItems = new List() { "1", "2", "3" }; } ``` **3.通过字典设置** ```csharp //字典 public Dictionary DisplayItems { get; set; } //设置字典 DisplayItems = new Dictionary() { { "1", "2", "3" } }; ``` **4.通过枚举设置** ```csharp //枚举 public enum DisplayItemsEnum { Item1, Item2, Item3 } //设置枚举 DisplayItemsEnum item = DisplayItemsEnum.Item1; ``` **5.通过缓存提高界面显示速度** ```csharp //缓存 public List DisplayItemsCache { get; set; } //设置缓存 DisplayItemsCache = new List() { "1", "2", "3" }; //设置属性 DisplayItems = DisplayItemsCache.ToArray(); ``` **6.通过上下文方式快速调用处理函数** ```csharp //上下文 public string DisplayItems { get; set; } //设置上下文 DisplayItems = new string[] { "1", "2", "3" }; //通过上下文方式调用处理函数 DisplayItems = DisplayItems.Select(item => item.ToString()).ToArray(); ```

正文

在一些字典绑定中，往往为了方便展示详细数据，需要把一些结构树展现在树列表TreeList控件中或者下拉列表的树形控件TreeListLookUpEdit控件中，为了快速的处理数据的绑定操作，比较每次使用涉及太多细节的操作，我们可以把相关的数据绑定操作，放在一些辅助类的扩展函数中进行处理，这样可以更方便的，更简洁的处理数据绑定操作，本篇随笔介绍TreeList控件和TreeListLookUpEdit控件在扩展函数中的处理操作。

1、TreeList控件的绑定操作

TreeList本身就是一个树形数据的展示控件，可以展示常规的二维表，也可以展示具有嵌套关系的二维表，数据源可以是多种方式的，支持Datable的数据源的嵌套展示。

单个列信息的树形列表展示界面效果：

 类似GridView的嵌套列表展示的TreeList界面效果

 这些界面都比较常见，也是我们经常碰到的处理效果，但是TreeList的界面设置有很多特性，如果每次拷贝这些代码，需要很多，也不便于维护，因此我们建立一些扩展函数来处理界面元素的绑定，就非常必要。

本篇随笔介绍基于TreeList和TreeListLookUpEdit控件的绑定即可。两个类型控件的数据源，都可以是DataTable类型，也可以是IList集合类型，如下所示是基于SQLSugar开发框架，返回的数据结构是IList类型的。

所以一般树形列表的绑定操作，提供一个方法来获取数据并绑定即可。

        /// <summary>
        /// 绑定树的数据源
        /// </summary>
        private async void BindTree()
        {
            var list = await BLLFactory<IDictTypeService>.Instance.GetAllAsync();
            this.tree.DataSource = list?.Items;
            this.tree.ExpandAll();
        }

如果使用原生代码初始化树列表，那么代码如下所示。

 //使用原生代码处理
 //添加显示列
 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.ShowColumns = false;
 this.tree.OptionsView.ShowCheckBoxes = false;
 this.tree.OptionsView.EnableAppearanceOddRow = true;
 this.tree.OptionsView.EnableAppearanceEvenRow = true;

而实现查询过滤的操作，还需要另外处理代码，我们看看大概的代码如下。

        /// <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.CreateColumn("Name", "字典类型名称", 160, true);
  this.tree.InitTree("Id", "PID", "-1", false, false);
  this.tree.InitSearchControl(this.searchControl1, "Name");

我们扩展方法放在一个单独的文件中，标注为静态类即可。

    /// <summary>
    /// TreeList控件的扩展函数
    /// </summary>
    public static class TreeList_Extension

其中提供几个对TreeList 常见的封装处理方法就可以了。

对于一些不常见的属性，我们保留它即可，如下界面代码是对TreeList绑定展示多个列的处理操作。

/// <summary>
/// 初始化TreeList控件,展现嵌套的列表。
/// </summary>
private void InitControl()
{
    this.tree.Columns.Clear();//控件扩展函数封装处理
    this.tree.CreateColumn("Name", "机构名称", 160, true);
    this.tree.CreateColumn("HandNo", "机构编码", 80, true);
    this.tree.CreateColumn("Category", "机构分类", 80, true);
    this.tree.CreateColumn("Address", "机构地址", 160, true);
    this.tree.CreateColumn("InnerPhone", "内线电话", 80, true);
    this.tree.CreateColumn("OuterPhone", "外线电话", 80, true);
    this.tree.CreateColumn("SortCode", "排序码", 80, true);
    this.tree.InitTree("Id", "PID", null, true, true);

    this.tree.OptionsView.RowImagesShowMode = RowImagesShowMode.InCell;//紧凑型图标
    this.tree.ExpandAll();

    // 列过滤处理            
    this.tree.OptionsView.ShowAutoFilterRow = true;//显示过滤行            
    this.tree.OptionsBehavior.EnableFiltering = true;//开启过滤功能

    //初始化树节点选择事件
    this.tree.FocusedNodeChanged += delegate (object sender, FocusedNodeChangedEventArgs e)
    {
        this.FocusedNodeChanged();
    };
    //树节点双击处理事件
    this.tree.DoubleClick += (s, e) =>
    {
        if (this.tree.FocusedNode != null)
        {
            string ID = string.Concat(this.tree.FocusedNode.GetValue("Id"));
            MessageDxUtil.ShowTips("Id=" + ID);
        }
    };
    //编辑记录失去焦点后校验处理
    this.tree.ValidateNode += (s, e) =>
    {
        Console.WriteLine(this.tree.FocusedNode.GetValue("Name"));
    };
}

实现类似GridView的嵌套列表展示的TreeList界面效果如下所示。

 

2、TreeListLookUpEdit控件绑定操作

在一些参考的列表中，我们往往需要展示更丰富一点的列表内容，如下所示。

如果有嵌套列表的，展示嵌套列表的处理

对于下拉的树形列表，虽然这个控件比TreeList更复杂一些，它是下拉列表和TreeList的整合体，不过我们也可以用类似的扩展函数方法，来简单的实现数据的绑定展示。

如对于常规的数据绑定，我们大概的代码如下所示。

//TreeListLookupEdit数据绑定
//this.txtProjectList3.Properties.TreeList.OptionsView.ShowCheckBoxes = true;
this.txtProjectList3.Properties.DataSource = list;
this.txtProjectList3.Properties.ValueMember = "Value";
this.txtProjectList3.Properties.DisplayMember = "Text";
this.txtProjectList3.Properties.TreeList.Columns.Clear();
for (int i = 0; i < columns.Count; i++)
{
    this.txtProjectList3.Properties.TreeList.CreateColumn(columns[i].FieldName, columns[i].Caption,
        columns[i].Width, true);
}
this.txtProjectList3.Properties.TreeList.InitTree(null, null, null, true, true);

this.txtProjectList3.Properties.ImmediatePopup = true;
this.txtProjectList3.Properties.TextEditStyle = TextEditStyles.Standard;
this.txtProjectList3.Properties.PopupWidthMode = DevExpress.XtraEditors.PopupWidthMode.ContentWidth;
this.txtProjectList3.Properties.PopupFormSize = new System.Drawing.Size(this.txtProjectList3.Width, 300);
this.txtProjectList3.Properties.TreeList.IndicatorWidth = 40;
this.txtProjectList3.Properties.TreeList.CustomDrawNodeIndicator += (s, ee) =>
{
    if (ee.IsNodeIndicator)
    {
        var index = ee.Node.TreeList.GetVisibleIndexByNode(ee.Node);
        ee.Info.DisplayText = (index + 1).ToString();
    }
};

对于常规的列表绑定，我们可以用简单的一个扩展函数实现，如下所示。

    //常规类别绑定
    this.txtProjectList4.BindDictItems(list, "Text", "Value", true, columns.ToArray());

就可以实现常规的界面效果处理。

对于树形列表，我们需要设置属性的ID和PID，以及一些显示的列属性，那么也可以增加更多的参数来实现。

var dictTypeColumns = new List<LookUpColumnInfo>()
{
    new LookUpColumnInfo("Id", "Id"),
    new LookUpColumnInfo("Name", "字典类别名称")
};
treeListLookUp.BindDictItems(result.Items, "Name", "Id", true, false, "Id", "PID", null, true, true, true, false, dictTypeColumns.ToArray());

因此嵌套列表就可以正常的展示出层次关系了

因此我们把扩展方法，放到静态类里面就可以了，方法封装如下所示

       /// <summary>
        /// 绑定TreeListLookUpEdit控件的数据源(完整版）
        /// </summary>
        /// <param name="lookup">控件对象</param>
        /// <param name="dataSource">数据源</param>
        /// <param name="displayMember">显示字段</param>
        /// <param name="valueMember">值字段</param>
        /// <param name="showRowIndicator">是否显示序号</param>
        /// <param name="showCheckbox">是否显示复选框</param>
        /// <param name="keyFieldName">设置父子递归关系字段-子字段，不指定则使用valueMember</param>
        /// <param name="parentFieldName">设置父子递归关系字段-父字段，不指定则不嵌套展示</param>
        /// <param name="rootValue">根节点的值</param>
        /// <param name="editable">树节点是否可以编辑</param>
        /// <param name="showColumnHeader">是否显示列头</param>
        /// <param name="oddEvenRowColor">是否奇偶行不同颜色</param>
        /// <param name="allowDrop">是否运行拖动列</param>
        /// <param name="lookUpColumnInfos">显示的列</param>
        /// <returns></returns>
        public static object BindDictItems(this TreeListLookUpEdit lookup, object dataSource, string displayMember, string valueMember, bool showRowIndicator = true,
            bool showCheckbox = false, string keyFieldName = null, string parentFieldName = null, string rootValue = null, bool editable = true,
            bool showColumnHeader = false, bool oddEvenRowColor = true, bool allowDrop = false,
            params LookUpColumnInfo[] lookUpColumnInfos)
        {
            lookup.Properties.DataSource = dataSource;
            lookup.Properties.DisplayMember = displayMember;
            lookup.Properties.ValueMember = valueMember;
            lookup.Properties.TreeList.OptionsView.ShowCheckBoxes = showCheckbox;

            lookup.Properties.TreeList.Columns.Clear();
            for (int i = 0; i < lookUpColumnInfos.Length; i++)
            {
                lookup.Properties.TreeList.CreateColumn(lookUpColumnInfos[i].FieldName, lookUpColumnInfos[i].Caption,
                    lookUpColumnInfos[i].Width, true);
            }

            //初始化树的样式和特性
            //keyFieldName = !string.IsNullOrWhiteSpace(keyFieldName) ? keyFieldName : valueMember;//如果不指定，采用valueMember
            lookup.Properties.TreeList.InitTree(keyFieldName, parentFieldName, rootValue, editable, showColumnHeader, oddEvenRowColor, allowDrop);
            lookup.Properties.PopupFormSize = new System.Drawing.Size(lookup.Width, 300);

            lookup.Properties.ImmediatePopup = true;
            lookup.Properties.TextEditStyle = TextEditStyles.Standard;

            if (showRowIndicator)
            {
                lookup.Properties.TreeList.IndicatorWidth = 40;
                //重写序号显示，默认不显示数值
                lookup.Properties.TreeList.CustomDrawNodeIndicator += (s, ee) =>
                {
                    if (ee.IsNodeIndicator)
                    {
                        var index = ee.Node.TreeList.GetVisibleIndexByNode(ee.Node);
                        ee.Info.DisplayText = (index + 1).ToString();
                    }
                };
            }

            return dataSource;
        }

通过扩展方法的方式，可以简化界面的处理代码，同时利于我们在项目开发的时候，快速的实现相关的效果，而不需要过多的中断查找相关的界面控件属性。

有几篇类似的文章，可供参考：

《在Winform开发中，我们使用的几种下拉列表展示字典数据的方式》

《在Winform开发框架中下拉列表绑定字典以及使用缓存提高界面显示速度》

《在各种开发项目中使用公用类库的扩展方法，通过上下文方式快速调用处理函数》

 

使用 扩展 函数 方式 winform 界面 快捷 绑定 树形 列表 treelist 控件 treelistlookupedit

与使用扩展函数方式，在Winform界面中快捷的绑定树形列表TreeList控件和TreeListLookUpEdit控件相似的内容：

使用扩展函数方式，在Winform界面中快捷的绑定树形列表TreeList控件和TreeListLookUpEdit控件

在一些字典绑定中，往往为了方便展示详细数据，需要把一些结构树展现在树列表TreeList控件中或者下拉列表的树形控件TreeListLookUpEdit控件中，为了快速的处理数据的绑定操作，比较每次使用涉及太多细节的操作，我们可以把相关的数据绑定操作，放在一些辅助类的扩展函数中进行处理，这样可以更方便的，更简洁的处理数据绑定操作，本篇随笔介绍TreeList控件和TreeListLookUpEdi

使用 扩展 函数 方式
798
在DevExpress的GridView的列中，使用RepositoryItemSearchLookUpEdit控件实现产品列表信息的展示和选择

有时候，我们为了方便，我们往往使用扩展函数的代码方式创建很多GridView的操作功能，如在随笔《在DevExpress中使用BandedGridView表格实现多行表头的处理》中介绍过多行表头的创建及绑定处理，在《基于DevExpress的GridControl实现的一些界面处理功能》也介绍了一些特殊的展示效果，本篇随笔介绍在DevExpress的GridView的列中，使用Repository

devexpress gridview 使用 repositoryitemsearchlookupedit
736
在DevExpress中使用BandedGridView表格实现多行表头的处理

在之前较早随笔中介绍过实现多行表头的处理，通过手工创建字段以及映射数据源字段属性的方式实现，有些客户反映是否可以通过代码方式更方便的创建对应的处理操作，因此本篇随笔继续探讨这个多行表头的处理的操作，使用代码的方式结合扩展函数处理，快速的实现GridControl的多行表头的处理操作。

devexpress 使用 bandedgridview 表格
704
在DevExpress的GridView的列中，动态创建列的时候，绑定不同的编辑处理控件

在使用DevExpress的GridView的时候，我们为了方便，往往使用一些扩展函数，动态创建GridView列的编辑控件对象，然后我们可以灵活的对内容进行编辑或者使用一些弹出的对话框窗体进行处理内容的录入，本篇随笔就是介绍这一主题：在DevExpress的GridView的列中，动态创建列的时候，绑定不同的编辑处理控件。

devexpress gridview 动态创建 时候
609
Less常用功能使用

Less 是一门 CSS 预处理语言，它扩充了 CSS 语言，增加了诸如变量、混合（mixin）、函数等功能，让 CSS 更易维护、方便制作主题、扩充。Less 可以运行在 Node 或浏览器端。 Less常用的重要功能有： 1.变量 2.cala计算 3.html样的选择器嵌套 4. &父选择器本

Less 功能 常用
215
python入门基础(13)--类、对象、全局函数，类内部调用

面向过程的编程语言，如C语言，所使用的数据和函数之间是没有任何直接联系的，它们之间是通过函数调用提供参数的形式将数据传入函数进行处理。 但可能因为错误的传递参数、错误地修改了数据而导致程序出错，甚至是崩溃。当需要修改或维护程序时要从程序提供的一堆数据中去寻找和修改它，要扩展函数的功能，只能重新建立一

python 入门 基础 对象
878
Nuxt3 的生命周期和钩子函数（七）

摘要：文章阐述了Nuxt3中Nitro生命周期钩子的使用，如nitro:config自定义配置、nitro:init注册构建钩子、nitro:build:before/after调整构建设置及处理公共资产、prerender:routes扩展预渲染路由、build:error捕获构建错误，通过示例代...

nuxt3
0
开源.NetCore通用工具库Xmtool使用连载 - 扩展动态对象篇

【Github源码】 《上一篇》 介绍了Xmtool工具库中的图形验证码类库，今天我们继续为大家介绍其中的扩展动态对象类库。 扩展动态对象是整个工具库中最重要的一个设计。在软件开发过程中，我们经常需要定义各种各样的数据对象；例如：用于参数传递的数据实体类、用于接口返回结果的Json对象等等。 //

开源 netcore 通用 工具
4
.NET周报【1月第2期 2023-01-13】

国内文章 【ASP.NET Core】按用户等级授权 https://www.cnblogs.com/tcjiaan/p/17024363.html 本文介绍了ASP.NET Core如何按照用户等级进行授权。 在 C# 9 中使用 foreach 扩展 https://www.cnblogs.co

周报 NET
1178
[转帖]金仓数据库KWR使用说明

金仓数据库KWR使用说明 1.KWR性能报告介绍2.部署KWR性能报告功能2.1.修改配置文件2.2.使配置文件中参数生效2.3.创建KWR扩展 3.使用KWR快照功能3.1.创建KWR快照3.2.管理快照3.2.1.快照查询3.2.2.手动创建快照3.2.3.自动快照3.2.4.清理快照3.2.5

数据库 kwr 使用 说明
0
# 热门排行
微软 New Bing AI 申请与使用保姆级教程（免魔法） ChatGPT API使用介绍 ChatGPT开发实战 一篇带你了解如何使用纯前端类Excel表格构建现金流量表 手把手教你玩转 Excel 数据透视表 为什么 C# 可能是最好的第一编程语言 .NET 入门到高级路线 提高工作效率的神器：基于前端表格实现Chrome Excel扩展插件 React + Springboot + Quartz，从0实现Excel报表自动化 用Echarts实现前端表格引用从属关系可视化
© PmDaddy. 2023 PmDaddy教程网 All rights reserved.