New to Kendo UI for Angular? Start a free 30-day trial

CheckboxColumnComponent

Represents the checkbox for selecting rows in the TreeList. See example.

Selector

kendo-treelist-checkbox-column

Inputs

NameTypeDefaultDescription

autoSize

boolean

Indicates whether the column will be resized during initialization so that it fits its header and row content.

checkChildren

boolean

Determines whether checkbox click should select / unselect all children

columnMenu

boolean

true

Specifies if the column menu will be shown for the column.

class

string | string[] | Set<string> | {[key: string]: any}

Sets the custom CSS classes to the column cells. Under the hood, to apply the property, the class option uses the NgClass directive. To customize header and footer column cells, use the headerClass and footerClass inputs.

expandable

boolean

false

Defines whether the expanded indicator should be rendered in the column.

footerClass

string | string[] | Set<string> | {[key: string]: any}

Sets the custom CSS classes to the column footer cell. Under the hood, to apply the property, the footerClass option uses the NgClass directive. See example.

footerStyle

{[key: string]: string}

Sets the custom styles for the footer cell of the column. Under the hood, to apply the property, the footerStyle option uses the NgStyle directive. See example.

headerClass

string | string[] | Set<string> | {[key: string]: any}

Sets the custom CSS classes to the column header cell. Under the hood, to apply the property, the headerClass option uses the NgClass directive. See example.

headerStyle

{[key: string]: string}

Sets the custom styles for the header cell of the column. Under the hood, to apply the property, the headerStyle option uses the NgStyle directive. See example.

hidden

boolean

false

Sets the visibility of the column (see example).

includeInChooser

boolean

true

Specifies if the column will be included in the column-chooser list.

lockable

boolean

true

Specifies if the column can be locked or unlocked from the column menu or by reordering the columns.

locked

boolean

false

Toggles the locked (frozen) state of the columns (more information and example).

media

string

Sets the condition that needs to be satisfied for a column to remain visible (see example). If you set the hidden property, the behavior of media is overridden.

minResizableWidth

number

10

The width (in pixels) below which the user is not able to resize the column by using the UI.

reorderable

boolean

true

Indicates whether the column is reorderable.

resizable

boolean

true

Indicates whether the column is resizable.

showSelectAll

boolean

Determines whether a select-all checkbox will be displayed in the header.

style

{[key: string]: string}

Sets the custom styles for the table cells (excluding the footer and header ones) of the column. Under the hood, to apply the property, the style option uses the NgStyle directive. See example.

tableCellsRole

string

"gridcell"

Allows setting the role attribute for the table cells (excluding the footer and header ones) of the column.

title

string

The title of the column.

width

number

The width of the column (in pixels).

Fields

NameTypeDefaultDescription

orderIndex

number

0

The column index after reordering. The orderIndex` is a read-only property. Setting this field does not affect column order.

In this article

Not finding the help you need?