Fork me on GitHub

AspNetPager documentation

Classes:

NameDescription
AspNetPager Custom paging control for ASP.NET web form application.
PageChangingEventArgs Provides data for the PageChanging event.

AspNetPager Properties:

NameDescription
AlwaysShowGets or sets a value indicating whether AspNetPager is always shown even there's only one page of data. The default value is false.
AlwaysShowFirstLastPageNumberGets or sets a value indicating whether the first and last numeric paging buttons are always shown.
ButtonImageAlignGets or sets the horizontal alignment of the image buttons.
ButtonImageExtensionGets or sets the image file extension of paging buttons, such as "gif" or "jpg".
ButtonImageNameExtensionGets or sets the image file name extension of paging buttons.
CloneFromGets or sets the AspNetPager control id that need to be cloned to the current AspNetPager.
CpiButtonImageNameExtensionGets or sets the image file name extension of the current page paging button.
CssClassGets or sets the Cascading Style Sheet (CSS) class rendered by the AspNetPager control on the client.
CurrentPageButtonClassGets or sets the css class name to be applied to the current page paging button.
CurrentPageButtonPositionGets or sets the position of the current page paging button.
CurrentPageButtonStyleGets or sets the css styles to be applied to the current page paging button.
CurrentPageButtonTextFormatStringGets or sets the text formatting to be applied to the current page paging button.
CurrentPageIndexGets or sets the current page index.
CustomInfoClassGets or sets the css class name to be applied to the custom info region.
CustomInfoHTMLGets or sets the HTML to be displayed in the custom info region.
CustomInfoSectionWidthGets or sets the width of the custom info region.
CustomInfoStyleGets or sets the css styles to be applied to the custom info region.
CustomInfoTextAlignGets or sets how text is aligned in the custom info region.
DisabledButtonImageNameExtensionGets or sets the image file name extension of the disabled paging buttons.
EnableThemingGets or sets a value indicating whether themes apply to the AspNetPager control.
EnableUrlRewritingGets or sets a value indicating whether url rewriting is enabled.
EndRecordIndexGets the index of the last record that is displayed on a page of data.
FirstLastButtonsClassGets or sets the css class name to be applied to the first and last paging buttons.
FirstLastButtonsStyleGets or sets the css styles to be applied to the first and last paging buttons.
FirstPageTextGets or sets the text to display for the first-page button.
FirstPageUrlRewritePatternGets or sets the url rewrite pattern for the url of the first page when in url paging mode.
ImagePathGets or sets the image path when paging button type is set to image.
InvalidPageIndexErrorMessageGets or sets the error message displayed to the client when user entered page index is not valid.
LastPageTextGets or sets the text to display for the last-page button.
LayoutTypeGets or sets the layout type of the AspNetPager control.
MoreButtonsClassGets or sets the css class name to be applied to the more... paging button.
MoreButtonsStyleGets or sets the css styles to be applied to the more... paging button.
MoreButtonTypeGets or sets the type of the more... paging buttons.
NavigationButtonsPositionGets or sets the position of the First,Prev,Next and Last navigation paging buttons.
NavigationButtonTypeGets or sets the type of navigation buttons(first/last/prev/next).
NavigationToolTipTextFormatStringGets or sets the formatting to be applied to the navigation tooltip, for example "go to page {0}".
NewPageIndexGets the page index user entered or selected from the page index box.
NextPageTextGets or sets the text to display for the next-page button.
NumericButtonCountGets or sets the number of numeric page buttons to display in the AspNetPager.
NumericButtonTextFormatStringGets or sets the text formatting to be applied to the numeric paging buttons, for example "[{0}]" or "-{0}-".
NumericButtonTypeGets or sets the type of the numeric paging buttons.
PageCountGets the total page count.
PageIndexBoxClassGets or sets the css class name to be applied to the page index box.
PageIndexBoxStyleGets or sets the css styles to be applied to the page index box.
PageIndexBoxTypeGets or sets the type of page index box.
PageIndexOutOfRangeErrorMessageGets or sets the error message displayed to the client when user entered page index is out of range.
PageSizeGets or sets the number of records to display on a page.
PagesRemainGets the remaining page numbers after current page.
PagingButtonLayoutTypeGets or sets the layout type of all paging buttons.
PagingButtonsClassGets or sets the css class name to be applied to the paging buttons.
PagingButtonSpacingGets or sets the amount of horizontal spacing between paging buttons.
PagingButtonsStyleGets or sets the css styles to be applied to the paging buttons.
PagingButtonTypeGets or sets the type of numeric paging buttons, can be either text or image, default value is text.
PrevNextButtonsClassGets or sets the css class name to be applied to the prev and next paging buttons.
PrevNextButtonsStyleGets or sets the css styles to be applied to the prev and next paging buttons.
PrevPageTextGets or sets the text to display for the prev-page button.
RecordCountGets or sets the total records count to be paged.
RecordsRemainGets or sets the total remaining records after current page.
ReverseUrlPageIndexGets or sets a value indicating whether url page index is reversed when in url paging mode.
ShowBoxThresholdGets or sets the maxinum page number threashold to display page index box.
ShowCustomInfoSectionGets or sets the display mode of the custom info section.
ShowDisabledButtonsGets or sets a value indicating whether disabled buttons are displayed.
ShowFirstLastGets or sets a value indicating whether the first and last paging buttons are displayed.
ShowMoreButtonsGets or sets a value indicating whether the more... paging buttons are displayed.
ShowNavigationToolTipGets or sets a value indicating whether tooltips are shown when the mouse moves over paging elements.
ShowPageIndexGets or sets a value indicating whether the page index box is displayed.
ShowPageIndexBoxGets or sets the display mode for the page index box.
ShowPrevNextGets or sets a value indicating whether the prev and next paging buttons are displayed.
SkinIDGets or sets the skin to apply to the control.
StartRecordIndexGets the index of the first record that is displayed on a page of data.
SubmitButtonClassGets or sets the css class name to be applied to the submit button.
SubmitButtonImageUrlGets or sets the url of the submit button image. The default is null.
SubmitButtonStyleGets or sets the css styles to be applied to the submit button.
SubmitButtonTextGets or sets the text displayed on the submit button.
TextAfterPageIndexBoxGets or sets the text after page index box.
TextBeforePageIndexBoxGets or sets the text before page index box.
UrlPageIndexNameGets or sets the url parameter name for the page index when in url paging mode. Default value is "page".
UrlPageSizeNameGets or sets the page size parameter name in url. If the value of this property is not null and great than 0, then the PageSize property will use this value as the default value.
UrlPagingGets or sets a value indicating whether url paging is enabled.
UrlPagingTargetGets or sets the name of the target window or frame that the page should open in.
UrlRewritePatternGets or sets the url rewrite pattern for paging urls generation when in url paging mode.
WrapGets or sets a value indicating whether the content wraps within the AspNetPager.

