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
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.
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
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
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
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
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
ARIATemplate(Kendo.Mvc.UI.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.
AutoBind(System.Boolean)
Indicates whether the pager refresh method will be called within its initialization.
Parameters
value - System.Boolean
The value for AutoBind
ButtonCount(System.Double)
Defines the number of buttons displayed in the numeric pager.
Parameters
value - System.Double
The value for ButtonCount
SelectTemplate(System.String)
The template for selected page number link.
Parameters
value - System.String
The value for SelectTemplate
SelectTemplateId(System.String)
The template for selected page number link.
Parameters
templateId - System.String
The ID of the template element for SelectTemplate
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
SelectTemplateHandler(System.String)
The template for selected page number link.
Parameters
templateHandler - System.String
The handler that returs the template for SelectTemplate
SelectTemplate(Kendo.Mvc.UI.TemplateBuilder)
The template for selected page number link.
Parameters
template - TemplateBuilder<TModel>
A Template component that configures the selecttemplate.
LinkTemplate(System.String)
The template for page number links.
Parameters
value - System.String
The value for LinkTemplate
LinkTemplateId(System.String)
The template for page number links.
Parameters
templateId - System.String
The ID of the template element for LinkTemplate
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
LinkTemplateHandler(System.String)
The template for page number links.
Parameters
templateHandler - System.String
The handler that returs the template for LinkTemplate
LinkTemplate(Kendo.Mvc.UI.TemplateBuilder)
The template for page number links.
Parameters
template - TemplateBuilder<TModel>
A Template component that configures the linktemplate.
Info(System.Boolean)
Defines if a label showing current paging information will be displayed.
Parameters
value - System.Boolean
The value for Info
Input(System.Boolean)
Defines if an input element which allows the user to navigate to given page will be displayed.
Parameters
value - System.Boolean
The value for Input
Input()
Defines if an input element which allows the user to navigate to given page will be displayed.
Numeric(System.Boolean)
Defines if numeric portion of the pager will be shown.
Parameters
value - System.Boolean
The value for Numeric
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
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
Refresh()
Defines if a refresh button will be displayed. Click on that button will call DataSource read() method to get actual data.
Responsive(System.Boolean)
Defines if the pager will be responsive.
Parameters
value - System.Boolean
The value for Responsive
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.
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
Navigatable()
If set to true the user could navigate the widget using the keyboard navigation. By default keyboard navigation is disabled.
Size(Kendo.Mvc.UI.ComponentSize)
Sets the size of the component.
Parameters
value - ComponentSize
The value for Size
Events(System.Action)
Configures the client-side events.
Parameters
configurator - System.Action<PagerEventBuilder>
The client events action.
Example
@(Html.Kendo().Pager()
.Name("Pager")
.Events(events => events
.Change("onChange")
)
)
ToComponent()
Returns the internal view component.
Expression(System.String)
Sets the name of the component.
Parameters
modelExpression - System.String
Explorer(Microsoft.AspNetCore.Mvc.ViewFeatures.ModelExplorer)
Sets the name of the component.
Parameters
modelExplorer - Microsoft.AspNetCore.Mvc.ViewFeatures.ModelExplorer
Name(System.String)
Sets the name of the component.
Parameters
componentName - System.String
The name.
Deferred(System.Boolean)
Suppress initialization script rendering. Note that this options should be used in conjunction with
Parameters
deferred - System.Boolean
HtmlAttributes(System.Object)
Sets the HTML attributes.
Parameters
attributes - System.Object
The HTML attributes.
HtmlAttributes(System.Collections.Generic.IDictionary)
Sets the HTML attributes.
Parameters
attributes - System.Collections.Generic.IDictionary<String,Object>
The HTML attributes.
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.
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.
Render()
Renders the component in place.
ToHtmlString()
WriteTo(System.IO.TextWriter,System.Text.Encodings.Web.HtmlEncoder)
Parameters
writer - System.IO.TextWriter
encoder - System.Text.Encodings.Web.HtmlEncoder
ToClientTemplate()
AsModule(System.Boolean)
Specifies whether the initialization script of the component will be rendered as a JavaScript module.