适用于ASP.NET的自定义分页控件

前段时间的项目中需要使用到分页控件，在网上找了不少，最终还是自己动手写一个，比较简单，后续功能以后再实现，现把代码及思路写下来，望大家批评指正。分页控件的分页形式大多分三种，一种是用URL传值，通过给页面指定QueryString传值当前页的索引；另一种类似于GridView里面的分页方式，通过改变内部的PageIndex分页；还有一种是两种方式都包含，那样功能比较强大，在此不做评论。用URL传值的方式，相当于每点击分页按钮，页面就跳转至一个新的页面，那么页面IsPostBack值每次都是False，如果页面上不需要输入查询条件，那当然是没有问题的，如果查询页面上面要输入一些查询条件，自然用URL传值就不太适用了，至少你得把你输入的查询条件传递到新的URL中。故此，我在做这个控件时用到了用PageIndex传值的方式。首先我用了一个分页的存储过程，代码如下：

 1create  procedure sp_PageList
 2@sqlstr nvarchar(4000), --查询字符串
 3@currentpage int, --第N页
 4@pagesize int --每页行数
 5
 6as
 7set nocount on
 8declare @P1 int, --P1是游标的id
 9 @rowcount int
exec sp_cursoropen @P1 output,@sqlstr,@scrollopt=1,@ccopt=1,@rowcount=@rowcount output
set @currentpage=(@currentpage-1)*@pagesize+1
exec sp_cursorfetch @P1,16,@currentpage,@pagesize 
exec sp_cursorclose @P1
select @rowcount
set nocount off

GO

这个存储过程的执行结果包括三个表，第一个为空表，第二个是查询的结果集，显示的行数为@pagesize设置的大小，第三个是总记录数

