New to Telerik UI for ASP.NET MVC? Start a free 30-day trial

PageableMessagesBuilder

Class

Provides a fluent interface for configuring pageable messages.

Definition

Namespace:Kendo.Mvc.UI.Fluent

Assembly:Kendo.Mvc.dll

Syntax:

public class PageableMessagesBuilder

Inheritance: objectPageableMessagesBuilder

Inherited Members object.GetType()object.MemberwiseClone()object.ToString()object.Equals(object)object.Equals(object, object)object.ReferenceEquals(object, object)object.GetHashCode()...

Constructors

PageableMessagesBuilder(PageableMessages)

public PageableMessagesBuilder(PageableMessages messages)

Parameters:messagesPageableMessages

Methods

AllPages(string)

The text message displayed in the Pager for the AllPages option.

public PageableMessagesBuilder AllPages(string message)

Parameters:messagestring

The message text for the AllPages option

Returns:

PageableMessagesBuilder

Example:

@(Html.Kendo().Grid&lt;OrderViewModel&gt;()
.Name("grid")
.Columns(columns =&gt;
{
columns.Bound(p =&gt; p.OrderID).Filterable(false);
columns.Bound(p =&gt; p.Freight);
})
.Pageable(p =&gt; p.Messages(m =&gt; m.AllPages("All pages")))
.Scrollable()
.DataSource(dataSource =&gt; dataSource
.Ajax()
.PageSize(20)
.Read(read =&gt; read.Action("Orders_Read", "Grid"))
)
)

Display(string)

The text message displayed in the Pager. Contains three placeholders - {0} (the first data item index), {1} (the last data item index), {2} (the total number of data items).

public PageableMessagesBuilder Display(string message)

Parameters:messagestring

The pager info text.

Returns:

PageableMessagesBuilder

Example:

@(Html.Kendo().Grid&lt;OrderViewModel&gt;()
.Name("grid")
.Columns(columns =&gt;
{
columns.Bound(p =&gt; p.OrderID).Filterable(false);
columns.Bound(p =&gt; p.Freight);
})
.Pageable(p =&gt; p.Messages(m =&gt; m.Display("Showing {0}-{1} from {2} data items")))
.Scrollable()
.DataSource(dataSource =&gt; dataSource
.Ajax()
.PageSize(20)
.Read(read =&gt; read.Action("Orders_Read", "Grid"))
)
)

Empty(string)

The text displayed in the Pager when the grid is empty.

public PageableMessagesBuilder Empty(string message)

Parameters:messagestring

The Pager info text when the Grid is empty.

Returns:

PageableMessagesBuilder

Example:

@(Html.Kendo().Grid&lt;OrderViewModel&gt;()
.Name("grid")
.Columns(columns =&gt;
{
columns.Bound(p =&gt; p.OrderID).Filterable(false);
columns.Bound(p =&gt; p.Freight);
})
.Pageable(p =&gt; p.Messages(m =&gt; m.Empty("No data")))
.Scrollable()
.DataSource(dataSource =&gt; dataSource
.Ajax()
.PageSize(20)
.Read(read =&gt; read.Action("Orders_Read", "Grid"))
)
)

First(string)

The tooltip of the button which goes to the first page.

public PageableMessagesBuilder First(string message)

Parameters:messagestring

The tooltip text of the Go to the fisrt page button.

Returns:

PageableMessagesBuilder

Example:

@(Html.Kendo().Grid&lt;OrderViewModel&gt;()
.Name("grid")
.Columns(columns =&gt;
{
columns.Bound(p =&gt; p.OrderID).Filterable(false);
columns.Bound(p =&gt; p.Freight);
})
.Pageable(p =&gt; p.Messages(m =&gt; m.First("First page")))
.Scrollable()
.DataSource(dataSource =&gt; dataSource
.Ajax()
.PageSize(20)
.Read(read =&gt; read.Action("Orders_Read", "Grid"))
)
)

ItemsPerPage(string)

The label displayed after the page size DropDownList.

public PageableMessagesBuilder ItemsPerPage(string message)

Parameters:messagestring

The text for the label displayed after the page size DropDownList.

Returns:

PageableMessagesBuilder

Example:

