Kendo.Mvc.UI.TreeList

Kendo UI TreeList component

Properties

DataSource

Gets the DataSource settings.

DataSourceId

Gets or sets the name of the external DataSource used by the ListView.

AutoBind

If 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.

Columns

The configuration of the TreeList columns whcih represents an array of JavaScript objects or strings. JavaScript objects are interpreted as column configurations. Strings are interpreted as thefield to which the column is bound. The TreeList will create a column for each item of the array.

Resizable

If set to true, the user can resize columns by dragging their header borders. By default, resizing is disabled.

Reorderable

If set to true, the user can reorder the columns by dragging their header cells. By default, reordering is disabled.

ColumnMenu

If set to true, the TreeList displays the column menu when the user clicks the Chevron icon in the column headers. The column menu allows the user to show and hide columns, and, if filtering and sorting are enabled, filter and sort the data. By default, the column menu is disabled. Can be set to a JavaScript object which represents the column menu configuration.

Editable

If set to true, the user will be able to edit the data to which the TreeList is bound. By default, editing is disabled. can be set to a JavaScript object (which represents the editing configuration) or to a string (which specifies the edit mode).The supported string values are: (Default) inline; popup or incell.

Excel

Configures the Excel export settings of the TreeList.

Filterable

If set to true, the user can filter the data source by using the TreeList filter menu. By default, filtering is disabled. Can be set to a JavaScript object which represents the filter menu configuration.

Height

The height of the TreeList. Numeric values are treated as pixels.

Messages

Defines the text of the command buttons that are shown within the TreeList. Used primarily for localization.

If 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.

Pageable

If set to true, the TreeList displays a pager. By default, paging is disabled. Only client-side paging is supported which means that all data items are expected to be available when the TreeList is initialized. Can be set to a JavaScript object which represents the pager configuration.

Pdf

Configures the PDF export settings of the TreeList.

Scrollable

If 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.

Sortable

If set to true, the user is able to sort the TreeList by clicking the column header cells. By default, sorting is disabled. Can be set to a JavaScript object which represents the sorting configuration.

Toolbar

If a String value is assigned to the toolbar configuration option, it will be treated as a single string template for the whole TreeList toolbar and the string value will be passed as an argument to a kendo.template() function.; If a Function value is assigned (it may be a kendo.template() function call or a generic function reference), then the return value of the function will be used to render the contents of the TreeList toolbar. or If an Array value is assigned, it will be treated as the list of commands which are displayed in the TreeList toolbar. Commands can be custom or built-in. The supported built-in commands are:create - Adds an empty data item to the treelist.excel - Exports the TreeList data in MS Excel format.pdf - Exports the TreeList data in PDF format..

Selectable

Specifies whether TreeList selection is allowed. By default selection is disabled

Methods

ProcessSettings

Processes the TreeList settings.

WriteHtml(System.IO.TextWriter)

Writes the TreeList HTML output.

Parameters

writer System.IO.TextWriter

The text writer instance.

WriteInitializationScript(System.IO.TextWriter)

Writes the TreeList initialization script.

Parameters

writer System.IO.TextWriter

The text writer instance.

SerializeSettings

Serialize current instance to Dictionary

In this article
Not finding the help you need?