TreeListColumnBuilder
Methods
HtmlAttributes(System.Object)
The HTML attributes of the table cell (<td>) that is rendered for the column.
Parameters
value - System.Object
The value that configures the htmlattributes.
HtmlAttributes(System.Collections.Generic.IDictionary)
The HTML attributes of the table cell (<td>) that is rendered for the column.
Parameters
value - System.Collections.Generic.IDictionary<String,Object>
The value that configures the htmlattributes.
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>
The action that configures the command.
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<Object,Object>
The value that configures the editable action.
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 value that configures the editable action.
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 that configures the encoded.
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 that configures the expandable.
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.
Parameters
expression - System.Linq.Expressions.Expression<Func>
The expression that specifies the field, based on the bound model.
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 that configures the field.
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.
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 that configures the footertemplate.
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
value - System.String
The value that configures the footertemplate.
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 that configures the format.
HeaderAttributes(System.Object)
The HTML attributes of the table header cell (<th>) that is rendered for the column.
Parameters
value - System.Object
The value that configures the headerattributes.
HeaderAttributes(System.Collections.Generic.IDictionary)
The HTML attributes of the table header cell (<th>) that is rendered for the column.
Parameters
value - System.Collections.Generic.IDictionary<String,Object>
The value that configures the headerattributes.
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 that configures the headertemplate.
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
value - System.String
The value that configures the headertemplate.
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 that configures the minscreenwidth.
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 that configures the selectable.
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.
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>
The action that configures the sortable.
Template(System.String)
The template which renders the column content. The TreeList renders table rows (<tr>) which represent the data source items. Each table row consists of table cells (<td>) 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 that configures the template.
TemplateId(System.String)
The template which renders the column content. The TreeList renders table rows (<tr>) which represent the data source items. Each table row consists of table cells (<td>) 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 that configures the template.
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 that configures the title.
Width(System.String)
The width of the column. Numeric values are treated as pixels.
Parameters
value - System.String
The value that configures the width.
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 that configures the hidden.
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 that configures the includechildren.
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 that configures the menu.
Locked(System.Boolean)
If set to true, the TreeList will display the column as locked (frozen).
Parameters
value - System.Boolean
The value that configures the locked.
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 that configures the lockable.
FooterTemplateView(System.Web.Mvc.MvcHtmlString)
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.Web.Mvc.MvcHtmlString
The value that configures the footertemplate.
FooterTemplateHandler(System.String)
Parameters
value - System.String
HeaderTemplateView(System.Web.Mvc.MvcHtmlString)
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.Web.Mvc.MvcHtmlString
The value that configures the headertemplate.
HeaderTemplateHandler(System.String)
Parameters
value - System.String
TemplateView(System.Web.Mvc.MvcHtmlString)
The template which renders the column content. The TreeList renders table rows (<tr>) which represent the data source items. Each table row consists of table cells (<td>) which represent the TreeList columns. By default, the HTML-encoded value of the field is displayed in the column.
Parameters
value - System.Web.Mvc.MvcHtmlString
The value that configures the template.
TemplateHandler(System.String)
Parameters
value - System.String
Template(Kendo.Mvc.UI.TemplateBuilder)
Parameters
template - TemplateBuilder<TModel>
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.
Width(System.Int32)
The width of the column. Numeric values are treated as pixels. For more important information, please refer to Column Widths.
Parameters
value - System.Int32
The value that configures the width.
Sortable()
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.
Filterable()
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.
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>
The action that configures the filterable.
EditorTemplateComponentName(System.String)
Parameters
templateName - System.String
Draggable()
Defines a Draggable column.