@(Html.Kendo().Grid&lt;OrderViewModel&gt;()
.Name("grid")
.Columns(columns =&gt;
{
columns.Bound(p =&gt; p.OrderID).Filterable(false);
columns.Bound(p =&gt; p.Freight);
})
.Pageable(p =&gt; p.Messages(m =&gt; m.ItemsPerPage("data items per pagee")))
.Scrollable()
.DataSource(dataSource =&gt; dataSource
.Ajax()
.PageSize(20)
.Read(read =&gt; read.Action("Orders_Read", "Grid"))
)
)

Last(string)

The tooltip of the button which goes to the last page.

public PageableMessagesBuilder Last(string message)

Parameters:messagestring

The tooltip text of the Go to the last page button.

Returns:

PageableMessagesBuilder

Example:

@(Html.Kendo().Grid&lt;OrderViewModel&gt;()
.Name("grid")
.Columns(columns =&gt;
{
columns.Bound(p =&gt; p.OrderID).Filterable(false);
columns.Bound(p =&gt; p.Freight);
})
.Pageable(p =&gt; p.Messages(m =&gt; m.Last("Last page")))
.Scrollable()
.DataSource(dataSource =&gt; dataSource
.Ajax()
.PageSize(20)
.Read(read =&gt; read.Action("Orders_Read", "Grid"))
)
)

MorePages(string)

The Tooltip of the ellipsis ("...") button, which appears when the number of pages is greater than the buttonCount.

public PageableMessagesBuilder MorePages(string message)

Parameters:messagestring

The tooltip text of the ellipsis button, which appears when the number of pages is greater than the buttonCount.

Returns:

PageableMessagesBuilder

Example:

@(Html.Kendo().Grid&lt;OrderViewModel&gt;()
.Name("grid")
.Columns(columns =&gt;
{
columns.Bound(p =&gt; p.OrderID).Filterable(false);
columns.Bound(p =&gt; p.Freight);
})
.Pageable(p =&gt; p.Messages(m =&gt; m.MorePages("More pages")))
.Scrollable()
.DataSource(dataSource =&gt; dataSource
.Ajax()
.PageSize(20)
.Read(read =&gt; read.Action("Orders_Read", "Grid"))
)
)

Next(string)

The Tooltip of the button which goes to the next page.

public PageableMessagesBuilder Next(string message)

Parameters:messagestring

The Tooltip text message of the button which goes to the next page.

Returns:

PageableMessagesBuilder

Example:

@(Html.Kendo().Grid&lt;OrderViewModel&gt;()
.Name("grid")
.Columns(columns =&gt;
{
columns.Bound(p =&gt; p.OrderID).Filterable(false);
columns.Bound(p =&gt; p.Freight);
})
.Pageable(p =&gt; p.Messages(m =&gt; m.Next("Next page")))
.Scrollable()
.DataSource(dataSource =&gt; dataSource
.Ajax()
.PageSize(20)
.Read(read =&gt; read.Action("Orders_Read", "Grid"))
)
)

NumbersSelectLabel(string)

The label applied to the Pager select element (when visible).

public PageableMessagesBuilder NumbersSelectLabel(string value)

Parameters:valuestring

The label text.

Returns:

PageableMessagesBuilder

Example:

@(Html.Kendo().Grid&lt;OrderViewModel&gt;()
.Name("grid")
.Columns(columns =&gt;
{
columns.Bound(p =&gt; p.OrderID).Filterable(false);
columns.Bound(p =&gt; p.Freight);
})
.Pageable(p =&gt; p.Messages(m =&gt; m.NumbersSelectLabel("select page")))
.Scrollable()
.DataSource(dataSource =&gt; dataSource
.Ajax()
.PageSize(20)
.Read(read =&gt; read.Action("Orders_Read", "Grid"))
)
)

Of(string)

The label displayed before the pager input. Contains one optional placeholder {0} which represents the total number of pages.

public PageableMessagesBuilder Of(string message)

Parameters:messagestring

The text for the label displayed before the pager input.

Returns:

PageableMessagesBuilder

Example:

@(Html.Kendo().Grid&lt;OrderViewModel&gt;()
.Name("grid")
.Columns(columns =&gt;
{
columns.Bound(p =&gt; p.OrderID).Filterable(false);
columns.Bound(p =&gt; p.Freight);
})
.Pageable(p =&gt; p.Messages(m =&gt; m.Of("from {0}")))
.Scrollable()
.DataSource(dataSource =&gt; dataSource
.Ajax()
.PageSize(20)
.Read(read =&gt; read.Action("Orders_Read", "Grid"))
)
)

