扩展UltraGrid控件实现对所有数据行的全选功能[Source Code下载]-阿里云开发者社区

在前面一篇文章中，我通过对三种Infragistics 控件（UltraToolBarManager、UltraGird和UltraListView）进行扩展，以实现对ToolTip样式的定义，今天我来介绍如何采用相同的方式实现另外一个更为常用的功能：在UltraGrid的Header中动态添加CheckBox，从而实现对所有数据行进行全选的功能。[Source Code从这里下载]

一、我们的目标：在UltraGird的选择列的Header添加CheckBox实现对所有数据行的全选

我们现有的绝大部分UltraGird都具有如下图（点击查看大图）所示的结构：第一行为UnBound列，单元格中的CheckBox用于对当前行的选择，即通过勾选相应的CheckBox代表选中某一行。现在的新的要求是：在CheckBox列的列头添加一个总的CheckBox，用于选中所有数据行，即当勾选CheckBox时，下面所有数据行对应的均自动被勾选，反之，解除现有数据行对应的CheckBox的勾选状态。

熟悉Infragistics控件的朋友应该知道，UltraGird具有一个很有用的动态分局的特性：你可以将可被用于分组的列通过鼠标拖到最上方的区域（Drag a column header here to group by the column），那么UltraGird会自动为你将所有的数据行按照该列的值进行动态分组。这个分组功能为我们要扩展的UltraGird又增加了一个新的特性：如果在分组状态，需要在每一个分组行中添加CheckBox，该CheckBox用于对当前组范围内所有数据行的全选。最后的效果如右图（点击查看大图）所示。

二、关于UIElement和UIElementCreationFilter

在具体介绍实现的之前，我们先来谈谈相关的一些背景知识：关于UIElement和UIElementFilter。Infragistics 基于Windows Forms应用的控件具有非常高的扩展型。通过合理使用UIElement，开发者可以很容易地添加一些现有控件没有提供的功能。

基本上所有的Infragistics 控件（这里我们仅仅指基于Window Forms应用控件）都有一个具有层级关系的UIElement组成。比如，一个UltraTree 由一个UltraTreeUIElement构成，而一个UltraTreeUIElement又包含一组TreeNodeUIElement 对象和NodeConnectorUIElement对象。而TreeNodeUIElements又由一组PreNodeAreaUIElement 和NodeSelectableAreaUIElement组成。对于NodeSelectableAreaUIElements，其组成元素又包含两种：ExpansionIndicatorUIElements 和NodeTexUIElements。

所有的UIElement相关的操作，比如改变其显示风格和位置，可以通过两个Filter对象控制，即CreationFilter和DrawFilter。而CreationFilter还能用于为现有控件动态的添加或者移除子控件，我们将要实现的对于CheckBox的动态添加就是通过自定义CreationFilter实现的。

三、自定义UIElementCreationFilter实现对CheckBox的动态添加

对现有UltraGrid的扩展的核心在于自定义UIElementCreationFilter实现对CheckBox的动态添加，在具体介绍如何自定义UIElementCreationFilter之前，我们先看看我们扩展出来的UltraGrid的定义。从下面的代码片段可以看出，扩展控件ExtendedUltraGrid的定义其实很简单。其中，SelectAllColumnName表示CheckBox列的名称；而IsGroupMode属性表示当前是否处于分组模式；CheckState表示在未分组情况下Select-All CheckBox应有的状态；在构造函数中，我们指定了UltraGrid的CreationFilter属性。

 
using System.Windows.Forms; 
using Infragistics.Win.UltraWinGrid; 
   
namespace Artech.ExtendedUltraGrid4SelectAll 
{ 
    public class ExtendedUltraGrid : UltraGrid 
    { 
        public string SelectAllColumnName{get;set;} 
   
        internal bool IsGroupMode 
        { 
            get 
            { 
                foreach (var row in this.Rows) 
                { 
                    if (row.IsGroupByRow) 
                    { 
                        return true; 
                    } 
                } 
                return false; 
            } 
        } 
   
        internal CheckState CheckState{ get; set; } 
   
        public ExtendedUltraGrid() 
        { 
            this.CreationFilter = new CheckableHeaderCreationFilter(this); 
        }        
    } 
} 
  

