TCustomDrawGrid.OnGetCheckboxState property

Declaration

property OnGetCheckboxState: TGetCheckboxStateEvent read FOnGetCheckboxState write FOnGetCheckboxState;

Description

OnGetCheckboxState is a TGetCheckboxStateEvent property with the event handler signalled to get the state for a check box cell. The ACol and ARow parameters contain the position for the cell. Value contains the TCheckBoxState value for the cell as assigned in the event handler.

OnGetCheckboxState provides the only mechanism to get the state value for a check box cell in TCustomDrawGrid / TDrawGrid. This differs from TCustomStringGrid / TStringGrid, where the TGridColumn instance in Columns can is used (when enabled) to get the checked or unchecked value and determine the state for the cell. This approach can be implemented in the event handler; it is not provided by default.

OnGetCheckboxState is signalled (when assigned) from the GetCheckBoxState method.

Use OnSetCheckboxState to set the state for the check box cell.