TemplateDataPager Class

Template data pager.

Inheritance Hierarchy

System.Object
  System.Web.UI.Control
    System.Web.UI.WebControls.WebControl
      CMS.ExtendedControls.CMSWebControl
        CMS.Controls.BasicDataPager
          CMS.Controls.TemplateDataPager

Namespace: CMS.Controls
Assembly: CMS.Controls (in CMS.Controls.dll) Version: 9.0.0

Syntax

public class TemplateDataPager : BasicDataPager

The TemplateDataPager type exposes the following members.

Constructors

	Name	Description
Public method	TemplateDataPager

Fields

	Name	Description
Protected field	mDataSource	DataSource. (Inherited from BasicDataPager.)
Protected field	mMaxPages	Max. pages. (Inherited from BasicDataPager.)
Protected field	mPagedData	Paged data. (Inherited from BasicDataPager.)
Protected field	mPagingMode	Paging mode. (Inherited from BasicDataPager.)
Protected field	mUniqueID	Unique ID. (Inherited from BasicDataPager.)

Properties

	Name	Description
Public property	CurrentPage	Current page number. (Inherited from BasicDataPager.)
Public property	DataSource	Pager DataSource. (Inherited from BasicDataPager.)
Public property	FirstItemTemplate	First item template.
Public property	IsLiveSite	Indicates if control is used on live site. (Inherited from CMSWebControl.)
Public property	LastItemTemplate	Last item tamplate.
Public property	MaxPages	Maximum number of pages to be displayed. (Inherited from BasicDataPager.)
Public property	NextItemTemplate	Next item template.
Public property	NumberRepeater	Number repeater.
Public property	NumberTemplate	Number template.
Public property	PageCount	Page count. (Inherited from BasicDataPager.)
Public property	PagedData	Paged data. (Inherited from BasicDataPager.)
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	PreviousItemTemplate	Previous item template.
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	SelectedNumberTemplate	Selected number template.
Public property	SeparatorTemplate	Number template.
Public property	ShortID	Short ID of the control. (Inherited from CMSWebControl.)
Protected property	TagKey	Overrides the generation of the SPAN tag with custom tag. (Inherited from BasicDataPager.)
Public property	TotalRecords	Total data source records. (Inherited from BasicDataPager.)
Public property	UIContext	Returns control's UI context (Inherited from CMSWebControl.)
Public property	UniqueID	Unique ID. (Inherited from BasicDataPager.)

Methods

	Name	Description
Protected method	CreateChildControls	Creates child controls. (Overrides Control.CreateChildControls().)
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	OnInit	Init event handler. (Inherited from CMSWebControl.)
Protected method	OnPreRender	OnPreRender. (Overrides Control.OnPreRender(EventArgs).)
Public method	RaiseOnDataSourceChanged	Raises the OnDataSourceChanged event. (Inherited from BasicDataPager.)
Public method	RaiseOnPageChange	Raises the OnPageChange event. (Inherited from BasicDataPager.)
Public method	ReloadData	Reloads data for pager with current settings.
Protected method	Render	Render. (Overrides BasicDataPager.Render(HtmlTextWriter).)

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. (Inherited from BasicDataPager.)
Public event	OnPageChange	Page change event. (Inherited from BasicDataPager.)