Back to all docs
API Reference / Kendo.Mvc.UI.Fluent / PagerBuilder
New to Telerik UI for ASP.NET MVC? Start a free 30-day trial

PagerBuilder

Class

Defines the fluent API for configuring the Kendo Pager for ASP.NET MVC.

Definition

Namespace:Kendo.Mvc.UI.Fluent

Assembly:Kendo.Mvc.dll

Syntax:
C#
public class PagerBuilder : WidgetBuilderBase<Pager, PagerBuilder>, IHtmlString

Inheritance: objectWidgetBuilderBase<Pager, PagerBuilder>PagerBuilder

Implements: IHtmlString

Inherited Members WidgetBuilderBase<Pager, PagerBuilder>.ToComponent()WidgetBuilderBase<Pager, PagerBuilder>.Name(string)WidgetBuilderBase<Pager, PagerBuilder>.Deferred(bool)WidgetBuilderBase<Pager, PagerBuilder>.ModelMetadata(ModelMetadata)WidgetBuilderBase<Pager, PagerBuilder>.HtmlAttributes(object)WidgetBuilderBase<Pager, PagerBuilder>.HtmlAttributes(IDictionary<string, object>)WidgetBuilderBase<Pager, PagerBuilder>.AsModule(bool)WidgetBuilderBase<Pager, PagerBuilder>.Render()WidgetBuilderBase<Pager, PagerBuilder>.ScriptAttributes(object, bool)WidgetBuilderBase<Pager, PagerBuilder>.ScriptAttributes(IDictionary<string, object>, bool)WidgetBuilderBase<Pager, PagerBuilder>.ToHtmlString()WidgetBuilderBase<Pager, PagerBuilder>.ToClientTemplate()WidgetBuilderBase<Pager, PagerBuilder>.ToString()WidgetBuilderBase<Pager, PagerBuilder>.Componentobject.GetType()object.MemberwiseClone()object.ToString()object.Equals(object)object.Equals(object, object)object.ReferenceEquals(object, object)object.GetHashCode()...

Constructors

PagerBuilder(Pager)

Initializes a new instance of the Pager class.

C#
public PagerBuilder(Pager component)
Parameters:componentPager

The component.

Methods

AdaptiveMode(AdaptiveMode)

Specifies a value whether the page sizes dropdown will be adaptive

C#
public PagerBuilder AdaptiveMode(AdaptiveMode value)
Parameters:valueAdaptiveMode

The value that configures the adaptivemode.

Returns:

PagerBuilder

ARIATemplate(string)

Specifies a template used to populate the value of the aria-label attribute of the pager element.The parameters available for the template are: page - The current page. or totalPages - The total number of pages..

C#
public PagerBuilder ARIATemplate(string value)
Parameters:valuestring

The value that configures the ariatemplate.

Returns:

PagerBuilder

ARIATemplate<TModel>(TemplateBuilder<TModel>)

Specifies a template used to populate the value of the aria-label attribute of the pager element.The parameters available for the template are: page - The current page. or totalPages - The total number of pages..

C#
public PagerBuilder ARIATemplate<TModel>(TemplateBuilder<TModel> template)
Parameters:templateTemplateBuilder<TModel>

A Template component that configures the ariatemplate.

Returns:

PagerBuilder

ARIATemplateHandler(string)

Specifies a template used to populate the value of the aria-label attribute of the pager element.The parameters available for the template are: page - The current page. or totalPages - The total number of pages..

C#
public PagerBuilder ARIATemplateHandler(string value)
Parameters:valuestring

The value that configures the ariatemplate.

Returns:

PagerBuilder

ARIATemplateId(string)

Specifies a template used to populate the value of the aria-label attribute of the pager element.The parameters available for the template are: page - The current page. or totalPages - The total number of pages..

C#
public PagerBuilder ARIATemplateId(string value)
Parameters:valuestring

The value that configures the ariatemplate.

Returns:

PagerBuilder

ARIATemplateView(MvcHtmlString)

Specifies a template used to populate the value of the aria-label attribute of the pager element.The parameters available for the template are: page - The current page. or totalPages - The total number of pages..

