ASP.NET MVC Paging

We’ve all seen the example “list” actions that return in every row. Sure they are easy to code but also the in real world how often can you get away with that? Most of times you will want to use paging in your results so the user only sees a limited number of results at a time. Luckily there’s a NuGet package for that. It’s called <a href="http://www.nuget.org/List/Packages/PagedList.Mvc" rel="nofollow" target="_blank" title="PagedList.Mvc NuGet Package">PagedList.Mvc</a> and it uses the <a href="http://www.nuget.org/List/Packages/PagedList" rel="nofollow" target="_blank" title="PagedList NuGet Package">PagedList</a> by the same author.<br /> <br /> <div class="separator" style="clear: both; text-align: center;"> <a href="https://blogger.googleusercontent.com/img/b/R29vZ2xl/AVvXsEi-BEnajN1Gp38m7UfXySh5f0Zfmt08OxMT4ZuLYl0zzhyphenhyphenN6LnlRTT44CRlWesWopPXC5xPY0tmPvnm-tfcwSg4pb6imVj6X0G5soAxUR-eCrnqpCGHdSwusaG2vnDR-tL3cXkTxZJG3RhI/s1600/Capture.JPG" imageanchor="1" style="margin-left: 1em; margin-right: 1em;"><img alt="asp net mvc" border="0" height="245" src="https://blogger.googleusercontent.com/img/b/R29vZ2xl/AVvXsEi-BEnajN1Gp38m7UfXySh5f0Zfmt08OxMT4ZuLYl0zzhyphenhyphenN6LnlRTT44CRlWesWopPXC5xPY0tmPvnm-tfcwSg4pb6imVj6X0G5soAxUR-eCrnqpCGHdSwusaG2vnDR-tL3cXkTxZJG3RhI/s400/Capture.JPG" title="asp net mvc" width="400" /></a></div> <br /> To start you will need to install the package using the <b>NuGet package manager</b> in visual studio.<br /> <table border="0" cellpadding="0" cellspacing="0"><tbody> <tr><td class="gutter"><div class="line number1 index0 alt2"> 1</div> </td><td class="code"><div class="container"> <div class="line number1 index0 alt2"> <code class="powershell plain">PM> install-package PagedList.MVC</code></div> </div> </td></tr> </tbody></table> This will add a few things to your project.<br /> <ol> <li>Your application will now reference PagedList and PagedList.Mvc assemblies</li> <li>In the Content folder you will see a new cascading style sheet called PagedList.css</li> <li>In the Scripts folder you will find a new folder called PagedList with Javascript file and Template file</li> </ol> Now you’ve added PagedList.Mvc to your application using it is pretty trivial. You’ll need to use the PagedList namespace. Then add a new parameter to your list action (Index in our example) that accepts a page number. I always default the page number to 1 so that it will work if called without a page number. Finally you’<br /> <div> <div class="syntaxhighlighter csharp" id="highlighter_953779"> <table border="0" cellpadding="0" cellspacing="0"><tbody> <tr><td class="gutter"><div class="line number1 index0 alt2"> 1</div> <div class="line number2 index1 alt1"> 2</div> <div class="line number3 index2 alt2"> 3</div> <div class="line number4 index3 alt1"> 4</div> <div class="line number5 index4 alt2"> 5</div> <div class="line number6 index5 alt1"> 6</div> <div class="line number7 index6 alt2"> 7</div> <div class="line number8 index7 alt1"> 8</div> <div class="line number9 index8 alt2"> 9</div> <div class="line number10 index9 alt1"> 10</div> <div class="line number11 index10 alt2"> 11</div> <div class="line number12 index11 alt1"> 12</div> <div class="line number13 index12 alt2"> 13</div> </td><td class="code"><div class="container"> <div class="line number1 index0 alt2"> <code class="csharp keyword">public</code> <code class="csharp plain">ActionResult Index(</code><code class="csharp keyword">int</code> <code class="csharp plain">page = 1)</code></div> <div class="line number2 index1 alt1"> <code class="csharp plain">{</code></div> <div class="line number3 index2 alt2"> <code class="csharp spaces">    </code><code class="csharp comments">// I do this just in case someone tries to put in 0 or a negative number</code></div> <div class="line number4 index3 alt1"> <code class="csharp spaces">    </code><code class="csharp keyword">if</code> <code class="csharp plain">(page < 1)</code></div> <div class="line number5 index4 alt2"> <code class="csharp spaces">    </code><code class="csharp plain">{</code></div> <div class="line number6 index5 alt1"> <code class="csharp spaces">        </code><code class="csharp plain">page = 1;</code></div> <div class="line number7 index6 alt2"> <code class="csharp spaces">    </code><code class="csharp plain">}</code></div> <div class="line number8 index7 alt1">  </div> <div class="line number9 index8 alt2"> <code class="csharp spaces">    </code><code class="csharp plain">IQueryable<Product> products = MyRepository.FindAllProducts();</code></div> <div class="line number10 index9 alt1"> <code class="csharp spaces">    </code><code class="csharp plain">IPagedList<Product> productPage = products.ToPagedList(page, 5);</code></div> <div class="line number11 index10 alt2">  </div> <div class="line number12 index11 alt1"> <code class="csharp spaces">    </code><code class="csharp keyword">return</code> <code class="csharp plain">View(productPage);</code></div> <div class="line number13 index12 alt2"> <code class="csharp plain">}</code></div> </div> </td></tr> </tbody></table> </div> </div> <h2> What about our view?</h2> <div> <div class="syntaxhighlighter xml" id="highlighter_138930"> <table border="0" cellpadding="0" cellspacing="0"><tbody> <tr><td class="gutter"><div class="line number1 index0 alt2"> 1</div> <div class="line number2 index1 alt1"> 2</div> <div class="line number3 index2 alt2"> 3</div> <div class="line number4 index3 alt1"> 4</div> <div class="line number5 index4 alt2"> 5</div> <div class="line number6 index5 alt1"> 6</div> <div class="line number7 index6 alt2"> 7</div> <div class="line number8 index7 alt1"> 8</div> <div class="line number9 index8 alt2"> 9</div> <div class="line number10 index9 alt1"> 10</div> <div class="line number11 index10 alt2"> 11</div> <div class="line number12 index11 alt1"> 12</div> <div class="line number13 index12 alt2"> 13</div> <div class="line number14 index13 alt1"> 14</div> <div class="line number15 index14 alt2"> 15</div> <div class="line number16 index15 alt1"> 16</div> <div class="line number17 index16 alt2"> 17</div> <div class="line number18 index17 alt1"> 18</div> <div class="line number19 index18 alt2"> 19</div> <div class="line number20 index19 alt1"> 20</div> <div class="line number21 index20 alt2"> 21</div> <div class="line number22 index21 alt1"> 22</div> <div class="line number23 index22 alt2"> 23</div> <div class="line number24 index23 alt1"> 24</div> <div class="line number25 index24 alt2"> 25</div> <div class="line number26 index25 alt1"> 26</div> <div class="line number27 index26 alt2"> 27</div> <div class="line number28 index27 alt1"> 28</div> <div class="line number29 index28 alt2"> 29</div> <div class="line number30 index29 alt1"> 30</div> <div class="line number31 index30 alt2"> 31</div> <div class="line number32 index31 alt1"> 32</div> <div class="line number33 index32 alt2"> 33</div> <div class="line number34 index33 alt1"> 34</div> <div class="line number35 index34 alt2"> 35</div> <div class="line number36 index35 alt1"> 36</div> <div class="line number37 index36 alt2"> 37</div> <div class="line number38 index37 alt1"> 38</div> <div class="line number39 index38 alt2"> 39</div> </td><td class="code"><div class="container"> <div class="line number1 index0 alt2"> <code class="xml plain">@model IPagedList<</code><code class="xml keyword">Product</code><code class="xml plain">></code></div> <div class="line number2 index1 alt1"> <code class="xml plain">@{</code></div> <div class="line number3 index2 alt2"> <code class="xml spaces">    </code><code class="xml plain">ViewBag.Title = "List";</code></div> <div class="line number4 index3 alt1"> <code class="xml plain">}</code></div> <div class="line number5 index4 alt2"> <code class="xml plain">@using PagingDemo.Models;</code></div> <div class="line number6 index5 alt1"> <code class="xml plain">@using PagedList.Mvc;</code></div> <div class="line number7 index6 alt2"> <code class="xml plain">@using PagedList;</code></div> <div class="line number8 index7 alt1">  </div> <div class="line number9 index8 alt2"> <code class="xml plain"><</code><code class="xml keyword">html</code><code class="xml plain">></code></div> <div class="line number10 index9 alt1"> <code class="xml plain"><</code><code class="xml keyword">head</code><code class="xml plain">></code></div> <div class="line number11 index10 alt2"> <code class="xml spaces">    </code><code class="xml plain"><</code><code class="xml keyword">title</code><code class="xml plain">>Paged List Demo</</code><code class="xml keyword">title</code><code class="xml plain">></code></div> <div class="line number12 index11 alt1"> <code class="xml spaces">    </code><code class="xml plain"><</code><code class="xml keyword">link</code> <code class="xml color1">href</code><code class="xml plain">=</code><code class="xml string">"../../Content/PagedList.css"</code> <code class="xml color1">type</code><code class="xml plain">=</code><code class="xml string">"text/javascript"</code> <code class="xml color1">rel</code><code class="xml plain">=</code><code class="xml string">"Stylesheet"</code> <code class="xml plain">/></code></div> <div class="line number13 index12 alt2"> <code class="xml plain"></</code><code class="xml keyword">head</code><code class="xml plain">></code></div> <div class="line number14 index13 alt1"> <code class="xml plain"><</code><code class="xml keyword">body</code><code class="xml plain">></code></div> <div class="line number15 index14 alt2"> <code class="xml plain"><</code><code class="xml keyword">h2</code><code class="xml plain">>Products</</code><code class="xml keyword">h2</code><code class="xml plain">></code></div> <div class="line number16 index15 alt1">  </div> <div class="line number17 index16 alt2"> <code class="xml plain"><</code><code class="xml keyword">table</code><code class="xml plain">></code></div> <div class="line number18 index17 alt1"> <code class="xml spaces">    </code><code class="xml plain"><</code><code class="xml keyword">thead</code><code class="xml plain">></code></div> <div class="line number19 index18 alt2"> <code class="xml spaces">        </code><code class="xml plain"><</code><code class="xml keyword">tr</code><code class="xml plain">></code></div> <div class="line number20 index19 alt1"> <code class="xml spaces">            </code><code class="xml plain"><</code><code class="xml keyword">th</code><code class="xml plain">>#</</code><code class="xml keyword">th</code><code class="xml plain">></code></div> <div class="line number21 index20 alt2"> <code class="xml spaces">            </code><code class="xml plain"><</code><code class="xml keyword">th</code><code class="xml plain">>Name</</code><code class="xml keyword">th</code><code class="xml plain">></code></div> <div class="line number22 index21 alt1"> <code class="xml spaces">            </code><code class="xml plain"><</code><code class="xml keyword">th</code><code class="xml plain">>Price</</code><code class="xml keyword">th</code><code class="xml plain">></code></div> <div class="line number23 index22 alt2"> <code class="xml spaces">        </code><code class="xml plain"></</code><code class="xml keyword">tr</code><code class="xml plain">></code></div> <div class="line number24 index23 alt1"> <code class="xml spaces">    </code><code class="xml plain"></</code><code class="xml keyword">thead</code><code class="xml plain">></code></div> <div class="line number25 index24 alt2"> <code class="xml spaces">    </code><code class="xml plain"><</code><code class="xml keyword">tbody</code><code class="xml plain">></code></div> <div class="line number26 index25 alt1"> <code class="xml spaces">    </code><code class="xml plain">@foreach (Product p in Model)</code></div> <div class="line number27 index26 alt2"> <code class="xml spaces">    </code><code class="xml plain">{</code></div> <div class="line number28 index27 alt1"> <code class="xml spaces">        </code><code class="xml plain"><</code><code class="xml keyword">tr</code><code class="xml plain">></code></div> <div class="line number29 index28 alt2"> <code class="xml spaces">            </code><code class="xml plain"><</code><code class="xml keyword">td</code><code class="xml plain">>@p.ID</</code><code class="xml keyword">td</code><code class="xml plain">></code></div> <div class="line number30 index29 alt1"> <code class="xml spaces">            </code><code class="xml plain"><</code><code class="xml keyword">td</code><code class="xml plain">>@p.Name</</code><code class="xml keyword">td</code><code class="xml plain">></code></div> <div class="line number31 index30 alt2"> <code class="xml spaces">            </code><code class="xml plain"><</code><code class="xml keyword">td</code><code class="xml plain">>@p.Price</</code><code class="xml keyword">td</code><code class="xml plain">></code></div> <div class="line number32 index31 alt1"> <code class="xml spaces">        </code><code class="xml plain"></</code><code class="xml keyword">tr</code><code class="xml plain">></code></div> <div class="line number33 index32 alt2"> <code class="xml spaces">    </code><code class="xml plain">}</code></div> <div class="line number34 index33 alt1"> <code class="xml spaces">    </code><code class="xml plain"></</code><code class="xml keyword">tbody</code><code class="xml plain">></code></div> <div class="line number35 index34 alt2"> <code class="xml plain"></</code><code class="xml keyword">table</code><code class="xml plain">></code></div> <div class="line number36 index35 alt1">  </div> <div class="line number37 index36 alt2"> <code class="xml plain">@Html.PagedListPager(Model, page => Url.Action("Index", new { page }))</code></div> <div class="line number38 index37 alt1"> <code class="xml plain"></</code><code class="xml keyword">body</code><code class="xml plain">></code></div> <div class="line number39 index38 alt2"> <code class="xml plain"></</code><code class="xml keyword">html</code><code class="xml plain">></code></div> </div> </td></tr> </tbody></table> </div> </div> <br />

ASP.NET MVC Paging

We’ve all seen the example “list” actions that return in every row. Sure they are easy to code but also the in real world how often can you...

Full Article »