C# 通用分页用户控件

在Winform中，DataGridView控件常被用来展示列表数据，但是其自身又不带有分页功能，以致使用起来需要自定义分页功能，针对这个问题，编写一个通用版的分页用户控件，以解决DataGridView不能分页问题。

1、先上图，分页控件的最终效果如下图所示。

2、首先添加一个用户控件，命名为：PageControl

public partial class PageControl : UserControl
 {
    public PageControl()
     {
         InitializeComponent();
     }
}

3、定义分页的常用属性：

//每页显示记录数
private int pageSize = 10;
//当前页
private int pageIndex = 1;
//总页数
private int pageCount = 0;
//总记录数
private int totalCount = 0;

public int PageSize { get => pageSize; set => pageSize = value; }
public int PageIndex { get => pageIndex; set => pageIndex = value; }
public int PageCount
{
    get
    {
        if (pageSize != 0)
        {
            pageCount = GetPageCount();
        }
        return pageCount;
    }
    set { pageCount = value; }
}
public int TotalCount { get => totalCount; set => totalCount = value; }

GetPageCount方法

/// <summary>
/// 计算总页数
/// </summary>
/// <returns></returns>
private int GetPageCount()
{
    if (PageSize == 0)
    {
        return 0;
    }
    int pageCount = TotalCount / PageSize;
    if (TotalCount % PageSize == 0)
    {
        pageCount = TotalCount / PageSize;
    }
    else
    {
        pageCount = TotalCount / PageSize + 1;
    }
    return pageCount;
}

4、添加各个按钮的单击事件

/// <summary>
 /// 首页
 /// </summary>
 /// <param name="sender"></param>
 /// <param name="e"></param>
 private void linkFirst_LinkClicked(object sender, LinkLabelLinkClickedEventArgs e)
 {
     PageIndex = 1;
     DrawControl(true);
 }

 /// <summary>
 /// 上一页
 /// </summary>
 /// <param name="sender"></param>
 /// <param name="e"></param>
 private void linkPrev_LinkClicked(object sender, LinkLabelLinkClickedEventArgs e)
 {

     PageIndex = Math.Max(1, PageIndex - 1);
     DrawControl(true);
 }


 /// <summary>
 /// 下一页
 /// </summary>
 /// <param name="sender"></param>
 /// <param name="e"></param>
 private void linkNext_LinkClicked(object sender, LinkLabelLinkClickedEventArgs e)
 {
     PageIndex = Math.Min(PageCount, PageIndex + 1);
     DrawControl(true);
 }

 /// <summary>
 /// 尾页
 /// </summary>
 /// <param name="sender"></param>
 /// <param name="e"></param>
 private void linkLast_LinkClicked(object sender, LinkLabelLinkClickedEventArgs e)
 {

     PageIndex = PageCount;
     DrawControl(true);
 }
/// <summary>
/// 跳转页数限制
/// </summary>
private void txtPageNum_TextChanged(object sender, EventArgs e)
{
    int num = 0;
    if (int.TryParse(txtPageNum.Text.Trim(), out num) && num > 0)
    {
        if (num > PageCount)
        {
            txtPageNum.Text = PageCount.ToString();
        }
    }
}
/// <summary>
/// 跳转指定页
/// </summary>
/// <param name="sender"></param>
/// <param name="e"></param>
private void linkGo_LinkClicked(object sender, LinkLabelLinkClickedEventArgs e)
{
    int num = 0;
    if (int.TryParse(txtPageNum.Text.Trim(), out num) && num > 0)
    {
        PageIndex = num;
        DrawControl(true);
    }
}
/// <summary>
/// PageSzie改变事件
/// </summary>
bool isTextChanged = false;
private void cbbPageSize_SelectedIndexChanged(object sender, EventArgs e)
{
    int num = 0;
    if (!int.TryParse(cbbPageSize.Text.Trim(), out num) || num <= 0)
    {
        num = 10;
        cbbPageSize.Text = "10";
    }
    else
    {
        isTextChanged = true;
    }
    pageSize = num;
    if (isTextChanged)
    {
        isTextChanged = false;
        linkFirst_LinkClicked(null, null);
    }
}

5、定义一个事件，用于在引发分页时，方便外部重新获取数据绑定：

public event EventHandler OnPageChanged; 

6、该类的完整代码，如下：

public partial class PageControl : UserControl
{
   public event EventHandler OnPageChanged;

   public PageControl()
   {
       InitializeComponent();
   }

   //每页显示记录数
   private int pageSize = 10;
   //页序号
   private int pageIndex = 1;
   //总页数
   private int pageCount = 0;
   //总记录数
   private int totalCount = 0;

   public int PageSize { get => pageSize; set => pageSize = value; }
   public int PageIndex { get => pageIndex; set => pageIndex = value; }
   public int PageCount
   {
       get
       {
           if (pageSize != 0)
           {
               pageCount = GetPageCount();
           }
           return pageCount;
       }
       set { pageCount = value; }
   }
   public int TotalCount { get => totalCount; set => totalCount = value; }


   /// <summary>
   /// 计算总页数
   /// </summary>
   /// <returns></returns>
   private int GetPageCount()
   {
       if (PageSize == 0)
       {
           return 0;
       }
       int pageCount = TotalCount / PageSize;
       if (TotalCount % PageSize == 0)
       {
           pageCount = TotalCount / PageSize;
       }
       else
       {
           pageCount = TotalCount / PageSize + 1;
       }
       return pageCount;
   }

   /// <summary>
   /// 首页
   /// </summary>
   /// <param name="sender"></param>
   /// <param name="e"></param>
   private void linkFirst_LinkClicked(object sender, LinkLabelLinkClickedEventArgs e)
   {
       PageIndex = 1;
       DrawControl(true);
   }

