WinForm輕松實現自定義分頁 （轉載）

轉載至http://xuzhihong1987.blog.163.com/blog/static/267315872011315114240140/

以前都是做web開發，最近接觸了下WinForm，發現WinForm分頁控件好像都沒有，網上搜索了一下，發現有很多網友寫的分頁控件，分頁效果應該都能實現吧，只是其風格都不是很符合我想要的。做web的時候，我習慣了Extjs的Grid分頁效果，所以也想在WinForm中做個類似的效果，所以咬咬牙，做個山寨版本的吧，雖然自己寫費時費力，在項目進度考慮中不是很可取，但是還是特別想山寨一回，做自己喜歡的風格。

按照慣例，還是先看看實現效果圖吧（有圖有真像，才好繼續下文呀）

應用效果：（效果有點難看，因為我是剛裝的

xp系統，還是經典主題，如果換成Win7系統或其他主題，效果還是會很不錯的）

 

我們要做的就是上圖顯示的一個自定義控件，這個效果參考自我做

web開發使用的Extjs之Grid的分頁效果（如下圖）

 

Extjs的動畫效果我們暫時就不實現了，這里只做個外觀看起來想像即可，完全一樣就脫離“山寨”概念了，總要比人家差點吧，誰讓咱是模仿呢！

言歸正傳，我們現在就看看具體怎么實現吧：

 

第一步：先布局

    注：我們創建的是用戶自定義控件，而不是WinForm窗體

就是先做出個顯示效果，這個布局很簡單，在這就不多說，重點就是“首頁、前一頁、后一頁、末頁”圖標，每個圖標分兩種，一是能點擊的高亮效果，一個是灰色不不能點擊。以下是套圖：（大家如果不喜歡，可以去做成自己喜歡的風格圖片）

第二步：編寫分頁代碼

   布局好了，那么第二步我們就要代碼實現正確顯示文字信息，分頁事件，每頁條數選擇事件，公開屬性和事件。以下是完整代碼： 

/// <summary>
/// 聲明委托
/// </summary>
/// <param name="e"></param>
public delegate void EventPagingHandler (EventArgs e);
public partial class Paging : UserControl
{
    public Paging()
    {
        InitializeComponent();
    }
    public event EventPagingHandler EventPaging;
    #region 公開屬性
    private int _pageSize = 50;
    /// <summary>
    /// 每頁顯示記錄數(默認50)
    /// </summary>
    public int PageSize
    {
        get
        {
            return _pageSize;
        }
        set
        {
            if (value > 0)
            {
                _pageSize = value;
            }
            else
            {
                _pageSize = 50;
            }
            this.comboPageSize.Text = _pageSize.ToString();
        }
    }
    private int _currentPage = 1;
    /// <summary>
    /// 當前頁
    /// </summary>
    public int CurrentPage
    {
        get
        {
            return _currentPage;
        }
        set
        {
            if (value > 0)
            {
                _currentPage = value;
            }
            else
            {
                _currentPage = 1;
            }

        }
    }
    private int _totalCount = 0;
    /// <summary>
    /// 總記錄數
    /// </summary>
    public int TotalCount
    {
        get
        {
            return _totalCount;
        }
        set
        {
            if (value >= 0)
            {
                _totalCount = value;
            }
            else
            {
                _totalCount = 0;
            }
            this.lblTotalCount.Text = this._totalCount.ToString();
            CalculatePageCount();
            this.lblRecordRegion.Text = GetRecordRegion();
        }
    }

    private int _pageCount = 0;
    /// <summary>
    /// 頁數
    /// </summary>
    public int PageCount
    {
        get
        {
            return _pageCount;
        }
        set
        {
            if (value >= 0)
            {
                _pageCount = value;
            }
            else
            {
                _pageCount = 0;
            }
            this.lblPageCount.Text = _pageCount + "";
        }
    }
    #endregion

    /// <summary>
    /// 計算頁數
    /// </summary>
    private void CalculatePageCount()
    {
        if (this.TotalCount > 0)
        {
            this.PageCount = Convert.ToInt32 (Math.Ceiling (Convert.ToDouble (this.TotalCount) / Convert.ToDouble (this.PageSize) ) );
        }
        else
        {
            this.PageCount = 0;
        }
    }

    /// <summary>
    /// 獲取顯示記錄區間（格式如：1-50）
    /// </summary>
    /// <returns></returns>
    private string GetRecordRegion()
    {
        if (this.PageCount == 1) //只有一頁
        {
            return "1-" + this.TotalCount.ToString();
        }
        else  //有多頁
        {
            if (this.CurrentPage == 1) //當前顯示為第一頁
            {
                return "1-" + this.PageSize;
            }
            else if (this.CurrentPage == this.PageCount) //當前顯示為最后一頁
            {
                return ( (this.CurrentPage - 1) * this.PageSize + 1) + "-" + this.TotalCount;
            }
            else //中間頁
            {
                return ( (this.CurrentPage - 1) * this.PageSize + 1)   + "-" + this.CurrentPage  * this.PageSize;
            }
        }
    }

