Kendo.Mvc.UI.TreeListColumn

Kendo UI TreeListColumn class

Properties

Editor

Gets or sets the editor.

HtmlAttributes

The HTML attributes of the table cell (

) that is rendered for the column.

Command

The configuration of the column commands. If set, the column will display a button for every command. Commands can be custom or built-inThe built-in commands are: edit - Switches the current table row to edit mode. Supports the inline and popup edit modes.; createChild- Adds a new child item to the current table row and switches to edit mode. or destroy - Removes the data item to which the current table row is bound.. Custom commands are supported by specifying the click option.

Editable

The JavaScript function that is executed when the cell or row is about to be opened for editing. The returned result will determine whether an editor for the column will be created.

Encoded

If set to true, the column value will be HTML-encoded before it is displayed. If set to false, the column value will be displayed as is. By default, the column value is HTML-encoded.

Expandable

If set to true, the column will show the icons that are used for expanding and collapsing child rows. By default, the first column of the TreeList is expandable.

Field

The field to which the column is bound. The value of this field is displayed by the column during data binding.

Filterable

If set to true and if filtering is enabled, a filter menu will be displayed for this column. If set to false, the filter menu will not be displayed. By default, a filter menu is displayed for all columns when filtering is enabled through the filterable option. Can be set to a JavaScript object which represents the filter menu configuration.

FooterTemplate

The template which renders the footer table cell for the column.The following fields can be used in the template: average - The value of the average aggregate (if specified).; count - The value of the count aggregate (if specified).; max - The value of the max aggregate (if specified).; min - The value of the min aggregate (if specified). or sum - The value of the sum aggregate (if specified)..

FooterTemplateId

The id of the script element used for FooterTemplate

Format

The format that is applied to the value before it is displayed. Takes the {0:format} form where format is a standard number format, custom number format, standard date format or a custom date format.

HeaderAttributes

The HTML attributes of the table header cell (

) that is rendered for the column.

HeaderTemplate

The template which renders the column header content. By default, the value of the title column option is displayed in the column header cell.

HeaderTemplateId

The id of the script element used for HeaderTemplate

MinScreenWidth

The pixel screen width below which the column will be hidden. The setting takes precedence over the hidden setting and the two cannot not be used at the same time.

Sortable

If set to true and sorting is enabled, the user can click the column header and sort the TreeList by the column field. If set to false, sorting will be disabled for this column. By default, all columns are sortable if sorting is enabled though the sortable option.

Template

The template which renders the column content. The TreeList renders table rows (

) which represent the data source items. Each table row consists of table cells () which represent the TreeList columns. By default, the HTML-encoded value of the field is displayed in the column.

TemplateId

The id of the script element used for Template

Title

The text that is displayed in the column header cell. If not set, the TreeList uses field.

Width

The width of the column. Numeric values are treated as pixels.

Hidden

If set to true, the TreeList will not display the column. By default, all columns are displayed.

If set to true, the TreeList will display the column in the column menu. By default, the column menu includes all data-bound columns, that is, the ones with a set field option.

Locked

If set to true, the TreeList will display the column as locked (frozen).

Lockable

If set to false, the column will remain in that side of the TreeList where its own locked configuration placed it.

Methods

Serialize

Serializes the current instance to a Dictionary.

SerializeSettings

Serialize current instance to Dictionary

In this article
Not finding the help you need?