DataPager Class

Control for supporting the data paging within the databound controls.

Inheritance Hierarchy

System.Object
  System.Web.UI.Control
    System.Web.UI.WebControls.WebControl
      CMS.Base.Web.UI.CMSWebControl
        CMS.DocumentEngine.Web.UI.BasicDataPager
          CMS.DocumentEngine.Web.UI.DataPager

Namespace: CMS.DocumentEngine.Web.UI
Assembly: CMS.DocumentEngine.Web.UI (in CMS.DocumentEngine.Web.UI.dll) Version: 13.0.131

Syntax

[SerializableAttribute]
public class DataPager : BasicDataPager, IPostBackEventHandler

The DataPager type exposes the following members.

Constructors

	Name	Description
Public method	DataPager	Constructor.

Fields

	Name	Description
Protected field	mBackNextButtonStyle	Back next button style
Protected field	mBackNextDisplay	Back next display.
Protected field	mBackNextLinkSeparator	Back next link separator
Protected field	mBackNextLocation	Back next location.
Protected field	mBackNextStyle	Back next style.
Protected field	mBackText	BackText.
Protected field	mControlCssClass	Control css class.
Protected field	mControlStyle	Control style.
Protected field	mDataSource	DataSource. (Inherited from BasicDataPager.)
Protected field	mFirstText	FirstText.
Protected field	mHideOnSinglePage	Hide on single page.
Protected field	mIgnoreQueryString	Ignore query string.
Protected field	mLabelStyle	Label style.
Protected field	mLabelText	Label text.
Protected field	mLastText	LastText.
Protected field	mMaxPages	Max. pages. (Inherited from BasicDataPager.)
Protected field	mNextText	NextText.
Protected field	mPagedData	Paged data. (Inherited from BasicDataPager.)
Protected field	mPageNumbersDisplay	Page numbers display.
Protected field	mPageNumbersSeparator	Page numbers separator.
Protected field	mPageNumbersStyle	Page numbers style.
Protected field	mPageNumberStyle	Page number style.
Protected field	mPagerHTMLAfter	After pager html.
Protected field	mPagerHTMLBefore	Befor pager html.
Protected field	mPagerNumbersClass	Number area CSS class.
Protected field	mPagingMode	Paging mode. (Inherited from BasicDataPager.)
Public field	mQueryStringKey	Query string key.
Protected field	mRenderedHtml	Render Html.
Protected field	mResultsClass	Results CSS class.
Protected field	mResultsFormat	Results format.
Protected field	mResultsLocation	Results location.
Protected field	mResultsStyle	Results style.
Protected field	mSectionPadding	Section padding.
Protected field	mSelectedClass	Class of selected page.
Protected field	mSelectedNextClass	Class of selected next.
Protected field	mSelectedPrevClass	Class of selected previous.
Protected field	mShowFirstLast	Show FirstLast.
Protected field	mShowLabel	Show label.
Protected field	mShowPageNumbers	Show page numbers.
Protected field	mSliderSize	Slider size.
Protected field	mUniqueID	Unique ID. (Inherited from BasicDataPager.)
Protected field	mUnselectedClass	Class of unselected page.
Protected field	mUnselectedNextClass	Class of unselected next.
Protected field	mUnselectedPrevClass	Class of unselected previous.
Protected field	mUseSlider	Use slider.

Properties

	Name	Description
Public property	BackNextButtonStyle	BackNext button style.
Public property	BackNextDisplay	BackNext display.
Public property	BackNextLinkSeparator	BackNext link separator.
Public property	BackNextLocation	BackNext location.
Public property	BackNextStyle	BackNext style.
Public property	BackText	Back button/hyperlink text
Public property	ControlCssClass	CSS Class of the pager control.
Public property	Current	Current page number.
Public property	CurrentPage	Current page number. (Inherited from BasicDataPager.)
Public property	DataSource	Pager DataSource. (Overrides BasicDataPager.DataSource.)
Public property	FirstText	First text.
Public property	HideOnSinglePage	If true, the pager is hidden if only one page is displayed.
Public property	IgnoreQueryString	Indicates if QueryString parameters should be ignored.
Public property	InsertKeys	Keys to be added to querystring.
Public property	InsertToUrl	Check if insert is enabled.
Public property	IsLiveSite	Indicates if control is used on live site. (Inherited from CMSWebControl.)
Public property	LabelStyle	Label style.
Public property	LabelText	Label text.
Public property	LastText	Last text.
Public property	MaxPages	Maximum number of pages to be displayed. (Inherited from BasicDataPager.)
Public property	NextText	Next button/hyperlink text
Public property	PageCount	Page count. (Inherited from BasicDataPager.)
Public property	PagedData	Paged data. (Inherited from BasicDataPager.)
Public property	PageNumbersDisplay	Page numbers display mode.
Public property	PageNumbersSeparator	Page numbers separator.
Public property	PageNumbersStyle	Page numbers style.
Public property	PageNumberStyle	Page number style.
Public property	PagerControlStyle	Pager control style.
Public property	PagerHTMLAfter	After pager html.
Public property	PagerHTMLBefore	Before pager html.
Public property	PagerNumberAreaClass	Pager number area CSS class.
Public property	PagerPosition	Pager position. (Inherited from BasicDataPager.)
Public property	PageSize	Page size. (Inherited from BasicDataPager.)
Public property	PagingMode	Determines if PostBack or QueryString should be used for the paging. (Inherited from BasicDataPager.)
Public property	QueryStringKey	Query parameter name for the page index.
Public property	RecordEnd	Index of the last record on current page. (Inherited from BasicDataPager.)
Public property	RecordStart	Index of the first record on current page. (Inherited from BasicDataPager.)
Public property	RemoveFromUrl	Check if remove is enabled.
Public property	RemoveKeys	Keys to remove.
Public property	RenderedHtml	Rendered html ???
Public property	ResultsClass	Results CSS class.
Public property	ResultsFormat	Results text format.
Public property	ResultsLocation	Results location.
Public property	ResultsStyle	Results style.
Public property	SectionPadding	Section padding.
Public property	SelectedClass	Class of selected page.
Public property	SelectedNextClass	Class of selected next.
Public property	SelectedPrevClass	Class of selected prev.
Public property	ShortID	Short ID of the control. (Inherited from CMSWebControl.)
Public property	ShowFirstLast	Show first last labels.
Public property	ShowLabel	Show label.
Public property	ShowPageNumbers	Show page numbers.
Public property	SliderSize	Slider size.
Protected property	TagKey	Overrides the generation of the SPAN tag with custom tag. (Overrides BasicDataPager.TagKey.)
Public property	TotalRecords	Total data source records. (Inherited from BasicDataPager.)
Public property	UniqueID	Unique ID. (Inherited from BasicDataPager.)
Public property	UnselectedClass	Class of unselected page.
Public property	UnselectedNextClass	Class of unselected next.
Public property	UnselectedPrevClass	Class of unselected prev.
Public property	UseSlider	Use slider.

