class ColumnCheckBox
A checkbox in a grid column.
Syntax
These controls are created by assigning the appropriate editorType to the GridColumn object.
Properties
The following tables list the properties of interest in the ColumnCheckBox class. (No particular events or methods are associated with this class.)
|
Property |
Default |
Description |
|
COLUMNCHECKBOX |
Identifies the object as an instance of the ColumnCheckBox class | |
|
(COLUMNCHECKBOX) |
Identifies the object as an instance of custom class. When no custom class exists, defaults to baseClassName | |
|
|
The color of the cell containing the ColumnCheckBox object when the cell has focus | |
|
WindowText |
The color of the cell containing the ColumnCheckBox object when the cell does not have focus | |
|
|
The current value of the check box (true or false)
|
The following table lists the common properties, events, and methods of the ColumnCheckBox class:
|
Property |
|
Event |
|
Method |
|
none |
Description
A ColumnCheckBox is a simplified CheckBox control in a grid column. When the enumerated editorType property of a GridColumn control is set to CheckBox, the column uses a ColumnCheckBox control, which is accessible through the GridColumn object’s editorControl property.
By default, the checkbox around the checkmark is displayed
for all grid cells in the column.
This can be changed by toggling the grid property alwaysDrawCheckBox
to
false.
When false, alwaysDrawCheckBox
causes the grid to only draw the checkbox for the columnCheckBox cell
that has focus. For columnCheckBox cells that do not have focus, there
is only a checkmark if the value is true; or nothing if the value is false
(the cell appears empty).
As with all column controls, the dataLink
and width for the control is
in the parent GridColumn object, not the control itself. The height
is controlled by the cellHeight
of the grid.
If a mouse event is implemented for this control it overrides the matching
grid level event.