Edit this page

Kendo.Mvc.UI.Fluent.TreeListColumnBuilder

Defines the fluent API for configuring the TreeListColumn settings.

Methods

HtmlAttributes(System.Object)

HTML attributes of the table cell (

) rendered for the column.

Parameters

value System.Object

The value that configures the htmlattributes.

HtmlAttributes(System.Collections.Generic.IDictionary<System.String,System.Object>)

HTML attributes of the table cell (

) rendered for the column.

Parameters

value System.Collections.Generic.IDictionary<System.String,System.Object>

The value that configures the htmlattributes.

Command(System.Action<Kendo.Mvc.UI.Fluent.TreeListColumnCommandFactory<T>>)

The configuration of the column command(s). If set the column would display a button for every command. Commands can be custom or built-in ("edit", "createChild" or "destroy"): The "edit" built-in command switches the current table row to edit mode.; The "createChild" built-in command adds a new child item to the current table row and switches to edit mode. or The "destroy" built-in command 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<Kendo.Mvc.UI.Fluent.TreeListColumnCommandFactory>

The action that configures the command.

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<System.Func<T,T1>>)

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<System.Func<T,T1>>

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

value System.String

The value that configures the field.

Filterable(System.Boolean)

If set to true a filter menu will be displayed for this column when filtering is enabled. 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 via 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.

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

If set to true a filter menu will be displayed for this column when filtering is enabled. 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 via the filterable option.Can be set to a JavaScript object which represents the filter menu configuration.

Parameters

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

The action that configures the filterable.

FooterTemplate(System.String)

The template which renders the footer table cell for the column.The fields which can be used in the template are: 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); sum - the value of the "sum" aggregate (if specified) or data - provides access to all available aggregates, e.g. data.fieldName1.sum or data.fieldName2.average.

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 fields which can be used in the template are: 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); sum - the value of the "sum" aggregate (if specified) or data - provides access to all available aggregates, e.g. data.fieldName1.sum or data.fieldName2.average.

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 form "{0:format}" 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)

HTML attributes of the table header cell (

) rendered for the column.

Parameters

value System.Object

The value that configures the headerattributes.

HeaderAttributes(System.Collections.Generic.IDictionary<System.String,System.Object>)

HTML attributes of the table header cell (

) rendered for the column.

Parameters

value System.Collections.Generic.IDictionary<System.String,System.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, so the two should not be used at the same time.

Parameters

value System.Double

The value that configures the minscreenwidth.

Sortable(System.Boolean)

If set to true the user can click the column header and sort the treelist by the column field when sorting is enabled. If set to false sorting will be disabled for this column. By default all columns are sortable if sorting is enabled via the sortable option.

Parameters

enabled System.Boolean

Enables or disables the sortable option.

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

If set to true the user can click the column header and sort the treelist by the column field when sorting is enabled. If set to false sorting will be disabled for this column. By default all columns are sortable if sorting is enabled via the sortable option.

Parameters

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

The action that configures the sortable.

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 that configures the template.

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

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 field is used.

Parameters

value System.String

The value that configures the title.

Width(System.String)

The width of the column. Numeric values are treated as pixels. For more important information, please refer to Column Widths.

Parameters

value System.String

The value that configures the width.

Hidden(System.Boolean)

If set to true the column will not be displayed in the treelist. By default all columns are displayed.

Parameters

value System.Boolean

The value that configures the hidden.

If set to true the column will be visible in the grid column menu. By default the column menu includes all data-bound columns (ones that have their field set).

Parameters

value System.Boolean

The value that configures the menu.

Locked(System.Boolean)

If set to true the column will be displayed as locked (frozen) in the treelist. Also see the information about Frozen Columns in the Grid Appearance article.

Parameters

value System.Boolean

The value that configures the locked.

Lockable(System.Boolean)

If set to false the column will remain in the side of the treelist into which its own locked configuration placed it.

Parameters

value System.Boolean

The value that configures the lockable.

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 the user can click the column header and sort the grid by the column field when sorting is enabled. If set to false sorting will be disabled for this column. By default all columns are sortable if sorting is enabled via the sortable option.

Filterable

If set to true a filter menu will be displayed for this column when filtering is enabled. 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 via the filterable option. Can be set to a JavaScript object which represents the filter menu configuration.