    /// <summary>
    /// 數據綁定
    /// </summary>
    public void Bind()
    {
        if (this.EventPaging != null)
        {
            this.EventPaging (new EventArgs() );
        }
        if (this.CurrentPage > this.PageCount)
        {
            this.CurrentPage = this.PageCount;
        }
        this.txtBoxCurPage.Text = this.CurrentPage + "";
        this.lblTotalCount.Text = this.TotalCount + "";
        this.lblPageCount.Text = this.PageCount + "";
        this.lblRecordRegion.Text = GetRecordRegion();
        if (this.CurrentPage == 1)
        {
            this.btnFirst.Enabled = false;
            this.btnPrev.Enabled = false;
            this.btnFirst.Image = global::CHVM.Properties.Resources.page_first_disabled;
            this.btnPrev.Image = global::CHVM.Properties.Resources.page_prev_disabled;
        }
        else
        {
            this.btnFirst.Enabled = true;
            this.btnPrev.Enabled = true;
            this.btnFirst.Image = global::CHVM.Properties.Resources.page_first;
            this.btnPrev.Image = global::CHVM.Properties.Resources.page_prev;
        }
        if (this.CurrentPage == this.PageCount)
        {
            this.btnNext.Enabled = false;
            this.btnLast.Enabled = false;
            this.btnNext.Image = global::CHVM.Properties.Resources.page_next_disabled;
            this.btnLast.Image = global::CHVM.Properties.Resources.page_last_disabled;
        }
        else
        {
            this.btnNext.Enabled = true;
            this.btnLast.Enabled = true;
            this.btnNext.Image = global::CHVM.Properties.Resources.page_next;
            this.btnLast.Image = global::CHVM.Properties.Resources.page_last;
        }
        if (this.TotalCount == 0)
        {
            this.btnFirst.Enabled = false;
            this.btnPrev.Enabled = false;
            this.btnNext.Enabled = false;
            this.btnLast.Enabled = false;
            this.btnFirst.Image = global::CHVM.Properties.Resources.page_first_disabled;
            this.btnPrev.Image = global::CHVM.Properties.Resources.page_prev_disabled;
            this.btnNext.Image = global::CHVM.Properties.Resources.page_next_disabled;
            this.btnLast.Image = global::CHVM.Properties.Resources.page_last_disabled;
        }
    }

    private void btnFirst_Click (object sender, EventArgs e)
    {
        this.CurrentPage = 1;
        this.Bind();
    }

    private void btnPrev_Click (object sender, EventArgs e)
    {
        this.CurrentPage -= 1;
        this.Bind();
    }

    private void btnNext_Click (object sender, EventArgs e)
    {
        this.CurrentPage += 1;
        this.Bind();
    }

    private void btnLast_Click (object sender, EventArgs e)
    {
        this.CurrentPage = this.PageCount;
        this.Bind();
    }

    /// <summary>
    ///  改變每頁條數
    /// </summary>
    /// <param name="sender"></param>
    /// <param name="e"></param>
    private void comboPageSize_SelectedIndexChanged (object sender, EventArgs e)
    {
        this.PageSize = Convert.ToInt32 (comboPageSize.Text);
        this.Bind();
    }
}

這里重點提兩點：一是圖片切換：
this.btnFirst.Image = global::CHVM.Properties.Resources.page_first_disabled;
Image對象是在Properties.Resource.resx中自動生成的，代碼如下：
internal static System.Drawing.Bitmap page_first
{
    get {
        object obj = ResourceManager.GetObject ("page-first", resourceCulture);
        return ( (System.Drawing.Bitmap) (obj) );
    }
}

internal static System.Drawing.Bitmap page_first_disabled
{
    get {
        object obj = ResourceManager.GetObject ("page_first_disabled", resourceCulture);
        return ( (System.Drawing.Bitmap) (obj) );
    }
}
二是應用了委托事件：我們在這定義了一個分頁事件
public event EventPagingHandler EventPaging;
在數據綁定方法中實現它：
/// <summary>
/// 數據綁定
/// </summary>
public void Bind()
{
    if (this.EventPaging != null)
    {
        this.EventPaging (new EventArgs() );
    }
    //… 以下省略
}
這里需要大家對C#的委托和事件有一定的了解，不清楚的可以直接使用，或者先去查閱相關參考資料，這里我們就不談委托機制了。

