Sign in Join
FPDoc Onlineexperiment

TCustomGrid.GetImageForCheckBox procedure

Member of TCustomGridprotectedIn unit Grids

Gets the bitmap used to draw check box columns in the grid.

Declaration

pascal
procedure GetImageForCheckBox(const aCol: Integer; const aRow: Integer; 
 CheckBoxView: TCheckBoxState; 
 var ImageList: TCustomImageList; 
 var ImageIndex: TImageIndex; 
 var Bitmap: TBitmap); virtual

Description

GetImageForCheckBox signals the OnUserCheckboxBitmap event handler (when assigned) to get a bitmap used for the check box state. If a valid TBitmap instance is not assigned in the event handler, the OnUserCheckBoxImage event handler is signalled (when assigned) to get the TImageList, TBitmap, and ImageIndex used for the purpose.

GetImageForCheckBox is used in the implementation of the DrawGridCheckboxBitmaps and DrawCellText methods in TCustomGrid.

See also

An experiment, built from Lazarus main 2dfa93c66e of 10-22-2026. Not the official Lazarus documentation.