Fork me on GitHub

PagerOptions class

Represents option settings for MvcPager.

Public properties:

NameDescription
ActionNameGets or sets the name of the action method.
AlwaysShowFirstLastPageNumberGets or sets a value indicating whether the first and the last numeric pager items should be displayed.
AutoHideGets or sets a value indicating whether MvcPager should be hidden if there's only one page of data.
ContainerTagNameGets or sets the HTML tag name for the container element of the pager.
ControllerNameGets or sets the name of the controller class.
CssClassGets or sets the css class to be applied to container element of the pager.
CurrentPageNumberFormatStringGets or sets the format string for the current page number.
CurrentPagerItemTemplateGets or sets the html template to be applied to the current page pager item.
DisabledPagerItemTemplateGets or sets the html template to be applied to the disabled pager items.
FirstPageRouteNameGets or sets the route name for the generation of the first page url.
FirstPageTextGets or sets the text displayed for the first page button.
GoToButtonIdGets or sets the id value of the go to button for the page index box, if this property value is not set, pagechanged event will be fired after value of the pager index box is changed(fired by javascript onchange event).
HidePagerItemsGets or sets a value indicating whether MvcPager should be hidden (in case you need to create your own pager UI).
HorizontalAlignGets or sets the horizontal alignment of a MvcPager on the page.
HtmlAttributesGets or sets the object that contains the HTML attributes to set for the MvcPager.
IdGets or sets the ID of the top DOM element that is the container of all pager items.
InvalidPageIndexErrorMessageGets or sets the error message to be displayed when page index is invalid (not a valid integer).
LastPageTextGets or sets the text displayed for the last page pager item.
MaximumPageIndexItemsGets or sets the maximum number of page indices to be displayed within page index dropdownlist, this property value has no effect if page index box is a textbox,
MaximumPageNumberGets or sets the maximum page number limitation, default value is 0, which means maximum page number is calculated from the data to be paged.
MorePagerItemTemplateGets or sets the html template to be applied to the more pager items.
MorePageTextGets or sets the text displayed for the more pager items.
NavigationPagerItemsPositionGets or sets the position of the first, previous, next and last pager items.
NavigationPagerItemTemplateGets or sets the html template to be applied to the first, previous, next and last page pager items.
NextPageTextGets or sets the text displayed for the next page pager item.
NumericPagerItemCountGets or sets the maximum number of the numeric pager items to be displayed.
NumericPagerItemTemplateGets or sets the html template for the numeric pager items.
OnPageIndexErrorGets or sets the Javascript function to call when page index errors occured.
PageIndexBoxIdGets or sets the ID of the page index box (must be textbox or dropdownlist).
PageIndexOutOfRangeErrorMessageGets or sets the error message to be displayed when page index is oute of range (less than 1 or larger than total pages count).
PageIndexParameterNameGets or sets the page index parameter name in the current route.
PageNumberFormatStringGets or sets the format string for all numeric pager items.
PagerItemsSeparatorGets or sets the string used to separate the pager items (default value is   ).
PagerItemTemplateGets or sets the html template to be applied to all pager items.
PrevPageTextGets or sets the text displayed for the previous page pager item.
RouteNameGets or sets the name of the route that is used to generate paging urls.
RouteValuesGets or sets the object that contains the parameters for the route used by MvcPager.
ShowDisabledPagerItemsGets or sets a value indicating whether the disabled pager items should be displayed.
ShowFirstLastGets or sets a value indicating whether the first page and the last page pager items should be displayed.
ShowMorePagerItemsGets or sets a value indicating whether the more pager items should be displayed.
ShowNumericPagerItemsGets or sets a value indicating whether the numeric pager items should be displayed.
ShowPrevNextGets or sets a value indicating whether the previous page and the next page pager items should be displayed.