第三步：應用
值得一提的是，WinForm並不能直接把用戶自定控件往Windows窗體中拖拽，而自動生成實例（ASP.NET是可以直接拖拽的）。那么如果我們需要在應用中使用，只能自己修改Desginer.cs代碼了。
先聲明：
private CHVM.PagingControl.Paging paging1;
然后在InitializeComponent() 方法中實例化：
this.paging1 = new CHVM.PagingControl.Paging();
//
// paging1
//
this.paging1.CurrentPage = 1;
this.paging1.Location = new System.Drawing.Point (3, 347);
this.paging1.Name = "paging1";
this.paging1.PageCount = 0;
this.paging1.PageSize = 50;
this.paging1.Size = new System.Drawing.Size (512, 30);
this.paging1.TabIndex = 8;
this.paging1.TotalCount = 0;
//在這里注冊事件
this.paging1.EventPaging += new CHVM.PagingControl.EventPagingHandler (this.paging1_EventPaging);

 

 

加完后就能看到效果了，相當於托了一個分頁控件的效果：（如下圖所示）

最后在事件中加入分頁事件需要執行的代碼：

 

  1  /// <summary>  2  3 /// 分頁事件  4  5 /// </summary>  6  7 /// <param name="e"></param>  8  9 private void paging1_EventPaging(EventArgs e)  10  11  {  12  13 GvDataBind(); //DataGridView數據綁定  14  15  }  16  17 /// <summary>  18  19 /// 查詢  20  21 /// </summary>  22  23 /// <param name="sender"></param>  24  25 /// <param name="e"></param>  26  27 private void btnQuery_Click(object sender, EventArgs e)  28  29  {  30  31  paging1_EventPaging(e);  32  33  }  34  35 /// <summary>  36  37 /// gvOperateLogList 數據邦定  38  39 /// </summary>  40  41 private void GvDataBind()  42  43  {  44  45 PagingCondition paging = new PagingCondition()  46  47  {  48  49 startIndex=paging1.CurrentPage,  50  51 pageSize = paging1.PageSize  52  53  };  54  55 MultiCondition condition = new MultiCondition();  56  57 condition.DateSign="FOperateTime";  58  59 condition.BeginDate = dtBegin.Value;  60  61 condition.EndDate = dtEnd.Value;  62  63 if (comboOperator.Text != "")  64  65  {  66  67 condition.Dict.Add("FOperator", comboOperator.Text);  68  69  }  70  71 if (comboType.Text != "")  72  73  {  74  75 condition.Dict.Add("FType", comboType.Text);  76  77  }  78  79 if (comboObject.Text != "")  80  81  {  82  83 condition.Dict.Add("FOptObject", comboObject.Text);  84  85  }  86  87 if (txtBoxContent.Text != "")  88  89  {  90  91 condition.Dict.Add("FContent", txtBoxContent.Text);  92  93  }  94  95 DataTable dt = GetByCondition(paging, condition);  96  97 paging1.TotalCount = Convert.ToInt32(dt.TableName);  98  99 gvOperateLogList.DataSource = dt; 100 101  gvOperateLogList.Columns.Clear(); 102 103 var dict = GetGvColumnsDict(); 104 105  DataGridViewHelp.DisplayColList(gvOperateLogList, dict); 106 107 }

 

注：MultiCondition、PagingCondition是我專門針對分頁綜合查詢定義的兩個類，興趣的話可以去了解一下：

查詢條件就統一定義在MultiCondition中（詳見：http://xuzhihong1987.blog.163.com/blog/static/267315872011294150763 ），

PagingCondition是分頁條件（詳見： http://xuzhihong1987.blog.163.com/blog/static/2673158720112941950801 ）,

Extjs+LINQ輕松實現高級綜合查詢：

http://xuzhihong1987.blog.163.com/blog/static/2673158720112943356111/