C#
public PagerBuilder ARIATemplateView(MvcHtmlString value)
Parameters:valueMvcHtmlString

The value that configures the ariatemplate.

Returns:

PagerBuilder

AutoBind(bool)

Indicates whether the pager refresh method will be called within its initialization.

C#
public PagerBuilder AutoBind(bool value)
Parameters:valuebool

The value that configures the autobind.

Returns:

PagerBuilder

ButtonCount(double)

Defines the number of buttons displayed in the numeric pager.

C#
public PagerBuilder ButtonCount(double value)
Parameters:valuedouble

The value that configures the buttoncount.

Returns:

PagerBuilder

DataSource(string)

Sets the id of the external data source of the widget.

C#
public PagerBuilder DataSource(string dataSourceId)
Parameters:dataSourceIdstringReturns:

PagerBuilder

Events(Action<PagerEventBuilder>)

Configures the client-side events.

C#
public PagerBuilder Events(Action<PagerEventBuilder> configurator)
Parameters:configuratorAction<PagerEventBuilder>

The client events action.

Returns:

PagerBuilder

Example:
C#
@( Html.Kendo().Pager()
.Name("Pager")
.Events(events =&gt; events
.Change("onChange")
)
)

Info(bool)

Defines if a label showing current paging information will be displayed.

C#
public PagerBuilder Info(bool value)
Parameters:valuebool

The value that configures the info.

Returns:

PagerBuilder

Input(bool)

Defines if an input element which allows the user to navigate to given page will be displayed. If enabled only the numeric input will be rendered in the numeric portion of the pager.

C#
public PagerBuilder Input(bool value)
Parameters:valuebool

The value that configures the input.

Returns:

PagerBuilder

LinkTemplate(string)

The template for page number links.

C#
public PagerBuilder LinkTemplate(string value)
Parameters:valuestring

The value that configures the linktemplate.

Returns:

PagerBuilder

LinkTemplate<TModel>(TemplateBuilder<TModel>)

The template for page number links.

C#
public PagerBuilder LinkTemplate<TModel>(TemplateBuilder<TModel> template)
Parameters:templateTemplateBuilder<TModel>

A Template component that configures the linktemplate.

Returns:

PagerBuilder

LinkTemplateHandler(string)

The template for page number links.

C#
public PagerBuilder LinkTemplateHandler(string value)
Parameters:valuestring

The value that configures the linktemplate.

Returns:

PagerBuilder

LinkTemplateId(string)

The template for page number links.

C#
public PagerBuilder LinkTemplateId(string value)
Parameters:valuestring

The value that configures the linktemplate.

Returns:

PagerBuilder

LinkTemplateView(MvcHtmlString)

The template for page number links.

C#
public PagerBuilder LinkTemplateView(MvcHtmlString value)
Parameters:valueMvcHtmlString

The value that configures the linktemplate.

Returns:

PagerBuilder

Messages(Action<PagerMessagesSettingsBuilder>)

Defines texts shown within the pager. Use this option to customize or localize the pager messages.

C#
public PagerBuilder Messages(Action<PagerMessagesSettingsBuilder> configurator)
Parameters:configuratorAction<PagerMessagesSettingsBuilder>

The action that configures the messages.

Returns:

PagerBuilder

Navigatable(bool)

If set to true the user could navigate the widget using the keyboard navigation. By default keyboard navigation is disabled.

C#
public PagerBuilder Navigatable(bool value)
Parameters:valuebool

The value that configures the navigatable.

Returns:

PagerBuilder

Numeric(bool)

Defines if numeric portion of the pager will be shown.

C#
public PagerBuilder Numeric(bool value)
Parameters:valuebool

The value that configures the numeric.

Returns:

PagerBuilder

PageSizes()

If set to true the pager will display a drop-down which allows the user to pick a page size. By default the page size drop-down is not displayed.Can be set to an array of predefined page sizes to override the default list. A special all value is supported. It sets the page size to the total number of records.If a pageSize setting is provided for the data source then this value will be selected initially.

C#
public PagerBuilder PageSizes()
Returns:

PagerBuilder

PageSizes(bool)