Page(string)

The label displayed before the pager input.

public PageableMessagesBuilder Page(string message)

Parameters:messagestring

The text of the label displayed before the pager input.

Returns:

PageableMessagesBuilder

Example:

@(Html.Kendo().Grid&lt;OrderViewModel&gt;()
.Name("grid")
.Columns(columns =&gt;
{
columns.Bound(p =&gt; p.OrderID).Filterable(false);
columns.Bound(p =&gt; p.Freight);
})
.Pageable(p =&gt; p.Messages(m =&gt; m.Page("Enter page")).Input(true))
.Scrollable()
.DataSource(dataSource =&gt; dataSource
.Ajax()
.PageSize(20)
.Read(read =&gt; read.Action("Orders_Read", "Grid"))
)
)

PageButtonLabel(string)

The Tooltip that is showing when hover on a page in the pager. The {0} parameter stands for the page number hovered.

public PageableMessagesBuilder PageButtonLabel(string message)

Parameters:messagestring

The text of the Tooltip that is showing when hover on a page in the pager.

Returns:

PageableMessagesBuilder

Example:

@(Html.Kendo().Grid&lt;OrderViewModel&gt;()
.Name("grid")
.Columns(columns =&gt;
{
columns.Bound(p =&gt; p.OrderID).Filterable(false);
columns.Bound(p =&gt; p.Freight);
})
.Pageable(p =&gt; p.Messages(m =&gt; m.PageButtonLabel("page {0}")))
.Scrollable()
.DataSource(dataSource =&gt; dataSource
.Ajax()
.PageSize(20)
.Read(read =&gt; read.Action("Orders_Read", "Grid"))
)
)

PageSizeDropDownLabel(string)

The label applied to the page size dropdown.

public PageableMessagesBuilder PageSizeDropDownLabel(string value)

Parameters:valuestring

The label text.

Returns:

PageableMessagesBuilder

Example:

@(Html.Kendo().Grid&lt;OrderViewModel&gt;()
.Name("grid")
.Columns(columns =&gt;
{
columns.Bound(p =&gt; p.OrderID).Filterable(false);
columns.Bound(p =&gt; p.Freight);
})
.Pageable(p =&gt; p.Messages(m =&gt; m.PageSizeDropDownLabel("page sizes")))
.Scrollable()
.DataSource(dataSource =&gt; dataSource
.Ajax()
.PageSize(20)
.Read(read =&gt; read.Action("Orders_Read", "Grid"))
)
)

Previous(string)

The Tooltip of the button which goes to the previous page.

public PageableMessagesBuilder Previous(string message)

Parameters:messagestring

The text for the Tooltip of the button which goes to the previous page.

Returns:

PageableMessagesBuilder

Example:

@(Html.Kendo().Grid&lt;OrderViewModel&gt;()
.Name("grid")
.Columns(columns =&gt;
{
columns.Bound(p =&gt; p.OrderID).Filterable(false);
columns.Bound(p =&gt; p.Freight);
})
.Pageable(p =&gt; p.Messages(m =&gt; m.Previous("Previous page")))
.Scrollable()
.DataSource(dataSource =&gt; dataSource
.Ajax()
.PageSize(20)
.Read(read =&gt; read.Action("Orders_Read", "Grid"))
)
)

Refresh(string)

The Tooltip of the refresh button.

public PageableMessagesBuilder Refresh(string message)

Parameters:messagestring

The text for the Tooltip of the refresh button.

Returns:

PageableMessagesBuilder

Example:

@(Html.Kendo().Grid&lt;OrderViewModel&gt;()
.Name("grid")
.Columns(columns =&gt;
{
columns.Bound(p =&gt; p.OrderID).Filterable(false);
columns.Bound(p =&gt; p.Freight);
})
.Pageable(p =&gt; p.Messages(m =&gt; m.Refresh("Refresh the grid")))
.Scrollable()
.DataSource(dataSource =&gt; dataSource
.Ajax()
.PageSize(20)
.Read(read =&gt; read.Action("Orders_Read", "Grid"))
)
)