GridPinnableSettingsBuilder

Methods

Top(System.Collections.IEnumerable)

Sets the data items pinned to the top of the Grid.

Parameters

value - System.Collections.IEnumerable

A collection of data item identifiers to pin to the top.

Bottom(System.Collections.IEnumerable)

Sets the data items pinned to the bottom of the Grid.

Parameters

value - System.Collections.IEnumerable

A collection of data item identifiers to pin to the bottom.

Top(System.Object)

An array of data item ID values that will be pinned to the top of the Grid on initialization.

Parameters

value - System.Object

The value for Top

RETURNS

Returns the current GridPinnableSettingsBuilder instance.

Bottom(System.Object)

An array of data item ID values that will be pinned to the bottom of the Grid on initialization.

Parameters

value - System.Object

The value for Bottom

RETURNS

Returns the current GridPinnableSettingsBuilder instance.

IsRowPinnable(System.String)

A function that determines whether a specific row can be pinned. The function receives an object with a dataItem field containing the data item for the row, and must return a boolean value. When the function returns false for a row, the pin column renders an empty cell without a pin icon, the pin column context menu does not open for that row, and the pinRows method does not pin the row. Unpinning is always allowed regardless of this function's return value.

Parameters

handler - System.String

The name of the JavaScript function that will be evaluated.

RETURNS

Returns the current GridPinnableSettingsBuilder instance.

IsRowPinnable(System.Func)

A function that determines whether a specific row can be pinned. The function receives an object with a dataItem field containing the data item for the row, and must return a boolean value. When the function returns false for a row, the pin column renders an empty cell without a pin icon, the pin column context menu does not open for that row, and the pinRows method does not pin the row. Unpinning is always allowed regardless of this function's return value.

Parameters

handler - System.Func<Object,Object>

The handler code wrapped in a text tag.

RETURNS

Returns the current GridPinnableSettingsBuilder instance.

PinRowLocation(Kendo.Mvc.UI.GridPinRowLocation)

Controls where rows can be pinned.

Parameters

value - GridPinRowLocation

The value for PinRowLocation

RETURNS

Returns the current GridPinnableSettingsBuilder instance.