Edit this page

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 widget will not bind to the data source during initialization. In this case data binding will occur when the change event of the data source is fired. By default the widget will bind to the data source 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. 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 every 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 allows users to 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 could 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 will display 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, filter and sort (if filtering and sorting are enabled). By default the column menu is not enabled.Can be set to a JavaScript object which represents the column menu configuration.

ColumnMenu(System.Boolean)

If set to true the treelist will display 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, filter and sort (if filtering and sorting are enabled). By default the column menu is not enabled.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 will display 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, filter and sort (if filtering and sorting are enabled). By default the column menu is not enabled.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 would be able to edit the data to which the treelist is bound. By default editing is disabled.Can be set to a string ("inline" or "popup") to specify the editing mode. The default editing mode is "inline".Can be set to a JavaScript object which represents the editing configuration.

Editable(System.Boolean)

If set to true the user would be able to edit the data to which the treelist is bound. By default editing is disabled.Can be set to a string ("inline" or "popup") to specify the editing mode. The default editing mode is "inline".Can be set to a JavaScript object which represents the editing configuration.

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 would be able to edit the data to which the treelist is bound. By default editing is disabled.Can be set to a string ("inline" or "popup") to specify the editing mode. The default editing mode is "inline".Can be set to a JavaScript object which represents the editing configuration.

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 Kendo UI TreeList Excel export settings.

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 using the treelist filter menu. Filtering is disabled by default.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 using the treelist filter menu. Filtering is disabled by default.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 using the treelist filter menu. Filtering is disabled by default.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.

Navigatable(System.Boolean)

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

Parameters

value System.Boolean

The value that configures the navigatable.

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

Configures the Kendo UI TreeList PDF export settings.

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 could 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 could 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 could 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 treelist Toolbar contents.If an Array value is assigned, it will be treated as the list of commands displayed in the treelist Toolbar. Commands can be custom or built-in ("create", "excel", "pdf"). The "create" command adds an empty data item to the treelist.; The "excel" command exports the treelist data in MS Excel format. or The "pdf" command exports the treelist data in PDF format..

Parameters

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

The action that configures the toolbar.

Navigatable

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")
    )
%>