自定义控件（HolyrongGridView）-扩展GridView控件(2):自定义分页

最新推荐文章于 2018-05-03 03:29:33 发布

holyrong

最新推荐文章于 2018-05-03 03:29:33 发布

阅读量1.5k

点赞数

文章标签：扩展 textbox object string command datagrid

本文链接：https://blog.csdn.net/holyrong/article/details/3669803

版权

1.自定义控件（HolyrongGridView）-扩展GridView控件(1):基础知识

2.自定义控件（HolyrongGridView）-扩展GridView控件(2):自定义分页

二、自定义分页

主要功能简介：在使用数据源控件或通过HolyrongDataBind事件绑定数据的情况下，只要选择了AllowPaging属性为True，并且在CustomPagerSetting属性下把PagingMode设置为HolyrongNumeric或HolyrongTextBox模式，控件会自动实现分页功能，无需程序编写人员再实现PageIndexChanging事件了。

属性说明：

CustomPagerSetting是自定义分页属性

1.PagingMode：自定义分页显示模式，有三个选项：Default，HolyrongNumeric，HolyrongTextBox。如果选择Default，则按GridView默认的设置进行分页而实现CustomPagerSetting下的所有自定义分页。

2.PagingTextFormat：PagingMode不是Default时，分页文本显示格式化字符串,最多包含四个参数{0}-{3},参数说明：{0}每页记录数，{1}：总记录数，{2}：当前页码，{3}总页数。

3.Align：在PagingMode不是Default时，自定义分页栏的水平对齐方式。

4.CssTextBoxToPage：HolyrongTextBox分页模式下“转到第几页”文本框的CSS样式。

5.CssTextBoxPageSize：HolyrongTextBox分页模式下“每页记录数”文本框的CSS样式。

事件说明：

HPageIndexChanging：在PagingMode不是Default时，启用了自定义分页模式时会触发该事件，此时不再触发PageIndexChanging事件。用户可以在分页时通过该事件来处理需要的操作。

InitPager：在启用分页时最初触发的事件，在PagingMode不是Default时，用来代替InitializePager事件触发，一般可以不用该事件。

对GridView分页功能的扩展，可以通过重写OnPageIndexChanging方法来实现，但这里用的是扩展GridView控件(1)中介绍的另一种方式来实现的。主要代码如下：

1、扩展事件：

/// <summary> /// InitPagerHandler事件委托 /// </summary> /// <param name="sender"></param> /// <param name="row">一个 System.Web.UI.WebControls.GridViewRow，表示要初始化的页导航行</param> /// <param name="columnSpan">页导航行应跨越的列数</param> /// <param name="pagedDataSource">一个 System.Web.UI.WebControls.PagedDataSource，表示数据源</param> public delegate void InitPagerHandler(object sender, GridViewRow row, int columnSpan, PagedDataSource pagedDataSource); #region 自定义分页事件 private static readonly object initPagerEventKey = new object(); [Description("自定义分页事件"), Category("Holyrong扩展")] public event InitPagerHandler InitPager { add { Events.AddHandler(initPagerEventKey, value); } remove { Events.RemoveHandler(initPagerEventKey, value); } } /// <summary> /// 触发OnInitPager事件。 /// </summary> /// <param name="row">表示要初始化的页导航行，一个 System.Web.UI.WebControls.GridViewRow。</param> /// <param name="columnSpan">页导航行应跨越的列数</param> /// <param name="pagedDataSource">一个 System.Web.UI.WebControls.PagedDataSource，表示数据源</param> protected virtual void OnInitPager(GridViewRow row, int columnSpan, PagedDataSource pagedDataSource) { InitPagerHandler handler = Events[initPagerEventKey] as InitPagerHandler; if (handler != null) { handler(this, row, columnSpan, pagedDataSource); } } #endregion /// <summary> /// HolyrongPageIndexChangeingHandler事件的委托，用户重写PageIndexChangeing事件。 /// </summary> /// <param name="sender"></param> /// <param name="e"></param> public delegate void HolyrongPageIndexChangeingHandler(object sender, GridViewPageEventArgs e); private static readonly object holyrongPageIndexEventKey = new object(); [Description("在GridView当前页索引正在改变时触发。已经封装了分页时绑定新页码的功能，在启用分页功能时不需再重新绑定GridView页码了。已经实现PageIndexChanging事件，因此不需再触发PageIndexChanging事件。"), Category("Holyrong扩展")] public event HolyrongPageIndexChangeingHandler HPageIndexChanging { add { Events.AddHandler(holyrongPageIndexEventKey, value); } remove { Events.RemoveHandler(holyrongPageIndexEventKey, value); } } protected virtual void OnHPageIndexChanging(GridViewPageEventArgs e) { HolyrongPageIndexChangeingHandler handler = Events[holyrongPageIndexEventKey] as HolyrongPageIndexChangeingHandler; if (handler != null) { handler(this, e); } }

