Introduction
Knowledge Base
API Reference / Server-side / Telerik.Web.UI / GridPagerStyle
New to Telerik UI for ASP.NET AJAX? Start a free 30-day trial

GridPagerStyle

Class

RadGrid and GridTableView use instance of this class to set style of thir PagerItem-s when rendering

Definition

Namespace:Telerik.Web.UI

Assembly:Telerik.Web.UI.dll

Syntax:
C#
public class GridPagerStyle : GridTableItemStyle, IComponent, IDisposable, IStateManager

Inheritance: objectMarshalByRefObjectComponentStyleTableItemStyleGridTableItemStyleGridPagerStyle...

Implements: IComponentIDisposableIStateManager

Inherited Members TableItemStyle.AddAttributesToRender(HtmlTextWriter, WebControl)TableItemStyle.VerticalAlignTableItemStyle.WrapStyle.AddAttributesToRender(HtmlTextWriter)Style.FillStyleAttributes(CssStyleCollection, IUrlResolutionService)Style.GetStyleAttributes(IUrlResolutionService)Style.LoadViewState(object)Style.TrackViewState()Style.SaveViewState()Style.SetBit(int)Style.SetDirty()Style.BackColorStyle.BorderColorStyle.BorderWidthStyle.BorderStyleStyle.CssClassStyle.FontStyle.ForeColorStyle.HeightStyle.IsEmptyStyle.IsTrackingViewStateStyle.RegisteredCssClassStyle.ViewStateStyle.WidthComponent.Dispose()Component.Dispose(bool)Component.GetService(Type)Component.ToString()Component.CanRaiseEventsComponent.EventsComponent.SiteComponent.ContainerComponent.DesignModeComponent.DisposedMarshalByRefObject.MemberwiseClone(bool)MarshalByRefObject.GetLifetimeService()MarshalByRefObject.InitializeLifetimeService()MarshalByRefObject.CreateObjRef(Type)object.Equals(object)object.Equals(object, object)object.ReferenceEquals(object, object)object.GetHashCode()object.GetType()object.MemberwiseClone()...

Properties

AlwaysVisible

Gets or set a value indicating whether the Pager will be visible regardless of the number of items. (See the remarks)

C#
[Bindable(true)]
public bool AlwaysVisible { get; set; }
Property Value:

true, if pager will be displayed, regardless of the number of grid items, othewise false. By fefault it is false.

In order to display the grid pager regardless of the number of records returned and the page size, you should set this property of the corresponding GridTableView to true. Its default value is false.

ChangePageSizeButtonToolTip

The ToolTip that will be applied to the ChangePageSize Button control.

C#
[Bindable(true)]
public string ChangePageSizeButtonToolTip { get; set; }

ChangePageSizeComboBoxTableSummary

The summary attribute that will be applied to the table which holds the ChangePageSize RadComboBox control.

C#
[Bindable(true)]
public string ChangePageSizeComboBoxTableSummary { get; set; }

ChangePageSizeComboBoxToolTip

The ToolTip that will be applied to the input element in the ChangePageSize RadComboBox control.

C#
[Bindable(true)]
public string ChangePageSizeComboBoxToolTip { get; set; }

ChangePageSizeTextBoxToolTip

The ToolTip that will be applied to the ChangePageSize TextBox control.

C#
[Bindable(true)]
public string ChangePageSizeTextBoxToolTip { get; set; }

EnableAllOptionInPagerComboBox

When this property is enabled, the combobox control in the pager will have an "All" option which could be used to display all items without disabling the paging

C#
public bool EnableAllOptionInPagerComboBox { get; set; }

EnableSEOPaging

Get or set a value indicating whether the SEO (Search Engine Optimized) paging enabled

C#
[Bindable(true)]
public bool EnableSEOPaging { get; set; }

FirstPageImageUrl

Gets or sets url for first page image

C#
public virtual string FirstPageImageUrl { get; set; }

FirstPageText

Text that would appear if Mode is PrevNext for 'first' page button

C#
[Bindable(true)]
public string FirstPageText { get; set; }

FirstPageToolTip

ToolTip that would appear if Mode is PrevNext for 'next' page button

C#
[Bindable(true)]
public string FirstPageToolTip { get; set; }

GoToPageButtonToolTip

The ToolTip that will be applied to the GoToPage input element.

C#
[Bindable(true)]
public string GoToPageButtonToolTip { get; set; }