Methods

	Name	Description
Public method	BindToQueryString	Bind to query.
Protected method	BuildButtonNavBack	Build button Back navigation.
Protected method	BuildButtonNavNext	Build button Next navigation.
Public method	BuildControl	Build control.
Protected method	BuildLinkNavBack	Build Back/Next link navigation
Protected method	BuildLinkNavNext	Build link Next navigation.
Protected method	BuildPageNumbers	Build page number links.
Public method	BuildResults	Build results
Protected method	BuildResultsArea	Build results.
Public method	ChangePage	Change page.
Public method	GetBackNextLocation	Returns back/next type based on the given string. (Inherited from BasicDataPager.)
Public method	GetItemDataRow	Returns the DataRow for the given item index. (Inherited from BasicDataPager.)
Public method	GetItemPage	Returns the page of selected item (start with 1) (Inherited from BasicDataPager.)
Public method	GetPagerPosition	Returns the pager position based on the given string. (Inherited from BasicDataPager.)
Public method	GetPagingMode	Returns the paging mode based on the given string. (Inherited from BasicDataPager.)
Public method	GetResultPosition	Returns the result position based on the given string. (Inherited from BasicDataPager.)
Protected method	LoadViewState	Load ViewState. (Overrides WebControl.LoadViewState(Object).)
Public method	OnClick	Invokes delegates registered with the Click event.
Protected method	OnInit	Init event handler. (Inherited from CMSWebControl.)
Public method	ProcessPageIndex	Make same action like PreRender function.
Public method	RaiseOnDataSourceChanged	Raises the OnDataSourceChanged event. (Inherited from BasicDataPager.)
Public method	RaiseOnPageChange	Raises the OnPageChange event. (Inherited from BasicDataPager.)
Public method	RaisePostBackEvent	Method of IPostBackEventHandler that raises change events.
Protected method	Render	Render this control to the output parameter specified. (Overrides BasicDataPager.Render(HtmlTextWriter).)
Protected method	SaveViewState	Save ViewState. (Overrides WebControl.SaveViewState().)
Public method	UpdateQueryStringItem	Updates current URL with new items.

Extension Methods

	Name	Description
Public Extension Method	AddCssClass	Adds CSS class to control. If class is already present, than adding is skipped. Class names are case sensitive. (Defined by ControlsExtensions.)
Public Extension Method	CallHandled	Calls the method handled by the exception handler. If the call doesn't succeed, the problem is reported through parent IExceptionHandler control instead of throwing unhandled exception for the entire page. Returns true, if the call succeeded, otherwise returns false. (Defined by ControlsExtensions.)
Public Extension Method	GetCssClasses	Returns all CSS classes of control. (Defined by ControlsExtensions.)
Public Extension Method	GetRenderedHTML	Returns HTML which would be rendered by control to page. (Defined by ControlsExtensions.)
Public Extension Method	GetString	Gets the string by the specified resource key (Defined by ControlsExtensions.)
Public Extension Method	HasCssClass	Checks whether the control has given CSS class. Class names are case sensitive. (Defined by ControlsExtensions.)
Public Extension Method	RemoveCssClass	Removes all occurrences. Class names are case sensitive. (Defined by ControlsExtensions.)
Public Extension Method	SetCssClasses	Sets CSS classes to the control. Current classes will be overridden. (Defined by ControlsExtensions.)

Events

	Name	Description
Public event	Click	Defines the Click event.
Public event	OnDataSourceChanged	Data source change event. (Inherited from BasicDataPager.)
Public event	OnPageChange	Page change event. (Inherited from BasicDataPager.)
Public event	ViewStateLoaded	Event is raised after view state load.