上面的事件定义中为什么要用Events.AddHandler，而不用传统的方式，这个我会在另外的文章中说明，但可以肯定的是这种方式的效率会比传统的方式高。

2、属性的定义：

/// <summary> /// 自定义分页类的实体类。 /// </summary> [ToolboxItem(false)] [TypeConverter(typeof(ExpandableObjectConverter))] public class CustomPagerSet { #region 自定义分页显示模式 private PagingMode _pagingMode = PagingMode.HolyrongTextBox; [Description("自定义分页显示模式"), Category("Holyrong扩展"), NotifyParentProperty(true), DefaultValue(typeof(PagingMode), "HolyrongTextBox")] public virtual PagingMode PagingMode //注意，这个PagingMode 是一个自定义的枚举类型。 { get { return _pagingMode; } set { _pagingMode = value; } } #endregion #region 用holyrong模式时，分页显示的格式 private string _pagingTextFormat = "每页{0}条记录/共{1}条记录,第{2}页/共{3}页"; [Description("PagingMode不是Default时，分页文本显示格式化字符串,最多包含四个参数{0}-{3},参数说明：{0}每页记录数，{1}：总记录数，{2}：当前页码，{3}总页数。"), Category("Holyrong扩展"), NotifyParentProperty(true) ] public virtual string PagingTextFormat { get { return _pagingTextFormat; } set { _pagingTextFormat = value; } } #endregion #region 分页栏对齐方式 private HorizontalAlign _align; [Description("自定义分页栏的水平对齐方式"), Category("Holyrong扩展"), NotifyParentProperty(true)] public HorizontalAlign Align { get { return _align; } set { _align = value; } } #endregion #region “转到第几页”文本框的CSS样式 private string _cssTextBoxToPage = "hrc_TextBoxToPage"; [Description("HolyrongTextBox分页模式下“转到第几页”文本框的CSS样式"), Category("Holyrong扩展"), NotifyParentProperty(true)] public string CssTextBoxToPage { get { return _cssTextBoxToPage; } set { _cssTextBoxToPage = value; } } #endregion #region “每页记录数”文本框的CSS样式 private string _cssTextBoxPageSize = "hrc_TextBoxPageSize"; [Description("HolyrongTextBox分页模式下“每页记录数”文本框的CSS样式"), Category("Holyrong扩展"), NotifyParentProperty(true)] public string CssTextBoxPageSize { get { return _cssTextBoxPageSize; } set { _cssTextBoxPageSize = value; } } #endregion #region /// <summary> /// ToString() /// </summary> /// <returns></returns> public override string ToString() { return ""; } #endregion } private CustomPagerSet _customPagerSet; //自定义分页类对象。 [Description("自定义分页样式，Holyrong扩展"), Category("分页"), DesignerSerializationVisibility(DesignerSerializationVisibility.Content), PersistenceMode(PersistenceMode.InnerProperty)] public virtual CustomPagerSet CustomPagerSettings { get { if (this._customPagerSet == null) { this._customPagerSet = new CustomPagerSet(); } return this._customPagerSet; } set { this._customPagerSet = value; } }