   /// <summary>
   /// 上一页
   /// </summary>
   /// <param name="sender"></param>
   /// <param name="e"></param>
   private void linkPrev_LinkClicked(object sender, LinkLabelLinkClickedEventArgs e)
   {

       PageIndex = Math.Max(1, PageIndex - 1);
       DrawControl(true);
   }


   /// <summary>
   /// 下一页
   /// </summary>
   /// <param name="sender"></param>
   /// <param name="e"></param>
   private void linkNext_LinkClicked(object sender, LinkLabelLinkClickedEventArgs e)
   {
       PageIndex = Math.Min(PageCount, PageIndex + 1);
       DrawControl(true);
   }

   /// <summary>
   /// 末页
   /// </summary>
   /// <param name="sender"></param>
   /// <param name="e"></param>
   private void linkLast_LinkClicked(object sender, LinkLabelLinkClickedEventArgs e)
   {

       PageIndex = PageCount;
       DrawControl(true);
   }

   public void DrawControl(int count)
   {
       TotalCount = count;
       DrawControl(false);
   }

   /// <summary>
   /// 页面控件呈现
   /// </summary>
   private void DrawControl(bool callEvent)
   {
       lblTotalPage.Text = new StringBuilder("第 ").Append(PageIndex.ToString()).Append(" / ").Append(PageCount.ToString()).Append(" 页").ToString();
       lblTotalCount.Text = new StringBuilder("共 ").Append(TotalCount.ToString()).Append(" 条").ToString();
       cbbPageSize.Text = PageSize.ToString();

       if (callEvent && OnPageChanged != null)
       {
           OnPageChanged(this, null);//当前分页数字改变时，触发委托事件
       }
       SetFormCtrEnabled();
       if (PageCount <= 1)//有且仅有一页
       {
           linkFirst.Enabled = false;
           linkPrev.Enabled = false;
           linkNext.Enabled = false;
           linkLast.Enabled = false;
           linkGo.Enabled = false;
       }
       else if (PageIndex == 1)//第一页
       {
           linkFirst.Enabled = false;
           linkPrev.Enabled = false;
       }
       else if (PageIndex == PageCount)//最后一页
       {
           linkNext.Enabled = false;
           linkLast.Enabled = false;
       }
   }

   private void SetFormCtrEnabled()
   {
       linkFirst.Enabled = true;
       linkPrev.Enabled = true;
       linkNext.Enabled = true;
       linkLast.Enabled = true;
       linkGo.Enabled = true;
   }

   /// <summary>
   /// enter键功能
   /// </summary>
   private void txtPageNum_KeyPress(object sender, KeyPressEventArgs e)
   {
       linkGo_LinkClicked(null, null);
   }

   /// <summary>
   /// 跳转页数限制
   /// </summary>
   private void txtPageNum_TextChanged(object sender, EventArgs e)
   {
       int num = 0;
       if (int.TryParse(txtPageNum.Text.Trim(), out num) && num > 0)
       {
           if (num > PageCount)
           {
               txtPageNum.Text = PageCount.ToString();
           }
       }
   }

   /// <summary>
   /// 跳转指定页
   /// </summary>
   /// <param name="sender"></param>
   /// <param name="e"></param>
   private void linkGo_LinkClicked(object sender, LinkLabelLinkClickedEventArgs e)
   {
       int num = 0;
       if (int.TryParse(txtPageNum.Text.Trim(), out num) && num > 0)
       {
           PageIndex = num;
           DrawControl(true);
       }
   }



   private void PageControl_Paint(object sender, PaintEventArgs e)
   {
       drawBorder(e);
   }

   private void drawBorder(PaintEventArgs e)
   {
       Color _lineColor = Color.FromArgb(0, 123, 255);
       ControlPaint.DrawBorder(e.Graphics, this.ClientRectangle,
       _lineColor, 1, ButtonBorderStyle.Solid, //左边
　　　　　_lineColor, 1, ButtonBorderStyle.Solid, //上边
　　　　　_lineColor, 1, ButtonBorderStyle.Solid, //右边
　　　　　_lineColor, 1, ButtonBorderStyle.Solid);//底边

   }

   /// <summary>
   /// 每页显示记录数更改事件
   /// </summary>
   bool isTextChanged = false;
   private void cbbPageSize_SelectedIndexChanged(object sender, EventArgs e)
   {
       int num = 0;
       if (!int.TryParse(cbbPageSize.Text.Trim(), out num) || num <= 0)
       {
           num = 10;
           cbbPageSize.Text = "10";
       }
       else
       {
           isTextChanged = true;
       }
       pageSize = num;
       if (isTextChanged)
       {
           isTextChanged = false;
           linkFirst_LinkClicked(null, null);
       }
   }
}

7、分页控件使用介绍
第一步：在winform中拖入一个panel，dock设为fill;在panel上再拖入PageControl控件（重新生成解决方案，该控件会出现在工具栏）dock设为bottom;在panel上再拖入DataGridView控件，dock设为fill
第二步：写分页查询方法和总数查询方法，将两个方法封装在一起并与DataGridView和PageControl绑定

private void loadData()
{
    List<数据对象> pageList = vehicleInOutLogDao.findInPage(查询条件, pageControl1.PageSize, pageControl1.PageIndex);
    int count = vehicleInOutLogDao.findInCount(查询条件);
    dataGridView1.AutoGenerateColumns = false;
    dataGridView1.DataSource = pageList;
    pageControl1.DrawControl(count);
}

第三步：写PageControl的OnPageChanged方法，在该方法内调用一下查询数据的方法即可。

private void pageControl1_OnPageChanged(object sender, EventArgs e)
{
    loadData();
}

至此，通用分页控件及使用介绍完毕。