在构造函数中指定的Creation属性就是我们上面介绍的自定义的UIElementCreationFilter：CheckableHeaderCreationFilter。所有的UIElementCreationFilter均实现接口IUIElementCreationFilter，该接口具有两个方法BeforeCreateChildElements和AfterCreateChildElements。

 
using Infragistics.Win; 
public class MyUltraExplorerBarCreationFilter : IUIElementCreationFilter 
{ 
    public void AfterCreateChildElements(UIElement parent) 
    { 
        // called for a UIElement (parent) after it creates its child elements. 
    } 
    public bool BeforeCreateChildElements(UIElement parent) 
    { 
        // called for a UIElement (parent) before it creates its child elements. 
        return false; 
    } 
} 
  

在CheckableHeaderCreationFilter中，我们将在Select列的列头添加CheckBox的操作实现在AfterCreateChildElements方法中。其主要的逻辑是：通过parent的类型（必须是HeaderUIElement）、Column的类型（比如是Boolean）和Column Name（必须是在ExtendedUltraGrid的SelectAllColumnName属性指定）确定parent正是我们需要位置添加Check子控件的UIElement。然后创建CheckBoxUIElement，并将其添加到parent中，并通过Rect属性确定其显示的位置。然后我们会根据分组行（UltraGridGroupByRow）的Tag（这个会在自定义CheckBoxUIElement中设置）设置新创建的CheckBoxUIElement的CheckState状态，如果没有在分组模式下，我们根据ExtendedUltraGrid的CheckState属性指定该CheckBoxUIElement的状态。

 
using System; 
using System.Collections.Generic; 
using System.Drawing; 
using System.Windows.Forms; 
using Infragistics.Win; 
using Infragistics.Win.UltraWinGrid; 
   
namespace Artech.ExtendedUltraGrid4SelectAll 
{ 
    public class CheckableHeaderCreationFilter : IUIElementCreationFilter 
    { 
        public ExtendedUltraGrid Control 
        { get; private set; } 
   
        public CheckableHeaderCreationFilter( ExtendedUltraGrid control) 
        {           
            if (null == control) 
            { 
                throw new ArgumentNullException("control"); 
            } 
            this.Control = control; 
        } 
   
        public void AfterCreateChildElements(UIElement parent) 
        { 
            //Filter the HeaderUIElement element. 
            HeaderUIElement headerUIElement = parent as HeaderUIElement; 
            if (null == headerUIElement) 
            { 
                return; 
            } 
   
            //Filter by DataType and SelectAll column name. 
            if (headerUIElement.Header.Column.DataType != typeof(bool) || headerUIElement.Header.Column.Key != this.Control.SelectAllColumnName) 
            { 
                return; 
            } 
   
            //Check the exitence of CheckBoxUIElement. 
            //If not, create a new one and wrap it with a WeakReference. 
            CheckBoxUIElement checkBoxUIElement = parent.GetDescendant(typeof(CheckBoxUIElement)) as CheckBoxUIElement; 
            if (null == checkBoxUIElement) 
            { 
                checkBoxUIElement = new ExtendedCheckBoxUIElement(parent);               
            } 
            //Add the CheckBoxUIElement and set its position. 
            parent.ChildElements.Add(checkBoxUIElement); 
            checkBoxUIElement.Rect = new Rectangle( 
                        parent.Rect.X + (parent.Rect.Width - checkBoxUIElement.CheckSize.Width) / 2 + 1, 
                        parent.Rect.Y + ((parent.Rect.Height - checkBoxUIElement.CheckSize.Height) / 2), 
                        checkBoxUIElement.CheckSize.Width, 
                        checkBoxUIElement.CheckSize.Height 
                        );            
            //For GroupRow, set the Tag as the current CheckState. 
            UltraGridRow ultraGridRow = headerUIElement.GetContext(typeof(UltraGridRow)) as UltraGridRow; 
            UltraGridGroupByRow parentRow = ultraGridRow.ParentRow as UltraGridGroupByRow; 
            if (null != parentRow && null != parentRow.Tag) 
            { 
                checkBoxUIElement.CheckState = (CheckState)parentRow.Tag; 
            } 
   
            if (!this.Control.IsGroupMode) 
            { 
                checkBoxUIElement.CheckState = this.Control.CheckState; 
            } 
        } 
   
        public bool BeforeCreateChildElements(UIElement parent) 
        { 
            return false; 
        } 
    } 
} 
  

四、自定义CheckBoxUIElement

