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

baseClassName

COLUMNCHECKBOX

Identifies the object as an instance of the ColumnCheckBox class

className

(COLUMNCHECKBOX)

Identifies the object as an instance of custom class. When no custom class exists, defaults to baseClassName

colorHighlight

 

The color of the cell containing the ColumnCheckBox object when the cell has focus

colorNormal

WindowText
/Window

The color of the cell containing the ColumnCheckBox object when the cell does not have focus

value

 

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

hWnd
parent

speedTip
statusMessage

beforeCellPaint
onCellPaint
onGotFocus
onLostFocus

 

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.

The box around the checkmark is displayed only for the cell that has focus. For the other cells in the column 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.