下面是分页控件的代码：

 

  1using System;
  2using System.ComponentModel;
  3using System.Text;
  4using System.Web;
  5using System.Web.UI;
  6using System.Web.UI.WebControls;
  7
  8namespace WebControlEx
  9{
 10    [ToolboxData("<{0}:Pager runat=\"server\" ></{0}:Pager>")]
 11    public class Pager : CompositeControl, INamingContainer
 12    {
 13        公共属性#region 公共属性
 14
 15        [Browsable(true), Category("分页"), DefaultValue("0"), Localizable(true), Description("当前页的索引")]
 16        public int PageIndex
 17        {
 18            get
 19            {
 20                return ViewState["PageIndex"] == null ? 0 : (int)ViewState["PageIndex"];
 21            }
 22
 23            set
 24            {
 25                ViewState["PageIndex"] = value;
 26            }
 27        }
 28
 29        [Browsable(true), Category("分页"), DefaultValue("10"), Localizable(true), Description("数据源中每页要显示的行的数目")]
 30        public int PageSize
 31        {
 32            get
 33            {
 34                return ViewState["PageSize"] == null ? 10 : (int)ViewState["PageSize"];
 35            }
 36
 37            set
 38            {
 39                ViewState["PageSize"] = value;
 40            }
 41        }
 42
 43        [Browsable(true), Category("分页"), PersistenceMode(PersistenceMode.InnerProperty), Description("控制与控件关联的分页UI设置"), DesignerSerializationVisibility(DesignerSerializationVisibility.Content), NotifyParentProperty(true)]
 44        public virtual PagerSettings PagerSettings
 45        {
 46            get
 47            {
 48                if (this._pagerSettings == null)
 49                {
 50                    this._pagerSettings = new PagerSettings();
 51                }
 52                return this._pagerSettings;
 53            }
 54        }
 55
 56        [Browsable(true), Category("数据"), DefaultValue("0"), Localizable(true), Description("数据源的总行数")]
 57        public int RecordCount
 58        {
 59            get
 60            {
 61                return ViewState["RecordCount"] == null ? 0 : (int)ViewState["RecordCount"];
 62            }
 63
 64            set
 65            {
 66                ViewState["RecordCount"] = value;
 67            }
 68        }
 69
 70        #endregion
 71
 72        私有属性#region 私有属性
 73
 74        private int PageCount
 75        {
 76            get
 77            {
 78                if (this.RecordCount == 0 || this.PageSize == 0)
 79                    return 0;
 80                return (int)Math.Ceiling(this.RecordCount / (this.PageSize * 1.0));
 81            }
 82        }
 83
 84        #endregion
 85
 86        私有变量#region 私有变量
 87
 88        private static readonly object EventPageIndexChanged = new object();
 89        private PagerSettings _pagerSettings = new PagerSettings();
 90
 91        private LinkButton _lbtnFirst = new LinkButton();
 92        private LinkButton _lbtnPrev = new LinkButton();
 93        private LinkButton _lbtnNext = new LinkButton();
 94        private LinkButton _lbtnLast = new LinkButton();
 95
 96        private TextBox txtPageIndex = new TextBox();
 97
 98        #endregion
 99
        事件相关#region 事件相关

        [Description("Pager_OnPageIndexChanged"), Category("Action")]
        public event EventHandler PageIndexChanged
        {
            add
            {
                base.Events.AddHandler(EventPageIndexChanged, value);
            }
            remove
            {
                base.Events.RemoveHandler(EventPageIndexChanged, value);
            }
        }

        protected void OnPageChanged(EventArgs e)
        {
            EventHandler handler = (EventHandler)Events[EventPageIndexChanged];
            if (handler != null)
            {
                handler(this, e);
            }
        }

        #endregion

        重写基类方法#region 重写基类方法

        protected override void CreateChildControls()
        {
            this.Controls.Clear();

            this._lbtnFirst.Text = this._pagerSettings.FirstPageText;
            this._lbtnFirst.CommandName = "First";
            this._lbtnFirst.Click += new EventHandler(LinkButtion_Click);

            this._lbtnPrev.Text = this._pagerSettings.PreviousPageText;
            this._lbtnPrev.CommandName = "Prev";
            this._lbtnPrev.Click += new EventHandler(LinkButtion_Click);

            this._lbtnNext.Text = this._pagerSettings.NextPageText;
            this._lbtnNext.CommandName = "Next";
            this._lbtnNext.Click += new EventHandler(LinkButtion_Click);

            this._lbtnLast.Text = this._pagerSettings.LastPageText;
            this._lbtnLast.CommandName = "Last";
            this._lbtnLast.Click += new EventHandler(LinkButtion_Click);

            txtPageIndex.Width = 30;
            txtPageIndex.AutoPostBack = true;
            txtPageIndex.TextChanged += new EventHandler(PageIndex_TextChanged);

            this.Controls.Add(this._lbtnFirst);
            this.Controls.Add(this._lbtnPrev);
            this.Controls.Add(this._lbtnNext);
            this.Controls.Add(this._lbtnLast);
            this.Controls.Add(txtPageIndex);

            base.CreateChildControls();
        }

        protected override void Render(HtmlTextWriter writer)
        {
            if (this.PageCount == 1)
                return;
            if (this.CssClass != "")
                writer.Write("<div class=\"{0}\">", this.CssClass);
            else
                writer.Write("<div>");
            if (this.RecordCount == 0)
            {
                writer.Write("对不起，没有查询到相关记录！</div>");
                return;
            }
            writer.Write("<table><tr><td>总记录：<span>{0}</span>条，每页<span>{1}</span>条，当前页：<span>{2}</span>/<span>{3}</span></td>", this.RecordCount, this.PageSize, this.PageIndex + 1, this.PageCount);

            显示首页，上一页#region 显示首页，上一页

            writer.Write("<td>");
            if (this.PageIndex == 0 || this.PageCount == 1)
            {
                _lbtnFirst.Visible = false;
                _lbtnPrev.Visible = false;
            }
            _lbtnFirst.RenderControl(writer);
            writer.Write("</td><td>");
            _lbtnPrev.RenderControl(writer);
            writer.Write("</td>");

            #endregion

            显示下一页，末页#region  显示下一页，末页

            writer.Write("<td>");
            if (this.PageIndex == this.PageCount - 1 || this.PageCount == 1)
            {
                _lbtnNext.Visible = false;
                _lbtnLast.Visible = false;
            }
            _lbtnNext.RenderControl(writer);
            writer.Write("</td><td>");
            _lbtnLast.RenderControl(writer);
            writer.Write("</td>");

            #endregion

            跳转至#region 跳转至

            writer.Write("<td>跳转至：</td><td style=\"width:45px\">");
            txtPageIndex.RenderControl(writer);
            writer.Write("</td></table></div>");

            #endregion
        }
 
        #endregion

        子控件的方法#region 子控件的方法

        private void LinkButtion_Click(object sender, EventArgs e)
        {
            string commandName = (sender as LinkButton).CommandName;
            switch (commandName)
            {
                case "First": this.PageIndex = 0; break;
                case "Prev": this.PageIndex--; break;
                case "Next": this.PageIndex++; break;
                case "Last": this.PageIndex = this.PageCount - 1; break;
            }
            OnPageChanged(e);
        }

        private void PageIndex_TextChanged(object sender, EventArgs e)
        {
            if (txtPageIndex.Text.Trim().Length == 0)
                return;
            int pageIndex = 0;
            if (int.TryParse(txtPageIndex.Text, out pageIndex))
            {
                if (pageIndex < 1)
                    this.PageIndex = 0;
                else if (pageIndex > this.PageCount)
                    this.PageIndex = this.PageCount - 1;
                else
                    this.PageIndex = pageIndex - 1;
            }
            OnPageChanged(e);
        }

        #endregion 
    }
}

 

