PagerBuilder

Properties

WriteAction - Func

Methods

DataSource(System.String)

Parameters

dataSourceId - System.String

PageSizes(System.Boolean)

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.

Parameters

enabled - System.Boolean

RETURNS

Returns the current PagerBuilder instance.

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.

RETURNS

Returns the current PagerBuilder instance.

PageSizes(System.Collections.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.

Parameters

pageSizes - System.Collections.IEnumerable

RETURNS

Returns the current PagerBuilder instance.

AdaptiveMode(Kendo.Mvc.UI.AdaptiveMode)

Specifies a value whether the page sizes dropdown will be adaptive

Parameters

value - AdaptiveMode

The value for AdaptiveMode

RETURNS

Returns the current PagerBuilder instance.

ARIATemplate(System.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..

Parameters

value - System.String

The value for ARIATemplate

RETURNS

Returns the current PagerBuilder instance.

ARIATemplateId(System.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..

Parameters

templateId - System.String

The ID of the template element for ARIATemplate

RETURNS

Returns the current PagerBuilder instance.

ARIATemplateView(Microsoft.AspNetCore.Html.IHtmlContent)

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..

Parameters

templateView - Microsoft.AspNetCore.Html.IHtmlContent

The view that contains the template for ARIATemplate

RETURNS

Returns the current PagerBuilder instance.

ARIATemplateHandler(System.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..

Parameters

templateHandler - System.String

The handler that returs the template for ARIATemplate

RETURNS

Returns the current PagerBuilder instance.

ARIATemplate(Kendo.Mvc.UI.Fluent.TemplateBuilder)

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..

Parameters

template - TemplateBuilder<TModel>

A Template component that configures the ariatemplate.

RETURNS

Returns the current PagerBuilder instance.

AutoBind(System.Boolean)

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

Parameters

value - System.Boolean

The value for AutoBind

RETURNS

Returns the current PagerBuilder instance.

ButtonCount(System.Double)

Defines the number of buttons displayed in the numeric pager.

Parameters

value - System.Double

The value for ButtonCount

RETURNS

Returns the current PagerBuilder instance.

SelectTemplate(System.String)

The template for selected page number link.

Parameters

value - System.String

The value for SelectTemplate

RETURNS

Returns the current PagerBuilder instance.

SelectTemplateId(System.String)

The template for selected page number link.

Parameters

templateId - System.String

The ID of the template element for SelectTemplate

RETURNS

Returns the current PagerBuilder instance.

SelectTemplateView(Microsoft.AspNetCore.Html.IHtmlContent)

The template for selected page number link.

Parameters

templateView - Microsoft.AspNetCore.Html.IHtmlContent

The view that contains the template for SelectTemplate

RETURNS

Returns the current PagerBuilder instance.

SelectTemplateHandler(System.String)

The template for selected page number link.

Parameters

templateHandler - System.String

The handler that returs the template for SelectTemplate

RETURNS

Returns the current PagerBuilder instance.

SelectTemplate(Kendo.Mvc.UI.Fluent.TemplateBuilder)

The template for selected page number link.

Parameters

template - TemplateBuilder<TModel>

A Template component that configures the selecttemplate.

RETURNS

Returns the current PagerBuilder instance.

LinkTemplate(System.String)

The template for page number links.

Parameters

value - System.String

The value for LinkTemplate

RETURNS

Returns the current PagerBuilder instance.

LinkTemplateId(System.String)

The template for page number links.

Parameters

templateId - System.String

The ID of the template element for LinkTemplate

RETURNS

Returns the current PagerBuilder instance.

LinkTemplateView(Microsoft.AspNetCore.Html.IHtmlContent)

The template for page number links.

Parameters

templateView - Microsoft.AspNetCore.Html.IHtmlContent

The view that contains the template for LinkTemplate

RETURNS

Returns the current PagerBuilder instance.

LinkTemplateHandler(System.String)

The template for page number links.

Parameters

templateHandler - System.String

The handler that returs the template for LinkTemplate

RETURNS

Returns the current PagerBuilder instance.

LinkTemplate(Kendo.Mvc.UI.Fluent.TemplateBuilder)

The template for page number links.

Parameters

template - TemplateBuilder<TModel>

A Template component that configures the linktemplate.

RETURNS

Returns the current PagerBuilder instance.

Info(System.Boolean)

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

Parameters

value - System.Boolean

The value for Info

RETURNS

Returns the current PagerBuilder instance.

Input(System.Boolean)

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.

Parameters

value - System.Boolean

The value for Input

RETURNS

Returns the current PagerBuilder instance.

Input()

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.

RETURNS

Returns the current PagerBuilder instance.

Numeric(System.Boolean)

Defines if numeric portion of the pager will be shown.

Parameters

value - System.Boolean

The value for Numeric

RETURNS

Returns the current PagerBuilder instance.

PreviousNext(System.Boolean)

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

Parameters

value - System.Boolean

The value for PreviousNext

RETURNS

Returns the current PagerBuilder instance.

Refresh(System.Boolean)

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

Parameters

value - System.Boolean

The value for Refresh

RETURNS

Returns the current PagerBuilder instance.

Refresh()

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

RETURNS

Returns the current PagerBuilder instance.

Responsive(System.Boolean)

Defines if the pager will be responsive.

Parameters

value - System.Boolean

The value for Responsive

RETURNS

Returns the current PagerBuilder instance.

Messages(System.Action)

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

Parameters

configurator - System.Action<PagerMessagesSettingsBuilder>

The configurator for the messages setting.

RETURNS

Returns the current instance of PagerBuilder .

Navigatable(System.Boolean)

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

Parameters

value - System.Boolean

The value for Navigatable

RETURNS

Returns the current PagerBuilder instance.

Navigatable()

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

RETURNS

Returns the current PagerBuilder instance.

Size(Kendo.Mvc.UI.ComponentSize)

Sets the size of the component.

Parameters

value - ComponentSize

The value for Size

RETURNS

Returns the current PagerBuilder instance.

Events(System.Action)

Configures the client-side events.

Parameters

configurator - System.Action<PagerEventBuilder>

The client events action.

RETURNS

Returns the current PagerBuilder instance.

Example

Razor

 
            @(Html.Kendo().Pager()
                  .Name("Pager")
                  .Events(events => events
                      .Change("onChange")
                  )
            )
             

ToComponent()

Returns the internal view component.

RETURNS

The instance that represents the component.

Expression(System.String)

Sets the name of the component.

Parameters

modelExpression - System.String

RETURNS

Returns the current instance.

Explorer(Microsoft.AspNetCore.Mvc.ViewFeatures.ModelExplorer)

Sets the name of the component.

Parameters

modelExplorer - Microsoft.AspNetCore.Mvc.ViewFeatures.ModelExplorer

RETURNS

Returns the current instance.

Name(System.String)

Sets the name of the component.

Parameters

componentName - System.String

The name.

RETURNS

Returns the current instance.

Deferred(System.Boolean)

Suppress initialization script rendering. Note that this options should be used in conjunction with

Parameters

deferred - System.Boolean

RETURNS

Returns a DeferredWidgetBuilder instance.

HtmlAttributes(System.Object)

Sets the HTML attributes.

Parameters

attributes - System.Object

The HTML attributes.

RETURNS

Returns the current instance.

HtmlAttributes(System.Collections.Generic.IDictionary)

Sets the HTML attributes.

Parameters

attributes - System.Collections.Generic.IDictionary<String,Object>

The HTML attributes.

RETURNS

Returns the current instance.

ScriptAttributes(System.Object,System.Boolean)

Sets the JavaScript attributes to the initialization script.

Parameters

attributes - System.Object

The JavaScript attributes.

overrideAttributes - System.Boolean

Argument which determines whether attributes should be overriden.

RETURNS

Returns the current instance.

ScriptAttributes(System.Collections.Generic.IDictionary,System.Boolean)

Sets the JavaScript attributes to the initialization script.

Parameters

attributes - System.Collections.Generic.IDictionary<String,Object>

The JavaScript attributes.

overrideAttributes - System.Boolean

Argument which determines whether attributes should be overriden.

RETURNS

Returns the current instance.

Render()

Renders the component in place.

ToHtmlString()

Returns the HTML representation of the component.

WriteTo(System.IO.TextWriter,System.Text.Encodings.Web.HtmlEncoder)

Parameters

writer - System.IO.TextWriter

encoder - System.Text.Encodings.Web.HtmlEncoder

ToClientTemplate()

Returns the client template for the component.

AsModule(System.Boolean)

Specifies whether the initialization script of the component will be rendered as a JavaScript module.

Parameters

value - System.Boolean

RETURNS

Returns the current instance.