///<summary>
/// Displays a configurable "Go To Page:" form for instances of PagedList.
///</summary>
///<param name="html">This method is meant to hook off HtmlHelper as an extension method.</param>
///<param name="list">The PagedList to use as the data source.</param>
///<param name="formAction">The URL this form should submit the GET request to.</param>
///<param name="options">Formatting options.</param>
///<returns>Outputs the "Go To Page:" form HTML.</returns>
public static HtmlString PagedListGoToPageForm(this Microsoft.AspNet.Mvc.Rendering.IHtmlHelper html,
IPagedList list,
string formAction,
GoToFormRenderOptions options)
{
var form = new TagBuilder("form");
form.AddCssClass("PagedList-goToPage");
form.Attributes.Add("action", formAction);
form.Attributes.Add("method", "get");
var fieldset = new TagBuilder("fieldset");
var label = new TagBuilder("label");
label.Attributes.Add("for", options.InputFieldName);
label.SetInnerText(options.LabelFormat);
var input = new TagBuilder("input");
input.Attributes.Add("type", options.InputFieldType);
input.Attributes.Add("name", options.InputFieldName);
input.Attributes.Add("value", list.PageNumber.ToString());
var submit = new TagBuilder("input");
submit.Attributes.Add("type", "submit");
submit.Attributes.Add("value", options.SubmitButtonFormat);
fieldset.InnerHtml = label.ToString();
fieldset.InnerHtml += input.ToString(TagRenderMode.SelfClosing);
fieldset.InnerHtml += submit.ToString(TagRenderMode.SelfClosing);
form.InnerHtml = fieldset.ToString();
return(new HtmlString(form.ToString()));
}
///<summary>
/// Displays a configurable "Go To Page:" form for instances of PagedList.
///</summary>
///<param name="html">This method is meant to hook off HtmlHelper as an extension method.</param>
///<param name="list">The PagedList to use as the data source.</param>
///<param name="formAction">The URL this form should submit the GET request to.</param>
///<param name="inputFieldName">The querystring key this form should submit the new page number as.</param>
///<returns>Outputs the "Go To Page:" form HTML.</returns>
public static HtmlString PagedListGoToPageForm(this Microsoft.AspNet.Mvc.Rendering.IHtmlHelper html,
IPagedList list,
string formAction,
string inputFieldName)
{
return(PagedListGoToPageForm(html, list, formAction, new GoToFormRenderOptions(inputFieldName)));
}
///<summary>
/// Displays a configurable paging control for instances of PagedList.
///</summary>
///<param name = "html">This method is meant to hook off HtmlHelper as an extension method.</param>
///<param name = "list">The PagedList to use as the data source.</param>
///<param name = "generatePageUrl">A function that takes the page number of the desired page and returns a URL-string that will load that page.</param>
///<param name = "options">Formatting options.</param>
///<returns>Outputs the paging control HTML.</returns>
public static HtmlString PagedListPager(this Microsoft.AspNet.Mvc.Rendering.IHtmlHelper html,
IPagedList list,
Func <int, string> generatePageUrl,
PagedListRenderOptions options)
{
if (options.Display == PagedListDisplayMode.Never || (options.Display == PagedListDisplayMode.IfNeeded && list.PageCount <= 1))
{
return(null);
}
var listItemLinks = new List <TagBuilder>();
//calculate start and end of range of page numbers
var firstPageToDisplay = 1;
var lastPageToDisplay = list.PageCount;
var pageNumbersToDisplay = lastPageToDisplay;
if (options.MaximumPageNumbersToDisplay.HasValue && list.PageCount > options.MaximumPageNumbersToDisplay)
{
// cannot fit all pages into pager
var maxPageNumbersToDisplay = options.MaximumPageNumbersToDisplay.Value;
firstPageToDisplay = list.PageNumber - maxPageNumbersToDisplay / 2;
if (firstPageToDisplay < 1)
{
firstPageToDisplay = 1;
}
pageNumbersToDisplay = maxPageNumbersToDisplay;
lastPageToDisplay = firstPageToDisplay + pageNumbersToDisplay - 1;
if (lastPageToDisplay > list.PageCount)
{
firstPageToDisplay = list.PageCount - maxPageNumbersToDisplay + 1;
}
}
//first
if (options.DisplayLinkToFirstPage == PagedListDisplayMode.Always || (options.DisplayLinkToFirstPage == PagedListDisplayMode.IfNeeded && firstPageToDisplay > 1))
{
listItemLinks.Add(First(list, generatePageUrl, options));
}
//previous
if (options.DisplayLinkToPreviousPage == PagedListDisplayMode.Always || (options.DisplayLinkToPreviousPage == PagedListDisplayMode.IfNeeded && !list.IsFirstPage))
{
listItemLinks.Add(Previous(list, generatePageUrl, options));
}
//text
if (options.DisplayPageCountAndCurrentLocation)
{
listItemLinks.Add(PageCountAndLocationText(list, options));
}
//text
if (options.DisplayItemSliceAndTotal)
{
listItemLinks.Add(ItemSliceAndTotalText(list, options));
}
//page
if (options.DisplayLinkToIndividualPages)
{
//if there are previous page numbers not displayed, show an ellipsis
if (options.DisplayEllipsesWhenNotShowingAllPageNumbers && firstPageToDisplay > 1)
{
listItemLinks.Add(Ellipses(options));
}
foreach (var i in Enumerable.Range(firstPageToDisplay, pageNumbersToDisplay))
{
//show delimiter between page numbers
if (i > firstPageToDisplay && !string.IsNullOrWhiteSpace(options.DelimiterBetweenPageNumbers))
{
listItemLinks.Add(WrapInListItem(options.DelimiterBetweenPageNumbers));
}
//show page number link
listItemLinks.Add(Page(i, list, generatePageUrl, options));
}
//if there are subsequent page numbers not displayed, show an ellipsis
if (options.DisplayEllipsesWhenNotShowingAllPageNumbers && (firstPageToDisplay + pageNumbersToDisplay - 1) < list.PageCount)
{
listItemLinks.Add(Ellipses(options));
}
}
//next
if (options.DisplayLinkToNextPage == PagedListDisplayMode.Always || (options.DisplayLinkToNextPage == PagedListDisplayMode.IfNeeded && !list.IsLastPage))
{
listItemLinks.Add(Next(list, generatePageUrl, options));
}
//last
if (options.DisplayLinkToLastPage == PagedListDisplayMode.Always || (options.DisplayLinkToLastPage == PagedListDisplayMode.IfNeeded && lastPageToDisplay < list.PageCount))
{
listItemLinks.Add(Last(list, generatePageUrl, options));
}
if (listItemLinks.Any())
{
//append class to first item in list?
if (!string.IsNullOrWhiteSpace(options.ClassToApplyToFirstListItemInPager))
{
listItemLinks.First().AddCssClass(options.ClassToApplyToFirstListItemInPager);
}
//append class to last item in list?
if (!string.IsNullOrWhiteSpace(options.ClassToApplyToLastListItemInPager))
{
listItemLinks.Last().AddCssClass(options.ClassToApplyToLastListItemInPager);
}
//append classes to all list item links
foreach (var li in listItemLinks)
{
foreach (var c in options.LiElementClasses ?? Enumerable.Empty <string>())
{
li.AddCssClass(c);
}
}
}
//collapse all of the list items into one big string
var listItemLinksString = listItemLinks.Aggregate(
new StringBuilder(),
(sb, listItem) => sb.Append(listItem.ToString()),
sb => sb.ToString()
);
var ul = new TagBuilder("ul")
{
InnerHtml = listItemLinksString
};
foreach (var c in options.UlElementClasses ?? Enumerable.Empty <string>())
{
ul.AddCssClass(c);
}
var outerDiv = new TagBuilder("div");
foreach (var c in options.ContainerDivClasses ?? Enumerable.Empty <string>())
{
outerDiv.AddCssClass(c);
}
outerDiv.InnerHtml = ul.ToString();
return(new HtmlString(outerDiv.ToString()));
}
///<summary>
/// Displays a configurable "Go To Page:" form for instances of PagedList.
///</summary>
///<param name="html">This method is meant to hook off HtmlHelper as an extension method.</param>
///<param name="list">The PagedList to use as the data source.</param>
///<param name="formAction">The URL this form should submit the GET request to.</param>
///<returns>Outputs the "Go To Page:" form HTML.</returns>
public static HtmlString PagedListGoToPageForm(this Microsoft.AspNet.Mvc.Rendering.IHtmlHelper html,
IPagedList list,
string formAction)
{
return(PagedListGoToPageForm(html, list, formAction, "page"));
}
///<summary>
/// Displays a configurable paging control for instances of PagedList.
///</summary>
///<param name = "html">This method is meant to hook off HtmlHelper as an extension method.</param>
///<param name = "list">The PagedList to use as the data source.</param>
///<param name = "generatePageUrl">A function that takes the page number of the desired page and returns a URL-string that will load that page.</param>
///<returns>Outputs the paging control HTML.</returns>
public static HtmlString PagedListPager(this Microsoft.AspNet.Mvc.Rendering.IHtmlHelper html,
IPagedList list,
Func <int, string> generatePageUrl)
{
return(PagedListPager(html, list, generatePageUrl, new PagedListRenderOptions()));
}
