BasicDataPager 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
          CMS.DocumentEngine.Web.UI.TemplateDataPager

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

Syntax

public class BasicDataPager : CMSWebControl, 
	INamingContainer

The BasicDataPager type exposes the following members.

Constructors

	Name	Description
Public method	BasicDataPager	Constructor.

Fields

	Name	Description
Protected field	mDataSource	DataSource.
Protected field	mMaxPages	Max. pages.
Protected field	mPagedData	Paged data.
Protected field	mPagingMode	Paging mode.
Protected field	mUniqueID	Unique ID.

Properties

	Name	Description
Public property	CurrentPage	Current page number.
Public property	DataSource	Pager DataSource.
Public property	IsLiveSite	Indicates if control is used on live site. (Inherited from CMSWebControl.)
Public property	MaxPages	Maximum number of pages to be displayed.
Public property	PageCount	Page count.
Public property	PagedData	Paged data.
Public property	PagerPosition	Pager position.
Public property	PageSize	Page size.
Public property	PagingMode	Determines if PostBack or QueryString should be used for the paging.
Public property	RecordEnd	Index of the last record on current page.
Public property	RecordStart	Index of the first record on current page.
Public property	ShortID	Short ID of the control. (Inherited from CMSWebControl.)
Protected property	TagKey	Overrides the generation of the SPAN tag with custom tag. (Overrides WebControl.TagKey.)
Public property	TotalRecords	Total data source records.
Public property	UniqueID	Unique ID. (Overrides Control.UniqueID.)

Methods

	Name	Description
Public method	GetBackNextLocation	Returns back/next type based on the given string.
Public method	GetItemDataRow	Returns the DataRow for the given item index.
Public method	GetItemPage	Returns the page of selected item (start with 1)
Public method	GetPagerPosition	Returns the pager position based on the given string.
Public method	GetPagingMode	Returns the paging mode based on the given string.
Public method	GetResultPosition	Returns the result position based on the given string.
Protected method	OnInit	Init event handler. (Inherited from CMSWebControl.)
Public method	RaiseOnDataSourceChanged	Raises the OnDataSourceChanged event.
Public method	RaiseOnPageChange	Raises the OnPageChange event.
Protected method	Render	Render override. (Overrides WebControl.Render(HtmlTextWriter).)
Public method Static member	StringToPagingPlaceTypeEnum	Returns the pager position based on the given string.

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	OnDataSourceChanged	Data source change event.
Public event	OnPageChange	Page change event.