3、分页的实现。这里用到了原GridView类中给LinkButtom定义了的CommandName属性来实现分页。

 
 public class CustomPagerSetFunction:ExtendFunctions
    {
        public CustomPagerSetFunction() : base() { }

        public CustomPagerSetFunction(HolyrongGridView hgv) : base(hgv) { }

        protected override void Execute()
        {
            this._hgv.InitPager += new HolyrongGridView.InitPagerHandler(_hgv_InitPager);
        }

        void _hgv_InitPager(object sender, GridViewRow row, int columnSpan, PagedDataSource pagedDataSource)
        {
            if (this._hgv.CustomPagerSettings.PagingMode == PagingMode.HolyrongNumeric)  //如果是要自定义显示模式(HolyrongNumeric)而不是系统默认模式 
            {
                HolyrongNumeric(row, columnSpan, pagedDataSource);
            }
            else if (this._hgv.CustomPagerSettings.PagingMode == PagingMode.HolyrongTextBox)
            {
                HolyrongTextBox(row, columnSpan, pagedDataSource);
            }
        } 

        #region 显示Holyrong分页模式的分页按钮 

        LinkButton lbtnFirst = new LinkButton();  //首页按钮 
        LinkButton lbtnPrev = new LinkButton();
        LinkButton lbtnNext = new LinkButton();
        LinkButton lbtnLast = new LinkButton();

        LinkButton lbtnGo = new LinkButton();//转到第几页 

        TextBox tbxToPage = new TextBox();  //转到第几页 
        TextBox tbxPageSize = new TextBox(); //每页显示的记录数 

        #region 数字形式 HolyrongNumeric 
        private void HolyrongNumeric(GridViewRow row, int columnSpan, PagedDataSource pagedDataSource)
        {
            TableCell tc = new TableCell();   //用来放置分页控件的一个Table的单元格。 

            row.Controls.Clear();

            tc.Controls.Add(new LiteralControl(" "));

            SetAllPagerLinkButtons(PagingMode.HolyrongNumeric);  //设置“首页 上一页 下一页 末页”按钮的命令和样式等 

            #region 显示每页记录数/总记录数 当前页数/总页数 
            string pageText = String.Format(this._hgv.CustomPagerSettings.PagingTextFormat,
                pagedDataSource.PageSize,
                pagedDataSource.DataSourceCount,
                pagedDataSource.CurrentPageIndex + 1,
                pagedDataSource.PageCount);
            tc.Controls.Add(new LiteralControl(pageText)); 
            #endregion 


            AddFirstPrevLinkButton(ref tc, pagedDataSource); //添加首页，上一页按钮 

            AddNumLinkButton(ref tc, pagedDataSource); //添加数字分页按钮 

            AddLastNextLinkButton(ref tc, pagedDataSource); //添加“下一页”“末页”按钮 

            tc.Controls.Add(new LiteralControl(" "));

            tc.ColumnSpan = columnSpan;
            tc.HorizontalAlign = this._hgv.CustomPagerSettings.Align;
            
            row.Controls.Add(tc);
        } 
        #endregion 

        #region 文本框形式 HolyrongTextBox 
        private void HolyrongTextBox(GridViewRow row, int columnSpan, PagedDataSource pagedDataSource)
        {
            TableCell tc = new TableCell();   //用来放置分页控件的一个Table的单元格。 

            row.Controls.Clear();

            tc.Controls.Add(new LiteralControl(" "));

            AddPageSize(ref tc); //HolyrongTextBox模式下的页码显示 

            SetAllPagerLinkButtons(PagingMode.HolyrongTextBox);  //设置“首页 上一页 下一页 末页”按钮的命令和样式等 
            
            AddFirstPrevLinkButton(ref tc, pagedDataSource); //添加首页，上一页按钮 

            SetToPageTextBox(pagedDataSource); //设置转到第几页文本框 

            tc.Controls.Add(tbxToPage);    //添加转到第几页文本框 
            tc.Controls.Add(new LiteralControl(" "));

            AddLastNextLinkButton(ref tc, pagedDataSource); //添加“下一页”“末页”按钮 

            tc.Controls.Add(new LiteralControl(" "));

            tc.ColumnSpan = columnSpan;
            tc.HorizontalAlign = this._hgv.CustomPagerSettings.Align;

            row.Controls.Add(tc);
        } 
        #endregion 

        #region 设置“首页 上一页 下一页 末页”按钮的命令和样式等 
        private void SetAllPagerLinkButtons(PagingMode pageMode)
        { 
            #region 分页按钮的图片或文字 
            if (!String.IsNullOrEmpty(this._hgv.PagerSettings.FirstPageImageUrl))
            {
                lbtnFirst.Text = "<img src="" + this._hgv.ResolveUrl(this._hgv.PagerSettings.FirstPageImageUrl) + "" mce_src="" + this._hgv.ResolveUrl(this._hgv.PagerSettings.FirstPageImageUrl) + "" alt='首页' border='0'/>";
            }
            else
            {
                lbtnFirst.Text = this._hgv.PagerSettings.FirstPageText;
            }

            if (!String.IsNullOrEmpty(this._hgv.PagerSettings.PreviousPageImageUrl))
            {
                lbtnPrev.Text = "<img src="" + this._hgv.ResolveUrl(this._hgv.PagerSettings.PreviousPageImageUrl) + "" mce_src="" + this._hgv.ResolveUrl(this._hgv.PagerSettings.PreviousPageImageUrl) + "" alt='上一页' border='0'/>";
            }
            else
            {
                lbtnPrev.Text = this._hgv.PagerSettings.PreviousPageText;
            }

            if (!String.IsNullOrEmpty(this._hgv.PagerSettings.NextPageImageUrl))
            {
                lbtnNext.Text = "<img src="" + this._hgv.ResolveUrl(this._hgv.PagerSettings.NextPageImageUrl) + "" mce_src="" + this._hgv.ResolveUrl(this._hgv.PagerSettings.NextPageImageUrl) + "" alt='首页' border='0'/>";
            }
            else
            {
                lbtnNext.Text = this._hgv.PagerSettings.NextPageText;
            }

            if (!String.IsNullOrEmpty(this._hgv.PagerSettings.LastPageImageUrl))
            {
                lbtnLast.Text = "<img src="" + this._hgv.ResolveUrl(this._hgv.PagerSettings.LastPageImageUrl) + "" mce_src="" + this._hgv.ResolveUrl(this._hgv.PagerSettings.LastPageImageUrl) + "" alt='首页' border='0'/>";
            }
            else
            {
                lbtnLast.Text = this._hgv.PagerSettings.LastPageText;
            } 
            #endregion 

            #region 分页按钮命令 
            lbtnFirst.CommandName = "Page";
            lbtnFirst.CommandArgument = "First";
            lbtnPrev.CommandName = "Page";
            lbtnPrev.CommandArgument = "Prev";
            lbtnNext.CommandName = "Page";
            lbtnNext.CommandArgument = "Next";
            lbtnLast.CommandName = "Page";
            lbtnLast.CommandArgument = "Last";

            if (pageMode == PagingMode.HolyrongTextBox)
            {
                lbtnFirst.Command += new CommandEventHandler(lbtnFirst_Command);
                lbtnPrev.Command += new CommandEventHandler(lbtnPrev_Command);
                lbtnNext.Command += new CommandEventHandler(lbtnNext_Command);
                lbtnLast.Command += new CommandEventHandler(lbtnLast_Command);
            } 
            #endregion 
        }

        void lbtnFirst_Command(object sender, CommandEventArgs e)
        {
            tbxToPage.Text = "1";
        }

        void lbtnPrev_Command(object sender, CommandEventArgs e)
        {
            tbxToPage.Text = (this._hgv.PageIndex).ToString();
        }

        void lbtnNext_Command(object sender, CommandEventArgs e)
        {
            tbxToPage.Text = (this._hgv.PageIndex + 2).ToString();
        }

        void lbtnLast_Command(object sender, CommandEventArgs e)
        {
            tbxToPage.Text = this._hgv.PageCount.ToString();
        } 
        #endregion 

        #region 添加“首页”“上一页”按钮 
        /// <summary> 
        /// 添加“首页”“上一页”按钮 
        /// </summary> 
        /// <param name="tc">要在其中添加按钮的TableCell单元格。</param> 
        /// <param name="pagedDataSource">PagedDataSource类型，封装数据绑定控件（如 DataGrid、GridView、DetailsView 和 FormView）的与分页相关的属性，以允许该控件执行分页操作。</param> 
        private void AddFirstPrevLinkButton(ref TableCell tc, PagedDataSource pagedDataSource)
        {
            if (this._hgv.PageIndex <= 0)
                lbtnFirst.Enabled = lbtnPrev.Enabled = false;
            else
                lbtnFirst.Enabled = lbtnPrev.Enabled = true;

            tc.Controls.Add(lbtnFirst);
            tc.Controls.Add(new LiteralControl(" "));
            tc.Controls.Add(lbtnPrev);
            tc.Controls.Add(new LiteralControl(" "));
        } 
        #endregion 

        #region 添加“下一页”“末页”按钮 
        /// <summary> 
        /// 添加“下一页”“末页”按钮 
        /// </summary> 
        /// <param name="tc">要在其中添加按钮的TableCell单元格。</param> 
        /// <param name="pagedDataSource">PagedDataSource类型，封装数据绑定控件（如 DataGrid、GridView、DetailsView 和 FormView）的与分页相关的属性，以允许该控件执行分页操作。</param> 
        private void AddLastNextLinkButton(ref TableCell tc, PagedDataSource pagedDataSource)
        {
            if (this._hgv.PageIndex >= pagedDataSource.PageCount - 1)
                lbtnNext.Enabled = lbtnLast.Enabled = false;
            else
                lbtnNext.Enabled = lbtnLast.Enabled = true;

            tc.Controls.Add(lbtnNext);
            tc.Controls.Add(new LiteralControl(" "));
            tc.Controls.Add(lbtnLast);
            tc.Controls.Add(new LiteralControl(" "));
        } 
        #endregion 

        #region 添加数字分页按钮 
        private void AddNumLinkButton(ref TableCell tc, PagedDataSource pagedDataSource)
        {
            int rightCount = (int)(this._hgv.PagerSettings.PageButtonCount / 2); //当前页页码的右边显示的页码的数量。 
            int leftCount = (int)this._hgv.PagerSettings.PageButtonCount % 2 == 0 ? rightCount - 1 : rightCount;

            for (int i = 0; i < pagedDataSource.PageCount; i++)
            {
                if (pagedDataSource.PageCount > this._hgv.PagerSettings.PageButtonCount)
                {
                    if ((i < pagedDataSource.CurrentPageIndex - leftCount && pagedDataSource.PageCount - 1 - i > this._hgv.PagerSettings.PageButtonCount - 1) ||
                        (i > pagedDataSource.CurrentPageIndex + rightCount && i > this._hgv.PagerSettings.PageButtonCount - 1))
                    {
                        continue;
                    }
                }

                if (i == pagedDataSource.CurrentPageIndex)
                {
                    tc.Controls.Add(new LiteralControl("<span>" + (i + 1).ToString() + "</span>"));
                }
                else
                {
                    LinkButton lb = new LinkButton();
                    lb.Text = (i + 1).ToString();
                    lb.CommandName = "Page";
                    lb.CommandArgument = (i + 1).ToString();

                    tc.Controls.Add(lb);
                }
                tc.Controls.Add(new LiteralControl(" "));
            }
        } 
        #endregion 

        #region 设置转到第几页的文本框 
        private void SetToPageTextBox(PagedDataSource pagedDataSource)
        {
            tbxToPage.ID = "tbxToPage";
            tbxToPage.ToolTip = "输入要转到的页码，大于0的整数。";
            tbxToPage.CssClass = this._hgv.CustomPagerSettings.CssTextBoxToPage;  //CSS样式 
            tbxToPage.AutoPostBack = true;

            int pIndex; //存储文本框中当前页从0开始的索引值 

            if (!String.IsNullOrEmpty(tbxToPage.Text.Trim()))
            {
                try
                {
                    pIndex = Convert.ToInt32(tbxToPage.Text.Trim()) - 1;
                    if (0 <= pIndex && pIndex < pagedDataSource.PageCount)
                    {
                        pagedDataSource.CurrentPageIndex = pIndex;
                    }
                    else if (pIndex < 0)
                    {
                        tbxToPage.Text = "1";
                        pagedDataSource.CurrentPageIndex = 0;
                    }
                    else if (pIndex >= pagedDataSource.PageCount)
                    {
                        tbxToPage.Text = pagedDataSource.PageCount.ToString();
                        pagedDataSource.CurrentPageIndex = pagedDataSource.PageCount - 1;
                    }
                }
                catch (Exception ex)
                {
                    tbxToPage.Focus();
                    throw new ArgumentException("请输入大于0的数字", "转到页码文本框");
                }
            }
            else
            {
                tbxToPage.Text = Convert.ToString(this._hgv.PageIndex + 1);  //显示当前页 
            }

            tbxToPage.TextChanged += new EventHandler(tbxToPage_TextChanged);
        }

        void tbxToPage_TextChanged(object sender, EventArgs e)
        {
            this._hgv.PageIndex = Convert.ToInt32(((TextBox)sender).Text.Trim()) - 1;
            this._hgv.DataBind();
        } 

        #endregion 

        #region 设置每页显示的记录数文本框 
        private void SetPageSizeTextBox()
        {
            tbxPageSize.ID = "tbxPageRecord";
            tbxPageSize.ToolTip = "每页显示的记录数";
            tbxPageSize.CssClass = this._hgv.CustomPagerSettings.CssTextBoxPageSize; //CSS样式 
            tbxPageSize.AutoPostBack = true;
            
            if (!String.IsNullOrEmpty(tbxPageSize.Text.Trim()))
            {
                int pageSize = Convert.ToInt32(tbxPageSize.Text.Trim());

                int Count = GetRecordsCount();

                try
                {
                    if (pageSize <= Count && pageSize > 0)
                    {
                        this._hgv.PageSize = pageSize;
                    }
                    else if (pageSize > Count)
                    {
                        tbxPageSize.Text = Count.ToString();
                        this._hgv.PageSize = Count;
                    }
                    else if (pageSize <= 0)
                    {
                        tbxPageSize.Text = "1";
                        this._hgv.PageSize = 1;
                    }
                }
                catch (Exception ex)
                {
                    throw new ArgumentException("请输入大于0的数字", "每页显示记录数");
                }
            }
            else
            {
                tbxPageSize.Text = this._hgv.PageSize.ToString(); //每页显示记录数 
            }

            tbxPageSize.TextChanged += new EventHandler(tbxPageSize_TextChanged);
        } 
        #endregion 

        #region HolyrongTextBox模式下的页码显示 
        private void AddPageSize(ref TableCell tc)
        {
            SetPageSizeTextBox(); //每页显示记录数文本框设置 

            string pagingTextFormat = this._hgv.CustomPagerSettings.PagingTextFormat;
            string firstPart = null;
            string secPart = null;
            string thirdPart = null;
            int index = pagingTextFormat.IndexOf("{0}");
            if (index >= 0)
            {
                firstPart = pagingTextFormat.Substring(0, index);
                secPart = pagingTextFormat.Substring(index, 3);
                thirdPart = pagingTextFormat.Substring(index + 3);
                thirdPart = String.Format(thirdPart, "",
                    GetRecordsCount(),
                    this._hgv.PageIndex + 1,
                    this._hgv.PageCount);
            }
            tc.Controls.AddAt(1,new LiteralControl(firstPart));
            tc.Controls.AddAt(2,tbxPageSize);
            tc.Controls.AddAt(3,new LiteralControl(thirdPart));

        }

        void tbxPageSize_TextChanged(object sender, EventArgs e)
        {
            this._hgv.PageSize = Convert.ToInt32(((TextBox)sender).Text.Trim());

            this._hgv.PageIndex = 0;
            this._hgv.DataBind();
        } 
        #endregion 

        #region 获取_hgv的记录数 
        private int GetRecordsCount()
        {
            DataTable dt = null;
            object data=this._hgv.DataSource;

            if (this._hgv.DataSource is DataSet)
            {
                dt = ((DataSet)data).Tables[0];
            }
            else if (this._hgv.DataSource is DataTable)
            {
                dt = (DataTable)data;
            }
            else if (this._hgv.DataSource is DataView)
            {
                dt = ((DataView)data).ToTable();
            }

            if (dt != null)
            {
                return dt.Rows.Count;
            }
            else
                return 0;
        } 
        #endregion 

        #endregion 
    }
 