TreeListColumnTagHelper

Example

Razor

<treelist-column>
    <columns></columns>
    <commands></commands>
    <filterable />
    <sortable />
    <treelist-column-editor-template></treelist-column-editor-template>
    <treelist-column-template></treelist-column-template>
</treelist-column>

ChildTags

Tag Name	Details
columns	TreeListNestedColumnsTagHelper
commands	TreeListColumnCommandsTagHelper
filterable	TreeListColumnFilterableSettingsTagHelper
sortable	TreeListColumnSortableSettingsTagHelper
treelist-column-editor-template	TemplateTagHelper
treelist-column-template	TemplateTagHelper

Attributes

Attribute	Type	Description
draggable	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.
editable	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.
editor	String	Provides a way to specify a custom editing UI for the column. To create the editing UI, use the container parameter.When used as String, defines the editor widget type. For further info check the Form API: field
editor-handler	String	Provides a way to specify a custom editing UI for the column. To create the editing UI, use the container parameter.When used as String, defines the editor widget type. For further info check the Form API: field
encoded	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.
expandable	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.
field	String	The field to which the column is bound. The value of this field is displayed by the column during data binding.
footer-template	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)..
footer-template-handler	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)..
footer-template-id	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)..
footer-template-view	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)..
format	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.
header-attributes	IDictionary<String,Object>	The HTML attributes of the table header cell (<th>) that is rendered for the column.
header-template	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.
header-template-handler	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.
header-template-id	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.
header-template-view	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.
hidden	Boolean	If set to true, the TreeList will not display the column. By default, all columns are displayed.
html-attributes	IDictionary<String,Object>	The HTML attributes of the table cell (<td>) that is rendered for the column.
include-children	Boolean	If set to true, the TreeList will select all child rows upon parent row selection when checkbox selection is used.
lockable	Boolean	If set to false, the column will remain in that side of the TreeList where its own locked configuration placed it.
locked	Boolean	If set to true, the TreeList will display the column as locked (frozen).
menu	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.
min-screen-width	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.
selectable	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.
template	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.
template-handler	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.
template-id	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.
template-view	IHtmlContent	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.
title	String	The text that is displayed in the column header cell. If not set, the TreeList uses field.
width	String	The width of the column. Numeric values are treated as pixels.