AspNetPager Events:

NameDescription
PageChangingOccurs when one of the pager buttons is clicked, but before the AspNetPager control handles the paging operation.
PageChangedOccurs when one of the pager buttons is clicked, but after the control handles the paging operation.

AspNetPager Methods:

NameDescription
AddAttributesToRenderOverwrite the System.Web.UI.WebControls.WebControl.AddAttributesToRender method.
GoToPageRaises the PageChanging and PageChanged events, jump to specified page.
LoadPostDataImplements IPostBackDataHandler interface, processes postback data for the AspNetPager control.
OnInitOverwrite the System.Web.UI.Control.OnInit method.
OnLoadOverwrite the System.Web.UI.Control.OnLoad method.
OnPageChangedRaises the PageChanged event.
OnPageChangingRaises the PageChanging event.
OnPreRenderoverwrite the System.Web.UI.Control.OnPreRender method.
RaisePostBackEventImplements IPostBackEventHandler Interface, notifies the AspNetPager control that caused the postback that it should handle an incoming postback event.
RaisePostDataChangedEventImplements IPostBackDataHandler interface, signals the AspNetPager control to notify the ASP.NET application that the state of the control has changed.
RenderBeginTagOverwrite the System.Web.UI.WebControls.WebControl.RenderBeginTag" method.
RenderContentsOverwrite the System.Web.UI.WebControls.WebControl.RenderContents method.
RenderEndTagOverwrite the System.Web.UI.WebControls.WebControl.RenderEndTag method.

Enums:

NameDescription
LayoutTypeSpecifies the layout type of the AspNetPager control.
NavigationButtonPositionSpecifies the position of the navigation buttons.
PageIndexBoxTypeSpecifies the type of the page index box.
PagingButtonLayoutTypeSpecifies the layout type of the paging buttons.
PagingButtonPositionSpecifies the position of the current page paging button.
PagingButtonTypeSpecifies the type of paging buttons.
ShowCustomInfoSectionSpecifies the display mode of the custom info section.
ShowPageIndexBoxSpecifies the display mode for the page index box.

Delegates:

NameDescription
PageChangingEventHandlerRepresents the method that will handle the PageChanging event.