Kendo.Mvc.UI.Fluent.TreeListBuilder

Defines the fluent API for configuring the Kendo TreeList for ASP.NET MVC.

Methods

AutoBind(System.Boolean)

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.

Parameters

value System.Boolean

The value that configures the autobind.

Columns(System.Action<Kendo.Mvc.UI.Fluent.TreeListColumnFactory<T>>)

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.

Parameters

configurator System.Action<Kendo.Mvc.UI.Fluent.TreeListColumnFactory>

The action that configures the columns.

Resizable(System.Boolean)

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

Parameters

value System.Boolean

The value that configures the resizable.

Reorderable(System.Boolean)

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

Parameters

value System.Boolean

The value that configures the reorderable.

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.

ColumnMenu(System.Boolean)

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.

Parameters

enabled System.Boolean

Enables or disables the columnmenu option.

ColumnMenu(System.Action<Kendo.Mvc.UI.Fluent.TreeListColumnMenuSettingsBuilder<T>>)

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.

Parameters

configurator System.Action<Kendo.Mvc.UI.Fluent.TreeListColumnMenuSettingsBuilder>

The action that configures the columnmenu.

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.

Editable(System.Boolean)

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.

Parameters

enabled System.Boolean

Enables or disables the editable option.

Editable(System.Action<Kendo.Mvc.UI.Fluent.TreeListEditableSettingsBuilder<T>>)

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.

Parameters

configurator System.Action<Kendo.Mvc.UI.Fluent.TreeListEditableSettingsBuilder>

The action that configures the editable.

Excel(System.Action<Kendo.Mvc.UI.Fluent.TreeListExcelSettingsBuilder<T>>)

Configures the Excel export settings of the TreeList.

Parameters

configurator System.Action<Kendo.Mvc.UI.Fluent.TreeListExcelSettingsBuilder>

The action that configures the excel.

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.

Filterable(System.Boolean)

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.

Parameters

enabled System.Boolean

Enables or disables the filterable option.

Filterable(System.Action<Kendo.Mvc.UI.Fluent.TreeListFilterableSettingsBuilder<T>>)

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.

Parameters

configurator System.Action<Kendo.Mvc.UI.Fluent.TreeListFilterableSettingsBuilder>

The action that configures the filterable.

Height(System.Double)

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

Parameters

value System.Double

The value that configures the height.

Messages(System.Action<Kendo.Mvc.UI.Fluent.TreeListMessagesSettingsBuilder<T>>)

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

Parameters

configurator System.Action<Kendo.Mvc.UI.Fluent.TreeListMessagesSettingsBuilder>

The action that configures the messages.

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.

Parameters

value System.Boolean

The value that configures the navigatable.

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.

Pageable(System.Boolean)

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.

Parameters

enabled System.Boolean

Enables or disables the pageable option.

Pageable(System.Action<Kendo.Mvc.UI.Fluent.TreeListPageableSettingsBuilder<T>>)

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.

Parameters

configurator System.Action<Kendo.Mvc.UI.Fluent.TreeListPageableSettingsBuilder>

The action that configures the pageable.

Pdf(System.Action<Kendo.Mvc.UI.Fluent.TreeListPdfSettingsBuilder<T>>)

Configures the PDF export settings of the TreeList.

Parameters

configurator System.Action<Kendo.Mvc.UI.Fluent.TreeListPdfSettingsBuilder>

The action that configures the pdf.

Scrollable(System.Boolean)

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.

Parameters

value System.Boolean

The value that configures the scrollable.

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.

Sortable(System.Boolean)

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.

Parameters

enabled System.Boolean

Enables or disables the sortable option.

Sortable(System.Action<Kendo.Mvc.UI.Fluent.TreeListSortableSettingsBuilder<T>>)

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.

Parameters

configurator System.Action<Kendo.Mvc.UI.Fluent.TreeListSortableSettingsBuilder>

The action that configures the sortable.

Toolbar(System.Action<Kendo.Mvc.UI.Fluent.TreeListToolbarFactory<T>>)

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

Parameters

configurator System.Action<Kendo.Mvc.UI.Fluent.TreeListToolbarFactory>

The action that configures the toolbar.

If set to true the use could navigate the widget using the keyboard navigation. By default keyboard navigation is disabled.

Example (ASPX)

<%= Html.Kendo().TreeList()
    .Name("treeList")
    .Navigatable()
%>

Selectable(System.Boolean)

If set to true the user would be able to select treelist rows. By default selection is disabled.Can also be set to the following string values:

Parameters

value System.Boolean

The value that configures the selectable.

Selectable

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

Selectable(System.Action<Kendo.Mvc.UI.Fluent.TreeListSelectableSettingsBuilder<T>>)

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

Parameters

configurator System.Action<Kendo.Mvc.UI.Fluent.TreeListSelectableSettingsBuilder>

The configurator for the selectable setting.

DataSource(System.Action<Kendo.Mvc.UI.Fluent.TreeListAjaxDataSourceBuilder<T>>)

Configure the DataSource of the component

Parameters

configurator System.Action<Kendo.Mvc.UI.Fluent.TreeListAjaxDataSourceBuilder>

The action that configures the DataSource.

Example (ASPX)

<%= Html.Kendo().TreeMap()
    .Name("treeMap")
    .DataSource(dataSource => dataSource
        .Read(read => read
            .Action("_PopulationUS", "TreeMap")
        )
    )
%>

BindTo(System.Collections.Generic.IEnumerable<T>)

Binds the grid to a list of objects

Parameters

dataSource System.Collections.Generic.IEnumerable<T>

The data source.

Events(System.Action<Kendo.Mvc.UI.Fluent.TreeListEventBuilder>)

Configures the client-side events.

Parameters

configurator System.Action<Kendo.Mvc.UI.Fluent.TreeListEventBuilder>

The client events action.

Example (ASPX)

<%= Html.Kendo().TreeList()
    .Name("TreeList")
    .Events(events => events
        .DataBinding("onDataBinding")
    )
%>
In this article
Not finding the help you need?