I was looking for a pagination class to use in ASP.NET MVC. I found ASP.NET MVC: PagedList<T> and ASP.NET MVC - Pagination View User Control. But I wanted an easier and customizable pagination class. I have developed many projects using the CodeIgniter framework and that time I found their pagination class is better and easier to use. So, I have decided to prepare a pagination class like this for ASP.NET MVC.
Using the Code
In your controller, to get your current (i.e. selected) page number page put this code snippet.
string pageString = "";
pageString = Request.Url.Segments;
pageString = null;
int page = (String.IsNullOrEmpty(pageString)) ? 1 : Int32.Parse(pageString);
Here 3 is the segment which holds the page number. It can vary as per your URL.
Then use the pagination class as shown in the following example.
Pagination pagination = new Pagination();
pagination.BaseUrl = "/Users/List/";
pagination.TotalRows = totalRows;
pagination.CurPage = page;
pagination.PerPage = 10;
string pageLinks = pagination.GetPageLinks();
int start = (page - 1) * pagination.PerPage;
int offset = pagination.PerPage;
BaseUrl you can write a full path like http://www.sitename.com/Controller/Action/ or relative path like /Controller/Action/. Here
start is the number from which row should be counted and
offset is the number of rows that should be returned.
totalRows is the total number of rows.
Now you can use this
pageLinks string which is the generated page link.
Next, set your data in the
ViewData like the following.
ViewData["title"] = "Pagination in Asp.Net Mvc";
ViewData["totalRows"] = totalRows;
ViewData["result"] = result;
ViewData["pageLinks"] = pageLinks;
totalRows is the total number of rows and
result is the desired resultset.
In view page, you can show the page link as follows:
<% if ((string)ViewData["pageLinks"] != "")
<%= ViewData["pageLinks"] %>
<br /><br />
<% } %>
You can create a model and make two methods to get total rows and the data from table using LINQ, as shown in the following example.
public int GetTotalUsers()
return new MyDataContext().Users.Count();
public List<User> GetUsers(int start, int offset)
var users = new MyDataContext().Users.Skip(start)
|Full or relative URL to the controller/action (Mandatory).|
|Total number of rows in your resultset (Mandatory).|
|Current page number, default 1 (Mandatory).|
|Number of items you want to show per page (Optional).|
|Number of "digit" links before and after the current page number (Optional).|
|Item type enumeration value (Optional).|
|The text to be shown in the "first" link on the left.|
|The text to be shown in the "next" page link.|
|The text to be shown in the "previous" page link.|
|The text to be shown in the "last" link on the right.|
|The opening tag placed on the left side of the entire result.|
|The closing tag placed on the right side of the entire result.|
|The opening tag for the "first" link.|
|The closing tag for the "first" link.|
|The opening tag for the "last" link.|
|The closing tag for the "last" link.|
|The opening tag for the "current" link.|
|The closing tag for the "current" link.|
|The opening tag for the "next" link.|
|The closing tag for the "next" link.|
|The opening tag for the "previous" link.|
|The closing tag for the "previous" link.|
|The opening tag for the "digit" link.|
|The closing tag for the "digit" link.|
|The opening tag for the "Item".|
|The closing tag for the "Item".|
You can set
configuration settings in three ways.
- Set as regular property is set. Example:
objPagination.PerPage = 10;
objPagination.PrevLink = "Prev";
objPagination.NextLink = "Next";
- Put a
Pagination.xml file in
Content folder and create object of
Pagination class as:
Pagination objPagination = new Pagination(true);
Pagination.xml file should be as following pattern as example.
- Create any XML file like the above
Pagination.xml file and call the method
LoadPaginationXml with the file full path as argument. Example:
Different Types of Pagination
By this pagination class you can build different types of page links for your page. Just call the method
GetPageLinks with your desired
PaginationType as an argument. Example:
You can display item set or item type as follows:
objPagination.ItemType = ItemTypes.Page;
I think thats enough to use this
pagination class easily. Bye for this time.