TreeListPageableSettingsBuilder

Methods

AlwaysVisible(System.Boolean)

(Available as of the Kendo UI 2017 R3 release) By default, the TreeList will render a pager even when total number of items in the DataSource is less than the pageSize value.If set to false the TreeList will toggle the pager visibility as follows: When the total amount of items initially set in the DataSource is less than the pageSize number, the pager will be hidden.; When the total amount of items initially set in the DataSource is greater than or equal to the pageSize number, the pager will be shown.; When the total amount of items in the DataSource becomes less than the pageSize number (after a delete or filter operation, or upon changing the pageSize), the pager will be hidden. or When the total amount of items in the DataSource becomes greater than or equal to the pageSize number (after an insert or filter operation, or upon changing the pageSize), the pager will be shown..

Parameters

value - System.Boolean

The value that configures the alwaysvisible.

PageSize(System.Double)

The number of data items which will be displayed in the TreeList.

Parameters

value - System.Double

The value that configures the pagesize.

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

template - System.String

The value that configures the ariatemplate.

Example

Razor
 
             .Pageable(pageable => {
                 pageable.ARIATemplate("Current page is #=page#");
             })
             

ARIATemplateId(System.String)

The id of the script element used for ARIATemplate

Parameters

templateId - System.String

The value that configures the ariatemplate.

Example

Razor
 
             .Pageable(pageable => {
                 pageable.ARIATemplateId("ariaTemplate");
             })
             

ARIATemplateView(Microsoft.AspNetCore.Html.IHtmlContent)

The view template used for ARIATemplate

Parameters

templateView - Microsoft.AspNetCore.Html.IHtmlContent

The view that configures the ariatemplate.

Example

Razor
 
             .Pageable(pageable => {
                 pageable.ARIATemplateView(Html.Partial("TemplateView"));
             })
             

ARIATemplateHandler(System.String)

The template that renders the content of the aria-label attribute.

Parameters

templateHandler - System.String

The JavaScript function that will return the template content.

Example

Razor
 
             .Pageable(pageable => {
                 pageable.ARIATemplateHandler("ariaTemplate");
             })
             

PageSizes(System.Int32[])

Sets the page sizes of the grid.

Parameters

pageSizes - System.Int32[]

The values shown in the pageSize dropdown

Example

Razor
 
             .Pageable(pageable => {
                 pageable.PageSizes(new int[] { 10, 20, 50 });
             })
             

PageSizes(System.Boolean)

Sets the page sizes of the grid.

Parameters

enabled - System.Boolean

A value indicating whether to enable the page sizes dropdown

Example

Razor
 
             .Pageable(pageable => {
                 pageable.PageSizes(true);
             })
             

ButtonCount(System.Int32)

Sets the number of buttons displayed in the numeric pager. Default is 10.

Parameters

value - System.Int32

The value

Example

Razor
 
             .Pageable(pageable => {
                 pageable.ButtonCount(5);
             })
             

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

Parameters

enabled - System.Boolean

The value that configures the navigatable.

Example

Razor
 
             .Pageable(pageable => {
                 pageable.Navigatable(true);
             })
             

Numeric(System.Boolean)

Defines if the numeric portion of the pager will be shown.

Parameters

enabled - System.Boolean

The value that determines whether the numeric section will be shown

Example

Razor
 
             .Pageable(pageable => {
                 pageable.Numeric(true);
             })
             

Info(System.Boolean)

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

Parameters

enabled - System.Boolean

The value that determines whether the paging information will be shown

Example

Razor
 
             .Pageable(pageable => {
                 pageable.Info(false);
             })
             

Input(System.Boolean)

Defines if an input element which allows the user to navigate to given page will be displayed.

Parameters

enabled - System.Boolean

The value that enables or disables the input element

Example

Razor
 
             .Pageable(pageable => {
                 pageable.Input(false);
             })
             

Refresh(System.Boolean)

Defines if a refresh button will be displayed.

Parameters

enabled - System.Boolean

The value that enables or disables the refresh button

Example

Razor
 
             .Pageable(pageable => {
                 pageable.Refresh(false);
             })
             

Responsive(System.Boolean)

If set to false the pager will not be responsive. By default the pager is responsive.

Parameters

enabled - System.Boolean

The value that configures the responsive.

Example

Razor
 
             .Pageable(pageable => {
                 pageable.Responsive(false);
             })
             

Messages(System.Action)

Configures the messages.

Parameters

configurator - System.Action<PageableMessagesBuilder>

The value that configures the responsive.

Example

Razor
 
             .Pageable(pageable => {
                 pageable.Messages(messages => messages.AllPages("All"));
             })
             

PreviousNext(System.Boolean)

Parameters

enabled - System.Boolean

Enabled(System.Boolean)

Enables or disables paging.

Parameters

value - System.Boolean

Example

Razor
 
             @( Html.Kendo().Grid(Model)
                        .Name("Grid")
                        .Pageable(paging => paging.Enabled((bool)ViewData["enablePaging"]))
            )
             

AdaptiveMode(Kendo.Mvc.UI.AdaptiveMode)

Specifies a value whether the page sizes dropdown will be adaptive.

Parameters

adaptiveMode - AdaptiveMode

Example

Razor
 
             .Pageable(pageable => {
                 pageable.AdaptiveMode(AdaptiveMode.Auto);
             })