其他：

 

 1  /// <summary>  2  3 /// gv顯示列設置  4  5 /// </summary>  6  7 /// <returns></returns>  8  9 public Dictionary<string, string> GetGvColumnsDict() 10 11  { 12 13 Dictionary<string, string> dict = new Dictionary<string, string>(); 14 15 dict.Add("FTYPE", "操作類型"); 16 17 dict.Add("FOPTOBJECT", "操作對象"); 18 19 dict.Add("FCONTENT", "操作內容"); 20 21 dict.Add("FOperator", "操作人員"); 22 23 return dict; 24 25  } 26 27 28 29 DataGridViewHelp.DisplayColList是一個靜態方法，為一個輔助類： 30 31 /// <summary> 32 33 /// 替換列表 34 35 /// </summary> 36 37 /// <param name="dgv">類表名稱</param> 38 39 /// <param name="dic">數據</param> 40 41 /// <param name="isRM">是否顯示序列號</param> 42 43 public static void DisplayColList(DataGridView dgv, Dictionary<string, string> dic)//, bool isRM 44 45  { 46 47 _dgv = dgv; 48 49 dgv.RowsDefaultCellStyle.BackColor = Color.FromArgb(255, 255, 255);//第一行 50 51 dgv.AlternatingRowsDefaultCellStyle.BackColor = Color.FromArgb(231, 232, 239);//第二行 52 53 dgv.GridColor = Color.FromArgb(207, 208, 216);// 54 55 dgv.RowTemplate.Height = 25;//列寬 56 57 dgv.AllowUserToAddRows=false;//無空行 58 59 dgv.CellBorderStyle = DataGridViewCellBorderStyle.SingleVertical; 60 61 dgv.AutoSizeColumnsMode = DataGridViewAutoSizeColumnsMode.Fill; 62 63 dgv.AllowUserToOrderColumns = true; 64 65 dgv.RowPostPaint += new DataGridViewRowPostPaintEventHandler(dgv_RowPostPaint); 66 67 dgv.CellPainting += new DataGridViewCellPaintingEventHandler(dgv_CellPainting);//列頭樣式 68 69 dgv.CellFormatting += new DataGridViewCellFormattingEventHandler(dgv_CellFormatting);//選中行樣式 70 71 72 73 foreach (KeyValuePair<string, string> cl in dic) 74 75  { 76 77 dgv.AutoGenerateColumns = false; 78 79 DataGridViewTextBoxColumn obj = new DataGridViewTextBoxColumn(); 80 81 obj.DataPropertyName = cl.Key; 82 83 obj.HeaderText = cl.Value; 84 85 obj.Name = cl.Key; 86 87 obj.Width = 100; 88 89 //obj.DefaultCellStyle.Padding.All = 10; 90 91 obj.Resizable = DataGridViewTriState.True; 92 93 dgv.Columns.AddRange(new DataGridViewColumn[] { obj }); 94 95  } 96 97  } 98 99 

 

到此實現就全部完成了，運行效果后就是前面所示的效果！也可以動態修改每頁條數。

說在最后，改功能簡單是簡單，但是涉及到很多知識點，委托、事件、

DataGridView數據動態綁定，綜合查詢，我這里用的是Oracle數據庫，如果用LINQ語法的話查詢數據會比較方便，寫起代碼也會顯得很優雅。

/// <summary>
/// 獲取條件查詢數據
/// </summary>
/// <param name="paging"></param>
/// <param name="conditon"></param>
/// <returns></returns>
private DataTable GetByCondition (PagingCondition paging, MultiCondition conditon)
{
    string strSql = "select * from TOperateLog ";
    string strSqlGetCount = "select count(1) from TOperateLog ";
    string strWhere = " where 1=1 ";
    if (conditon != null)
    {
        if (conditon.DateSign == "FOperateTime") //操作日期
        {
            if (conditon.BeginDate != DateTime.MinValue)
            {
                strWhere += string.Format (" and FOperateTime>='{0}'", conditon.BeginDate.ToString ("yyyy-MM-dd HH:mm:ss") );
            }
            if (conditon.EndDate != DateTime.MaxValue)
            {
                strWhere += string.Format (" and FOperateTime<='{0}'", conditon.EndDate.AddDays (1).ToString ("yyyy-MM-dd HH:mm:ss") );
            }
        }
        var dict = conditon.Dict;
        if (dict != null)
        {
            foreach (var key in dict.Keys)
            {
                if (key.Equals ("FType") ) //操作類型
                {
                    strWhere += string.Format (" and FType='{0}'", dict[key]);
                }
                if (key.Equals ("FOperator") ) //操作人員
                {
                    strWhere += string.Format (" and FOperator='{0}'", dict[key]);
                }
                else if (key.Equals ("FOptObject") )                        //操作對象
                {
                    strWhere += string.Format (" and FOptObject='{0}'", dict[key]);
                }
                else if (key.Equals ("FContent") ) //操作內容
                {
                    strWhere += string.Format (" and FContent like '%{0}%'", dict[key]);
                }
            }
        }
    }
    strWhere += " order by FOperateTime ";
    strSql += strWhere;
    strSqlGetCount += strWhere;
    if (paging != null)
    {
        if (paging.needPaging)
            //   strSql = string.Format ("select * from ( {0} ) where ROWNUM>={1} and ROWNUM<={2}", strSql, paging.startIndex, paging.startIndex + paging.pageSize - 1);
        strSql = string.Format ("select * from (select T.*,RowNum  RN from ({0})T where ROWNUM <={1}) where RN>={2} ", strSql, paging.startIndex + paging.pageSize - 1, paging.startIndex);
    }
}
DataTable dt = DataCon.Query (strSql).Tables[0];
dt.TableName = DataCon.GetSingle (strSqlGetCount) + "";
return dt;
}