从CheckableHeaderCreationFilter的定义我们可以看到：动态添加的CheckBoxUIElement的类型为ExtendedCheckBoxUIElement，这是我们自定义的类型。我们通过该类型来设置分组行或者整个UltraGrid（没有在分组模式下）应有的状态，并最终对相应的数据行（在分组模式下为当前分组的所有行，而没有分组情况下为整个UltraGrid的所有行）的Check状态。所有的实现具有体现在重写的OnCheckStateChange上面。

 
using System.Windows.Forms; 
using Infragistics.Win; 
using Infragistics.Win.UltraWinGrid; 
   
namespace Artech.ExtendedUltraGrid4SelectAll 
{ 
    public class ExtendedCheckBoxUIElement : CheckBoxUIElement 
    {  
        public ExtendedCheckBoxUIElement(UIElement parent) 
            : base(parent) 
        { 
            this.ThreeState = false; 
        } 
   
        public override CheckState CheckState 
        { 
            get 
            { 
                return base.CheckState; 
            } 
            set 
            { 
                CheckState checkState = this.CheckState; 
                base.CheckState = value; 
                if (checkState != value) 
                { 
                    this.OnCheckStateChange(); 
                } 
            } 
        } 
   
        protected override void OnCheckStateChange() 
        { 
            base.OnCheckStateChange(); 
            ExtendedUltraGrid ultraGrid = this.Control as ExtendedUltraGrid; 
            HeaderUIElement headerUIElement = this.GetAncestor(typeof(HeaderUIElement))as HeaderUIElement; 
            UltraGridRow ultraGridRow = headerUIElement.GetContext(typeof(UltraGridRow))as UltraGridRow; 
            UltraGridGroupByRow parentRow = ultraGridRow.ParentRow as UltraGridGroupByRow; 
            if (null != parentRow) 
            { 
                parentRow.Tag = this.CheckState; 
                this.SetAllGridRowSelected(parentRow.Rows, this.CheckState); 
            } 
            else 
            { 
                this.SetAllGridRowSelected((this.Control as UltraGrid).Rows, this.CheckState); 
            } 
   
            if (!ultraGrid.IsGroupMode) 
            { 
                ultraGrid.CheckState = this.CheckState; 
            } 
        } 
   
        private void SetAllGridRowSelected(RowsCollection rows, CheckState state) 
        { 
            foreach (var row in rows) 
            { 
                if (row.IsGroupByRow) 
                { 
                    row.Tag = this.CheckState; 
                    SetAllGridRowSelected(((UltraGridGroupByRow)row).Rows, state); 
                } 
                else 
                { 
                    string selectAllColumnName = (this.Control as ExtendedUltraGrid).SelectAllColumnName; 
                    if (row.Activation == Activation.Disabled) continue; 
                    if (!row.Band.Columns.Exists(selectAllColumnName)) continue; 
                    if (row.Band.Columns[selectAllColumnName].CellActivation == Activation.Disabled) continue; 
                    if (null == row.Cells) continue; 
                    row.Cells[selectAllColumnName].Value = state; 
                    row.Update(); 
                } 
            } 
        } 
    } 
} 
  

P.S. 上面的例子只是提供了一个解决问题的思路，还有一些细节问题。比如，当我应用了一些风格文件之后，发现每当鼠标移至UltraGrid的Select列的列头时，CheckableHeaderCreationFilter的AfterCreateChildElements方法会被调用，并且总是会导致新的CheckBoxUIElement被创建。但是一旦我将不采用风格文件，就不是出现这样的问题。这个问题也同样出现在Infragistics 官方提供的解决方案中，有兴趣的朋友可以从这里下载，并通过StyleManager.Load方法加载某个风格文件，通过Debug你会发现CheckBoxUIElement被频繁创建。Infragistics 提供的例子和我对UltraGrid的扩展方式，本质上是一致的，虽有被创建出来的CheckBoxUIElement会成为垃圾对象，可以被垃圾回收，但是频繁的创建这样的对象总归会对内存造成一定的压力。

作者：蒋金楠
微信公众账号：大内老A
微博： www.weibo.com/artech
如果你想及时得到个人撰写文章以及著作的消息推送，或者想看看个人推荐的技术资料，可以扫描左边二维码（或者长按识别二维码）关注个人公众号（原来公众帐号蒋金楠的自媒体将会停用）。
本文版权归作者和博客园共有，欢迎转载，但未经作者同意必须保留此段声明，且在文章页面明显位置给出原文连接，否则保留追究法律责任的权利。

原文链接

扩展UltraGrid控件实现对所有数据行的全选功能[Source Code下载]

热门文章

最新文章

相关电子书