GoToPageTextBoxToolTip

The ToolTip that will be applied to the GoToPage TextBox control.

C#
[Bindable(true)]
public string GoToPageTextBoxToolTip { get; set; }

HorizontalAlign

Gets or sets the horizontal align of the pager. Accepts as values members of the HorizontalAlign enumeration.

C#
public override HorizontalAlign HorizontalAlign { get; set; }
Property Value:

the horizontal align of the pager as a value from the HorizontalAlign enumeration.

Overrides: TableItemStyle.HorizontalAlign

IsDefault

Gets a value indicating whether the default pager will be used, i.e. no customizations have been made.

C#
[Browsable(false)]
public override bool IsDefault { get; }
Property Value:

Returns true if none of the properties have been set.

Overrides: GridTableItemStyle.IsDefault

IsPagerOnBottom

Gets a value indicating whether the pager is displayed on the bottom of the grid.

C#
[Browsable(false)]
public bool IsPagerOnBottom { get; }
Property Value:

Returns true if the pager will be displayed on the bottom of the grid. Otherwise false.

IsPagerOnTop

Gets a value indicating whether the pager is displayed on the top of the grid.

C#
[Browsable(false)]
public bool IsPagerOnTop { get; }
Property Value:

Returns true if the pager will be displayed on the top of the grid. Otherwise false.

LastPageImageUrl

Gets or sets url for first page image

C#
public virtual string LastPageImageUrl { get; set; }

LastPageText

Text that would appear if Mode is PrevNext for 'last' page button

C#
[Bindable(true)]
public string LastPageText { get; set; }

LastPageToolTip

ToolTip that would appear if Mode is PrevNext for 'last' page button

C#
[Bindable(true)]
public string LastPageToolTip { get; set; }

Mode

Gets or sets the mode of Telerik RadGrid Pager. The mode defines what the pager will contain. This property accepts as values only members of the GridPagerMode.

C#
[Bindable(true)]
public GridPagerMode Mode { get; set; }
Property Value:

Returns the pager mode as one of the values of the GridPagerMode Enumeration.

You should have Paging enabled by setting the PageSize property.

NextPageImageUrl

Gets or sets url for Next Page image

C#
public virtual string NextPageImageUrl { get; set; }

NextPagesToolTip

ToolTip that would appear if Mode is PrevNext for 'next' page button

C#
[Bindable(true)]
public string NextPagesToolTip { get; set; }

NextPageText

Text that would appear if Mode is PrevNext for 'next' page button

C#
[Bindable(true)]
public string NextPageText { get; set; }

NextPageToolTip

ToolTip that would appear if Mode is PrevNext for 'next' page button

C#
[Bindable(true)]
public string NextPageToolTip { get; set; }

PageButtonCount

Gets or sets the number of buttons that would be rendered if pager Mode is NumericPages

C#
[Bindable(true)]
public int PageButtonCount { get; set; }
Property Value:

returns the number of button that will be displayed. The default value is 10 buttons.

By default 10 buttons will be displayed. If the number of grid pages is greater than 10, ellipsis will be displayed.

PagerTextFormat

The string used to format the description text that appears in a pager item. See the remarks.

C#
public string PagerTextFormat { get; set; }
Property Value:

The default value is:
Change page: {4} Displaying page {0} of {1}, items {2} to {3} of {5}

The parameters {0) - {4} are mandatory.

Parameter {0} is used to display current page number.
Parameter {1} is total number of pages.
Parameter {2} will be replaced with the number of the first item in the current page.
Parameter {3} will be set to the number of the last item in the current page.
Parameter {4} indicates where pager buttons would appear.
Parameter {5} corresponds to number of all items in the datasource.

PageSizeControlType

Gets or sets the type of the page size drop down control.

C#
public PagerDropDownControlType PageSizeControlType { get; set; }

PageSizeLabelText

The text of the page size label situated before the page size combo.

C#
[Bindable(true)]
public string PageSizeLabelText { get; set; }

PageSizes

int[]

Gets/sets a comma/semicolon delimited list of page size values.

C#
[TypeConverter(typeof(IntegerArrayConverter))]
public int[] PageSizes { get; set; }

Position

Gets or sets the Position of pager item(s).Accepts only values, members of the GridPagerPosition.

C#
[Bindable(true)]
public GridPagerPosition Position { get; set; }
Property Value:

Returns the Pager position as a value, member of the GridPagerPosition Enumeration.

PrevPageImageUrl

Gets or sets url for Previous Page image

C#
public virtual string PrevPageImageUrl { get; set; }

PrevPagesToolTip

ToolTip that would appear if Mode is PrevNext for 'prev' page button

C#
[Bindable(true)]
public string PrevPagesToolTip { get; set; }

PrevPageText

Text that would appear if Mode is PrevNext for 'previous' page button

C#
[Bindable(true)]
public string PrevPageText { get; set; }

PrevPageToolTip

ToolTip that would appear if Mode is PrevNext for 'prev' page button

C#
[Bindable(true)]
public string PrevPageToolTip { get; set; }

SEOPageIndexRouteParameterName

Gets or sets the name of the URL parameter that specifies the page number when SEO paging and routing are enabled.

C#
[Bindable(true)]
public string SEOPageIndexRouteParameterName { get; set; }

SEOPagingQueryStringKey

Gets or sets the SEO paging query string key.

C#
[Bindable(true)]
public string SEOPagingQueryStringKey { get; set; }
Property Value:

The SEO paging query string key.

SEORouteName

Gets or sets the name of the route that is used when SEO paging and routing are enabled.

C#
[Bindable(true)]
public string SEORouteName { get; set; }

ShowPagerText

Gets or sets a value indicating whether the pager text or only the pager buttons will be displayed.

C#
public bool ShowPagerText { get; set; }
Property Value:

true if both pager text and buttons will be displayed, otherwise false. By default it is true.

UseRouting

Gets or sets a value indicating whether URL Routing is enabled for the current web application

C#
[Bindable(true)]
public bool UseRouting { get; set; }

Visible

Gets or sets the visibility of the pager item

C#
[Bindable(true)]
public bool Visible { get; set; }

Methods

CopyFrom(Style)

Duplicates the non-empty style properties of the specified Style into the instance of the TableItemStyle class that this method is called from.

C#
public override void CopyFrom(Style s)
Parameters:sStyle

A Style that represents the style to copy.

Overrides: TableItemStyle.CopyFrom(Style)

MergeWith(Style)

Combines the style properties of the specified Style into the instance of the TableItemStyle class that this method is called from.

C#
public override void MergeWith(Style s)
Parameters:sStyle

A Style that represents the style to combine.

Overrides: TableItemStyle.MergeWith(Style)

Reset()

Removes any defined style elements from the state bag.

C#
public override void Reset()

Overrides: TableItemStyle.Reset()

ShouldSerializeFirstPageImageUrl()

C#
protected virtual bool ShouldSerializeFirstPageImageUrl()
Returns:

bool

ShouldSerializeLastPageImageUrl()

C#
protected virtual bool ShouldSerializeLastPageImageUrl()
Returns:

bool

ShouldSerializeNextPageImageUrl()

C#
protected virtual bool ShouldSerializeNextPageImageUrl()
Returns:

bool

ShouldSerializePrevPageImageUrl()

C#
protected virtual bool ShouldSerializePrevPageImageUrl()
Returns:

bool

In this article
DefinitionPropertiesAlwaysVisibleChangePageSizeButtonToolTipChangePageSizeComboBoxTableSummaryChangePageSizeComboBoxToolTipChangePageSizeTextBoxToolTipEnableAllOptionInPagerComboBoxEnableSEOPagingFirstPageImageUrlFirstPageTextFirstPageToolTipGoToPageButtonToolTipGoToPageTextBoxToolTipHorizontalAlignIsDefaultIsPagerOnBottomIsPagerOnTopLastPageImageUrlLastPageTextLastPageToolTipModeNextPageImageUrlNextPagesToolTipNextPageTextNextPageToolTipPageButtonCountPagerTextFormatPageSizeControlTypePageSizeLabelTextPageSizesPositionPrevPageImageUrlPrevPagesToolTipPrevPageTextPrevPageToolTipSEOPageIndexRouteParameterNameSEOPagingQueryStringKeySEORouteNameShowPagerTextUseRoutingVisibleMethodsCopyFrom(Style)MergeWith(Style)Reset()ShouldSerializeFirstPageImageUrl()ShouldSerializeLastPageImageUrl()ShouldSerializeNextPageImageUrl()ShouldSerializePrevPageImageUrl()
Not finding the help you need?
Contact Support