Kendo.Mvc.UI.TreeListColumn

Kendo UI TreeListColumn class

Properties

HtmlAttributes

HTML attributes of the table cell (

) rendered for the column.

Command

The configuration of the column command(s). If set the column would display a button for every command. Commands can be custom or built-in ("edit", "createChild" or "destroy"): The "edit" built-in command switches the current table row to edit mode.; The "createChild" built-in command adds a new child item to the current table row and switches to edit mode. or The "destroy" built-in command 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 executed when the cell/row is about to be opened for edit. The result returned 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.The field name should be a valid Javascript identifier and should contain only alphanumeric characters (or "$" or "_"), and may not start with a digit.

Filterable

If set to true a filter menu will be displayed for this column when filtering is enabled. 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 via 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 fields which can be used in the template are: 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 form "{0:format}" where "format" is a standard number format,custom number format, standard date format or a custom date format.

HeaderAttributes

HTML attributes of the table header cell (

) 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, so the two should not be used at the same time.

Sortable

If set to true the user can click the column header and sort the treelist by the column field when sorting is enabled. If set to false sorting will be disabled for this column. By default all columns are sortable if sorting is enabled via 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 field is used.

Width

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

Hidden

If set to true the column will not be displayed in the treelist. By default all columns are displayed.

If set to true the column will be visible in the treelist column menu. By default the column menu includes all data-bound columns (ones that have their field set).

Locked

If set to true the column will be displayed as locked (frozen) in the treelist.

Lockable

If set to false the column will remain in the side of the TreeList into which its own locked configuration placed it.

Methods

SerializeSettings

Serialize current instance to Dictionary