# TreeListColumnBuilder ## Methods ### Editor(System.String) Provides a way to specify a custom editing UI for the column. Use the container parameter to create the editing UI. #### Parameters ##### value - `System.String` The value that configures the editor. #### RETURNS Returns the current [TreeListColumnBuilder](https://www.telerik.com/aspnet-core-ui/documentation/api/kendo.mvc.ui.fluent/treelistcolumnbuilder) instance. #### Example ``` @(Html.Kendo().TreeList() .Name("treelist") .Columns(columns => { columns.Add().Editor("AutoComplete"); }) ) ``` ### Field(System.Linq.Expressions.Expression) 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 no spaces, no special characters, and the first character should be a letter. #### Parameters ##### expression - `System.Linq.Expressions.Expression` The expression that specifies the field, based on the bound model. #### RETURNS Returns the current [TreeListColumnBuilder](https://www.telerik.com/aspnet-core-ui/documentation/api/kendo.mvc.ui.fluent/treelistcolumnbuilder) instance. #### Example ``` @(Html.Kendo().TreeList() .Name("treelist") .Columns(columns => { columns.Add().Field(f => f.FirstName); }) ) ``` ### Width(System.Int32) The width of the column. Numeric values are treated as pixels. #### Parameters ##### value - `System.Int32` The value that configures the width. #### RETURNS Returns the current [TreeListColumnBuilder](https://www.telerik.com/aspnet-core-ui/documentation/api/kendo.mvc.ui.fluent/treelistcolumnbuilder) instance. #### Example ``` @(Html.Kendo().TreeList() .Name("treelist") .Columns(columns => { columns.Add().Width(250); }) ) ``` ### Filterable(System.Action) If set to true and if filtering is enabled, a filter menu will be displayed for this column. 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 through the filterable option. Can be set to a JavaScript object which represents the filter menu configuration. #### Parameters ##### configurator - System.Action<[TreeListColumnFilterableSettingsBuilder](https://www.telerik.com/aspnet-core-ui/documentation/api/kendo.mvc.ui.fluent/treelistcolumnfilterablesettingsbuilder)> The configurator for the filterable setting. #### RETURNS Returns the current [TreeListColumnBuilder](https://www.telerik.com/aspnet-core-ui/documentation/api/kendo.mvc.ui.fluent/treelistcolumnbuilder) instance. #### Example ``` @(Html.Kendo().TreeList() .Name("treelist") .Columns(columns => { columns.Add() .Filterable(filterable => filterable .Cell(cell => cell .Operator("contains"))); }) ) ``` ### Filterable(System.Boolean) If set to true and if filtering is enabled, a filter menu will be displayed for this column. 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 through the filterable option. Can be set to a JavaScript object which represents the filter menu configuration. #### Parameters ##### enabled - `System.Boolean` Enables or disables the filterable option. #### RETURNS Returns the current [TreeListColumnBuilder](https://www.telerik.com/aspnet-core-ui/documentation/api/kendo.mvc.ui.fluent/treelistcolumnbuilder) instance. #### Example ``` @(Html.Kendo().TreeList() .Name("treelist") .Columns(columns => { columns.Add().Filterable(true); }) ) ``` ### EditorTemplateComponentName(System.String) The template which the component will use to create the field editor. #### Parameters ##### templateName - `System.String` Editor template name. #### RETURNS Returns the current [TreeListColumnBuilder](https://www.telerik.com/aspnet-core-ui/documentation/api/kendo.mvc.ui.fluent/treelistcolumnbuilder) instance. #### Example ``` @(Html.Kendo().TreeList() .Name("treelist") .Columns(columns => { columns.Add() .EditorTemplateComponentName("TreeListEditor"); }) ) ``` ### HtmlAttributes(System.Collections.Generic.IDictionary) The HTML attributes of the table cell (\) that is rendered for the column. #### Parameters ##### value - `System.Collections.Generic.IDictionary` The value for HtmlAttributes #### RETURNS Returns the current [TreeListColumnBuilder](https://www.telerik.com/aspnet-core-ui/documentation/api/kendo.mvc.ui.fluent/treelistcolumnbuilder) instance. ### HtmlAttributes(System.Object) The HTML attributes of the table cell (\) that is rendered for the column. #### Parameters ##### value - `System.Object` The value for HtmlAttributes #### RETURNS Returns the current [TreeListColumnBuilder](https://www.telerik.com/aspnet-core-ui/documentation/api/kendo.mvc.ui.fluent/treelistcolumnbuilder) instance. ### Command(System.Action) The configuration of the column commands. If set, the column will display a button for every command. Commands can be custom or built-inThe built-in commands are: edit - Switches the current table row to edit mode. Supports the inline and popup edit modes.; createChild- Adds a new child item to the current table row and switches to edit mode. or destroy - Removes the data item to which the current table row is bound.. Custom commands are supported by specifying the click option. #### Parameters ##### configurator - System.Action<[TreeListColumnCommandFactory](https://www.telerik.com/aspnet-core-ui/documentation/api/kendo.mvc.ui.fluent/treelistcolumncommandfactory)> The configurator for the command setting. #### RETURNS Returns the current instance of [TreeListColumnBuilder](https://www.telerik.com/aspnet-core-ui/documentation/api/kendo.mvc.ui.fluent/treelistcolumnbuilder) . ### Draggable(System.Boolean) If set to true a draghandle will be rendered and the user could reorder the rows by dragging the row via the drag handle. #### Parameters ##### value - `System.Boolean` The value for Draggable #### RETURNS Returns the current [TreeListColumnBuilder](https://www.telerik.com/aspnet-core-ui/documentation/api/kendo.mvc.ui.fluent/treelistcolumnbuilder) instance. ### Draggable() If set to true a draghandle will be rendered and the user could reorder the rows by dragging the row via the drag handle. #### RETURNS Returns the current [TreeListColumnBuilder](https://www.telerik.com/aspnet-core-ui/documentation/api/kendo.mvc.ui.fluent/treelistcolumnbuilder) instance. ### Editable(System.String) The JavaScript function that is executed when the cell or row is about to be opened for editing. The returned result will determine whether an editor for the column will be created. #### Parameters ##### handler - `System.String` The name of the JavaScript function that will be evaluated. #### RETURNS Returns the current [TreeListColumnBuilder](https://www.telerik.com/aspnet-core-ui/documentation/api/kendo.mvc.ui.fluent/treelistcolumnbuilder) instance. ### Editable(System.Func) The JavaScript function that is executed when the cell or row is about to be opened for editing. The returned result will determine whether an editor for the column will be created. #### Parameters ##### handler - `System.Func` The handler code wrapped in a text tag. #### RETURNS Returns the current [TreeListColumnBuilder](https://www.telerik.com/aspnet-core-ui/documentation/api/kendo.mvc.ui.fluent/treelistcolumnbuilder) instance. ### Encoded(System.Boolean) 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. #### Parameters ##### value - `System.Boolean` The value for Encoded #### RETURNS Returns the current [TreeListColumnBuilder](https://www.telerik.com/aspnet-core-ui/documentation/api/kendo.mvc.ui.fluent/treelistcolumnbuilder) instance. ### Expandable(System.Boolean) 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. #### Parameters ##### value - `System.Boolean` The value for Expandable #### RETURNS Returns the current [TreeListColumnBuilder](https://www.telerik.com/aspnet-core-ui/documentation/api/kendo.mvc.ui.fluent/treelistcolumnbuilder) instance. ### 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. #### RETURNS Returns the current [TreeListColumnBuilder](https://www.telerik.com/aspnet-core-ui/documentation/api/kendo.mvc.ui.fluent/treelistcolumnbuilder) instance. ### Field(System.String) The field to which the column is bound. The value of this field is displayed by the column during data binding. #### Parameters ##### value - `System.String` The value for Field #### RETURNS Returns the current [TreeListColumnBuilder](https://www.telerik.com/aspnet-core-ui/documentation/api/kendo.mvc.ui.fluent/treelistcolumnbuilder) instance. ### FooterTemplate(System.String) The template which renders the footer table cell for the column.The following fields can be used in the template: 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).. #### Parameters ##### value - `System.String` The value for FooterTemplate #### RETURNS Returns the current [TreeListColumnBuilder](https://www.telerik.com/aspnet-core-ui/documentation/api/kendo.mvc.ui.fluent/treelistcolumnbuilder) instance. ### FooterTemplateId(System.String) The template which renders the footer table cell for the column.The following fields can be used in the template: 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).. #### Parameters ##### templateId - `System.String` The ID of the template element for FooterTemplate #### RETURNS Returns the current [TreeListColumnBuilder](https://www.telerik.com/aspnet-core-ui/documentation/api/kendo.mvc.ui.fluent/treelistcolumnbuilder) instance. ### FooterTemplateView(Microsoft.AspNetCore.Html.IHtmlContent) The template which renders the footer table cell for the column.The following fields can be used in the template: 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).. #### Parameters ##### templateView - `Microsoft.AspNetCore.Html.IHtmlContent` The view that contains the template for FooterTemplate #### RETURNS Returns the current [TreeListColumnBuilder](https://www.telerik.com/aspnet-core-ui/documentation/api/kendo.mvc.ui.fluent/treelistcolumnbuilder) instance. ### FooterTemplateHandler(System.String) The template which renders the footer table cell for the column.The following fields can be used in the template: 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).. #### Parameters ##### templateHandler - `System.String` The handler that returs the template for FooterTemplate #### RETURNS Returns the current [TreeListColumnBuilder](https://www.telerik.com/aspnet-core-ui/documentation/api/kendo.mvc.ui.fluent/treelistcolumnbuilder) instance. ### FooterTemplate(Kendo.Mvc.UI.Fluent.TemplateBuilder) The template which renders the footer table cell for the column.The following fields can be used in the template: 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).. #### Parameters ##### template - TemplateBuilder\ A Template component that configures the footertemplate. #### RETURNS Returns the current [TreeListColumnBuilder](https://www.telerik.com/aspnet-core-ui/documentation/api/kendo.mvc.ui.fluent/treelistcolumnbuilder) instance. ### Format(System.String) The format that is applied to the value before it is displayed. Takes the {0:format} form where format is a standard number format, custom number format, standard date format or a custom date format. #### Parameters ##### value - `System.String` The value for Format #### RETURNS Returns the current [TreeListColumnBuilder](https://www.telerik.com/aspnet-core-ui/documentation/api/kendo.mvc.ui.fluent/treelistcolumnbuilder) instance. ### HeaderAttributes(System.Collections.Generic.IDictionary) The HTML attributes of the table header cell (\) that is rendered for the column. #### Parameters ##### value - `System.Collections.Generic.IDictionary` The value for HeaderAttributes #### RETURNS Returns the current [TreeListColumnBuilder](https://www.telerik.com/aspnet-core-ui/documentation/api/kendo.mvc.ui.fluent/treelistcolumnbuilder) instance. ### HeaderAttributes(System.Object) The HTML attributes of the table header cell (\) that is rendered for the column. #### Parameters ##### value - `System.Object` The value for HeaderAttributes #### RETURNS Returns the current [TreeListColumnBuilder](https://www.telerik.com/aspnet-core-ui/documentation/api/kendo.mvc.ui.fluent/treelistcolumnbuilder) instance. ### HeaderTemplate(System.String) The template which renders the column header content. By default, the value of the title column option is displayed in the column header cell. #### Parameters ##### value - `System.String` The value for HeaderTemplate #### RETURNS Returns the current [TreeListColumnBuilder](https://www.telerik.com/aspnet-core-ui/documentation/api/kendo.mvc.ui.fluent/treelistcolumnbuilder) instance. ### HeaderTemplateId(System.String) The template which renders the column header content. By default, the value of the title column option is displayed in the column header cell. #### Parameters ##### templateId - `System.String` The ID of the template element for HeaderTemplate #### RETURNS Returns the current [TreeListColumnBuilder](https://www.telerik.com/aspnet-core-ui/documentation/api/kendo.mvc.ui.fluent/treelistcolumnbuilder) instance. ### HeaderTemplateView(Microsoft.AspNetCore.Html.IHtmlContent) The template which renders the column header content. By default, the value of the title column option is displayed in the column header cell. #### Parameters ##### templateView - `Microsoft.AspNetCore.Html.IHtmlContent` The view that contains the template for HeaderTemplate #### RETURNS Returns the current [TreeListColumnBuilder](https://www.telerik.com/aspnet-core-ui/documentation/api/kendo.mvc.ui.fluent/treelistcolumnbuilder) instance. ### HeaderTemplateHandler(System.String) The template which renders the column header content. By default, the value of the title column option is displayed in the column header cell. #### Parameters ##### templateHandler - `System.String` The handler that returs the template for HeaderTemplate #### RETURNS Returns the current [TreeListColumnBuilder](https://www.telerik.com/aspnet-core-ui/documentation/api/kendo.mvc.ui.fluent/treelistcolumnbuilder) instance. ### HeaderTemplate(Kendo.Mvc.UI.Fluent.TemplateBuilder) The template which renders the column header content. By default, the value of the title column option is displayed in the column header cell. #### Parameters ##### template - TemplateBuilder\ A Template component that configures the headertemplate. #### RETURNS Returns the current [TreeListColumnBuilder](https://www.telerik.com/aspnet-core-ui/documentation/api/kendo.mvc.ui.fluent/treelistcolumnbuilder) instance. ### MinScreenWidth(System.Double) The pixel screen width below which the column will be hidden. The setting takes precedence over the hidden setting and the two cannot not be used at the same time. #### Parameters ##### value - `System.Double` The value for MinScreenWidth #### RETURNS Returns the current [TreeListColumnBuilder](https://www.telerik.com/aspnet-core-ui/documentation/api/kendo.mvc.ui.fluent/treelistcolumnbuilder) instance. ### Selectable(System.Boolean) If set to true the treelist will render a select column with checkboxes in each cell, thus enabling multi-row selection. The header checkbox allows users to select/deselect all the rows on the current page. #### Parameters ##### value - `System.Boolean` The value for Selectable #### RETURNS Returns the current [TreeListColumnBuilder](https://www.telerik.com/aspnet-core-ui/documentation/api/kendo.mvc.ui.fluent/treelistcolumnbuilder) instance. ### Selectable() If set to true the treelist will render a select column with checkboxes in each cell, thus enabling multi-row selection. The header checkbox allows users to select/deselect all the rows on the current page. #### RETURNS Returns the current [TreeListColumnBuilder](https://www.telerik.com/aspnet-core-ui/documentation/api/kendo.mvc.ui.fluent/treelistcolumnbuilder) instance. ### Sortable(System.Action) If set to true and sorting is enabled, the user can click the column header and sort the TreeList by the column field. If set to false, sorting will be disabled for this column. By default, all columns are sortable if sorting is enabled though the sortable option. #### Parameters ##### configurator - System.Action<[TreeListColumnSortableSettingsBuilder](https://www.telerik.com/aspnet-core-ui/documentation/api/kendo.mvc.ui.fluent/treelistcolumnsortablesettingsbuilder)> The configurator for the sortable setting. #### RETURNS Returns the current instance of [TreeListColumnBuilder](https://www.telerik.com/aspnet-core-ui/documentation/api/kendo.mvc.ui.fluent/treelistcolumnbuilder) . ### Sortable(System.Boolean) If set to true and sorting is enabled, the user can click the column header and sort the TreeList by the column field. If set to false, sorting will be disabled for this column. By default, all columns are sortable if sorting is enabled though the sortable option. #### Parameters ##### enabled - `System.Boolean` Enables or disables the sortable option. #### RETURNS Returns the current instance of [TreeListColumnSortableSettingsBuilder](https://www.telerik.com/aspnet-core-ui/documentation/api/kendo.mvc.ui.fluent/treelistcolumnsortablesettingsbuilder) . ### Template(System.String) 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. #### Parameters ##### value - `System.String` The value for Template #### RETURNS Returns the current [TreeListColumnBuilder](https://www.telerik.com/aspnet-core-ui/documentation/api/kendo.mvc.ui.fluent/treelistcolumnbuilder) instance. ### TemplateId(System.String) 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. #### Parameters ##### templateId - `System.String` The ID of the template element for Template #### RETURNS Returns the current [TreeListColumnBuilder](https://www.telerik.com/aspnet-core-ui/documentation/api/kendo.mvc.ui.fluent/treelistcolumnbuilder) instance. ### TemplateView(Microsoft.AspNetCore.Html.IHtmlContent) 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. #### Parameters ##### templateView - `Microsoft.AspNetCore.Html.IHtmlContent` The view that contains the template for Template #### RETURNS Returns the current [TreeListColumnBuilder](https://www.telerik.com/aspnet-core-ui/documentation/api/kendo.mvc.ui.fluent/treelistcolumnbuilder) instance. ### TemplateHandler(System.String) 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. #### Parameters ##### templateHandler - `System.String` The handler that returs the template for Template #### RETURNS Returns the current [TreeListColumnBuilder](https://www.telerik.com/aspnet-core-ui/documentation/api/kendo.mvc.ui.fluent/treelistcolumnbuilder) instance. ### Template(Kendo.Mvc.UI.Fluent.TemplateBuilder) 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. #### Parameters ##### template - TemplateBuilder\ A Template component that configures the template. #### RETURNS Returns the current [TreeListColumnBuilder](https://www.telerik.com/aspnet-core-ui/documentation/api/kendo.mvc.ui.fluent/treelistcolumnbuilder) instance. ### Title(System.String) The text that is displayed in the column header cell. If not set, the TreeList uses field. #### Parameters ##### value - `System.String` The value for Title #### RETURNS Returns the current [TreeListColumnBuilder](https://www.telerik.com/aspnet-core-ui/documentation/api/kendo.mvc.ui.fluent/treelistcolumnbuilder) instance. ### Width(System.String) The width of the column. Numeric values are treated as pixels. #### Parameters ##### value - `System.String` The value for Width #### RETURNS Returns the current [TreeListColumnBuilder](https://www.telerik.com/aspnet-core-ui/documentation/api/kendo.mvc.ui.fluent/treelistcolumnbuilder) instance. ### Hidden(System.Boolean) If set to true, the TreeList will not display the column. By default, all columns are displayed. #### Parameters ##### value - `System.Boolean` The value for Hidden #### RETURNS Returns the current [TreeListColumnBuilder](https://www.telerik.com/aspnet-core-ui/documentation/api/kendo.mvc.ui.fluent/treelistcolumnbuilder) instance. ### Hidden() If set to true, the TreeList will not display the column. By default, all columns are displayed. #### RETURNS Returns the current [TreeListColumnBuilder](https://www.telerik.com/aspnet-core-ui/documentation/api/kendo.mvc.ui.fluent/treelistcolumnbuilder) instance. ### IncludeChildren(System.Boolean) If set to true, the TreeList will select all child rows upon parent row selection when checkbox selection is used. #### Parameters ##### value - `System.Boolean` The value for IncludeChildren #### RETURNS Returns the current [TreeListColumnBuilder](https://www.telerik.com/aspnet-core-ui/documentation/api/kendo.mvc.ui.fluent/treelistcolumnbuilder) instance. ### IncludeChildren() If set to true, the TreeList will select all child rows upon parent row selection when checkbox selection is used. #### RETURNS Returns the current [TreeListColumnBuilder](https://www.telerik.com/aspnet-core-ui/documentation/api/kendo.mvc.ui.fluent/treelistcolumnbuilder) instance. ### Menu(System.Boolean) If set to true, the TreeList will display the column in the column menu. By default, the column menu includes all data-bound columns, that is, the ones with a set field option. #### Parameters ##### value - `System.Boolean` The value for Menu #### RETURNS Returns the current [TreeListColumnBuilder](https://www.telerik.com/aspnet-core-ui/documentation/api/kendo.mvc.ui.fluent/treelistcolumnbuilder) instance. ### Locked(System.Boolean) If set to true, the TreeList will display the column as locked (frozen). #### Parameters ##### value - `System.Boolean` The value for Locked #### RETURNS Returns the current [TreeListColumnBuilder](https://www.telerik.com/aspnet-core-ui/documentation/api/kendo.mvc.ui.fluent/treelistcolumnbuilder) instance. ### Locked() If set to true, the TreeList will display the column as locked (frozen). #### RETURNS Returns the current [TreeListColumnBuilder](https://www.telerik.com/aspnet-core-ui/documentation/api/kendo.mvc.ui.fluent/treelistcolumnbuilder) instance. ### Lockable(System.Boolean) If set to false, the column will remain in that side of the TreeList where its own locked configuration placed it. #### Parameters ##### value - `System.Boolean` The value for Lockable #### RETURNS Returns the current [TreeListColumnBuilder](https://www.telerik.com/aspnet-core-ui/documentation/api/kendo.mvc.ui.fluent/treelistcolumnbuilder) instance.