If set to true the pager will display a drop-down which allows the user to pick a page size. By default the page size drop-down is not displayed.Can be set to an array of predefined page sizes to override the default list. A special all value is supported. It sets the page size to the total number of records.If a pageSize setting is provided for the data source then this value will be selected initially.

C#
public PagerBuilder PageSizes(bool enabled)
Parameters:enabledboolReturns:

PagerBuilder

PageSizes(IEnumerable)

If set to true the pager will display a drop-down which allows the user to pick a page size. By default the page size drop-down is not displayed.Can be set to an array of predefined page sizes to override the default list. A special all value is supported. It sets the page size to the total number of records.If a pageSize setting is provided for the data source then this value will be selected initially.

C#
public PagerBuilder PageSizes(IEnumerable pageSizes)
Parameters:pageSizesIEnumerableReturns:

PagerBuilder

PreviousNext(bool)

Defines if buttons for navigating to the first, last, previous and next pages will be shown.

C#
public PagerBuilder PreviousNext(bool value)
Parameters:valuebool

The value that configures the previousnext.

Returns:

PagerBuilder

Refresh(bool)

Defines if a refresh button will be displayed. Click on that button will call DataSource read() method to get actual data.

C#
public PagerBuilder Refresh(bool value)
Parameters:valuebool

The value that configures the refresh.

Returns:

PagerBuilder

Responsive(bool)

Defines if the pager will be responsive.

C#
public PagerBuilder Responsive(bool value)
Parameters:valuebool

The value that configures the responsive.

Returns:

PagerBuilder

SelectTemplate(string)

The template for selected page number link.

C#
public PagerBuilder SelectTemplate(string value)
Parameters:valuestring

The value that configures the selecttemplate.

Returns:

PagerBuilder

SelectTemplate<TModel>(TemplateBuilder<TModel>)

The template for selected page number link.

C#
public PagerBuilder SelectTemplate<TModel>(TemplateBuilder<TModel> template)
Parameters:templateTemplateBuilder<TModel>

A Template component that configures the selecttemplate.

Returns:

PagerBuilder

SelectTemplateHandler(string)

The template for selected page number link.

C#
public PagerBuilder SelectTemplateHandler(string value)
Parameters:valuestring

The value that configures the selecttemplate.

Returns:

PagerBuilder

SelectTemplateId(string)

The template for selected page number link.

C#
public PagerBuilder SelectTemplateId(string value)
Parameters:valuestring

The value that configures the selecttemplate.

Returns:

PagerBuilder

SelectTemplateView(MvcHtmlString)

The template for selected page number link.

C#
public PagerBuilder SelectTemplateView(MvcHtmlString value)
Parameters:valueMvcHtmlString

The value that configures the selecttemplate.

Returns:

PagerBuilder

Size(ComponentSize)

Sets the size of the component.

C#
public PagerBuilder Size(ComponentSize value)
Parameters:valueComponentSize

The value that configures the size.

Returns:

PagerBuilder

In this article
DefinitionConstructorsPagerBuilder(Pager)MethodsAdaptiveMode(AdaptiveMode)ARIATemplate(string)ARIATemplate<TModel>(TemplateBuilder<TModel>)ARIATemplateHandler(string)ARIATemplateId(string)ARIATemplateView(MvcHtmlString)AutoBind(bool)ButtonCount(double)DataSource(string)Events(Action<PagerEventBuilder>)Info(bool)Input(bool)LinkTemplate(string)LinkTemplate<TModel>(TemplateBuilder<TModel>)LinkTemplateHandler(string)LinkTemplateId(string)LinkTemplateView(MvcHtmlString)Messages(Action<PagerMessagesSettingsBuilder>)Navigatable(bool)Numeric(bool)PageSizes()PageSizes(bool)PageSizes(IEnumerable)PreviousNext(bool)Refresh(bool)Responsive(bool)SelectTemplate(string)SelectTemplate<TModel>(TemplateBuilder<TModel>)SelectTemplateHandler(string)SelectTemplateId(string)SelectTemplateView(MvcHtmlString)Size(ComponentSize)
Not finding the help you need?
Contact Support