TreeList

Example

Razor
<kendo-treelist>
    <column-menu></column-menu>
    <columns></columns>
    <editable></editable>
    <excel />
    <filterable />
    <messages />
    <pageable></pageable>
    <pdf></pdf>
    <search />
    <sortable />
    <toolbar></toolbar>
    <treelist-alt-row-template></treelist-alt-row-template>
    <treelist-datasource></treelist-datasource>
    <treelist-row-template></treelist-row-template>
    <treelist-toolbar-template></treelist-toolbar-template>
</kendo-treelist>

ChildTags

Attributes

AttributeTypeDescription
nameStringSets the name of the component.
datasource-idStringThe Id of the data source.
deferredBooleanSuppress initialization script rendering. Note that this options should be used in conjunction with DeferredScripts method.
is-in-client-templateBooleanWhen placing a Tag Helper within a Kendo Template, set the type to text/html and add the is-in-client-template="true" attribute.
alt-row-templateStringThe template which renders the alternating table rows. By default the treelist renders a table row (<tr>) for every data source item.
alt-row-template-handlerStringThe template which renders the alternating table rows. By default the treelist renders a table row (<tr>) for every data source item.
alt-row-template-idStringThe template which renders the alternating table rows. By default the treelist renders a table row (<tr>) for every data source item.
alt-row-template-viewIHtmlContentThe template which renders the alternating table rows. By default the treelist renders a table row (<tr>) for every data source item.
as-moduleBoolean
auto-bindBooleanIf set to false, the TreeList will not bind to the specified DataSource during initialization. In this case, data binding will occur when the change event of the DataSource fires. By default, the TreeList will bind to the DataSource that is specified in the configuration.
has-client-componentBoolean
heightDoubleThe height of the TreeList. Numeric values are treated as pixels.
navigatableBooleanIf set to true, the user can navigate the widget with the keyboard. By default, keyboard navigation is disabled. For a runnable example, refer to the demo on keyboard navigation in the TreeList.
on-before-editStringFires when the user tries to edit or creates a data item before the editor is created. Can be used for preventing the editing depending on custom logic. The event handler function context (available through the this keyword) will be set to the widget instance. The event will be fired only when the TreeList is editable.
on-cancelStringFires when the user clicks the Cancel button (in inline or popup edit mode) or closes the popup window. The event handler function context (available through the this keyword) will be set to the widget instance.
on-cell-closeStringFires when the incell edit mode is used and the cell will be closed. The event is triggered after saving or canceling the changes but before the cell is closed. The event handler function context (available through the this keyword) will be set to the widget instance.
on-changeStringFires when the user selects a table row or cell in the TreeList. The event handler function context (available through the this keyword) will be set to the widget instance.
on-collapseStringFires when an item is about to be collapsed. The event handler function context (available through the this keyword) will be set to the widget instance.
on-column-hideStringFires when the user hides a column. The event handler function context (available through the this keyword) will be set to the widget instance.
on-column-lockStringFires when the user lock a column. The event handler function context (available through the this keyword) will be set to the widget instance.
on-column-menu-initStringFires when the column menu is initialized. The event handler function context (available through the this keyword) will be set to the widget instance.
on-column-menu-openStringFires when the column menu is opened. The event handler function context (available through the this keyword) will be set to the widget instance.
on-column-reorderStringFires when the user changes the order of a column. The event handler function context (available through the this keyword) will be set to the widget instance.
on-column-resizeStringFires when the user resizes a column. The event handler function context (available through the this keyword) will be set to the widget instance.
on-column-showStringFires when the user shows a column. The event handler function context (available through the this keyword) will be set to the widget instance.
on-column-unlockStringFires when the user unlock a column. The event handler function context (available through the this keyword) will be set to the widget instance.
on-data-bindingStringFires before the widget binds to its data source. The event handler function context (available through the this keyword) will be set to the widget instance.
on-data-boundStringFires when the widget is bound to data from its data source. The event handler function context (available through the this keyword) will be set to the widget instance.
on-dragString(Available as of the 2015.3.1014 release) Fires when the user attempts to drag an item. If prevented, the item is not allowed to move. The event handler function context (available through the this keyword) will be set to the widget instance.
on-dragendString(Available as of the 2015.3.1014 release) Fires when the user finishes dragging an item and the model was updated. The event handler function context (available through the this keyword) will be set to the widget instance.
on-dragstartString(Available as of the 2015.3.1014 release) Fires when the user attempts to drag an item. If prevented, the item is not allowed to move. The event handler function context (available through the this keyword) will be set to the widget instance.
on-dropString(Available as of the 2015.3.1014 release) Fires when the user drops an item. If prevented, the source row will not be moved. The event handler function context (available through the this keyword) will be set to the widget instance.
on-editStringFires when the user edits or creates a data item. The event handler function context (available through the this keyword) will be set to the widget instance.
on-excel-exportStringFires when the user clicks the Export to Excel toolbar button.
on-expandStringFires when an item is about to be expanded. The event handler function context (available through the this keyword) will be set to the widget instance.
on-filter-menu-initStringFires when the TreeList filter menu is initialized. The event handler function context (available through the this keyword) will be set to the widget instance.
on-filter-menu-openStringFires when the TreeList filter menu is opened. The event handler function context (available through the this keyword) will be set to the widget instance.
on-pdf-exportStringFires when the user clicks the Export to PDF toolbar button.
on-removeStringFires when the user clicks the Destroy command button. The event handler function context (available through the this keyword) will be set to the widget instance.
on-saveStringFires when a data item is saved. The event handler function context (available through the this keyword) will be set to the widget instance.
on-save-changesStringFires when the user clicks the Save command button. The event handler function context (available through the this keyword) will be set to the widget instance.
reorderableBooleanIf set to true, the user can reorder the columns by dragging their header cells. By default, reordering is disabled.
resizableBooleanIf set to true, the user can resize columns by dragging their header borders. By default, resizing is disabled.
row-templateStringThe template which renders rows. By default renders a table row (<tr>) for every data source item.
row-template-handlerStringThe template which renders rows. By default renders a table row (<tr>) for every data source item.
row-template-idStringThe template which renders rows. By default renders a table row (<tr>) for every data source item.
row-template-viewIHtmlContentThe template which renders rows. By default renders a table row (<tr>) for every data source item.
sanitize-idBoolean
script-attributesIDictionary<String,Object>
scrollableBooleanIf set to true, the TreeList will display a scrollbar when the total row height or width exceeds the TreeList height or width. By default, scrolling is enabled. Scrolling renders separate tables for the header and data area. For accessibility-conscious applications, disable scrolling.
selectableStringSpecifies the selection type of the treelist
In this article
ExampleChildTagsAttributes
Not finding the help you need?
Contact Support