代码不用多解释，当页数为1时，无任何输出，记录为零时，显示无相关记录的提示，其它情况下输出一个Div 和一个Table,Div是为了样式控制方便而输出的。

下面是用C#代码调用上面分页存储过程的示例

 

/// <summary>
        /// 数据分页
        /// </summary>
        /// <param name="cmdText">Sql语句</param>
        /// <param name="curPage">当前为第几页</param>
        /// <param name="pageSize">每页行数</param>
        /// <param name="pageCount">返回的总页数</param>
        /// <param name="rowCount">返回的总记录数</param>
        /// <returns>返回数据表</returns>
        private DataTable PagerList(string cmdText, int curPage, int pageSize, out int rowCount)
        {
            SqlConnection con = new SqlConnection("server=.;database=dbname;user id=user;password=password");
            DataSet ds = new DataSet();
            SqlDataAdapter da = new SqlDataAdapter("sp_PageList", con);
            da.SelectCommand.CommandType = CommandType.StoredProcedure;
            SqlParameter[] paras = new SqlParameter[]
            {
               new SqlParameter("@sqlstr",SqlDbType.NVarChar,4000),
               new SqlParameter("@currentpage",SqlDbType.Int),
               new SqlParameter("@pagesize",SqlDbType.Int)
            };

            paras[0].Value = cmdText;
            paras[1].Value = curPage;
            paras[2].Value = pageSize;

            foreach (SqlParameter para in paras)
            {
                da.SelectCommand.Parameters.Add(para);
            }
            try
            {
                con.Open();
                da.Fill(ds);
                con.Close();
            }
            catch(Exception ex)
            {
                throw new Exception(ex.Message);
            }

            rowCount = Convert.ToInt32(ds.Tables[2].Rows[0][0]);
            return ds.Tables[1];
        }

public DataTable GetLog(int curPage, int pageSize, out int rowCount)
        {
           return this.PagerList("select *from tb_Log",curPage,pageSize,out rowCount);
       }

 

之后便是将控件拖到页面上，设置PageSize值 绑定数据表到数据控件上

 

public void BindGrid()
        {
            int recordCount =0;
            GridView1.DataSource = this.GetLog(Pager1.PageIndex + 1, Pager1.PageSize,out recordCount);
            GridView1.DataBind();

            Pager1.RecordCount = recordCount;
        }
/// <summary>
        /// 分页控件的分页事件
        /// </summary>
        /// <param name="sender"></param>
        /// <param name="e"></param>
protected void Pager1_PageIndexChanged(object sender, EventArgs e)
        {
            this.BindGrid();
        }

 

至此，该控件从编码到测试就完成了，测试的代码需要大家根据实际环境去调正一下才能运行，总结一下，这个分页控件对数据源、数据绑定控件都不关心，它要做的是传递给数据源当前页的索引值，分页大小，然后接受数据源传递过来的总记录数，至于数据绑定控件，GridView，DataList，Repeater都可以使用这个分页控件。