Sign in Join
FPDoc Onlineexperiment

TCustomCheckListBox.Header property

Member of TCustomCheckListBoxpublicIn unit CheckLst

Provides indexed access to header usage status for Items in the control.

Declaration

pascal
property Header[AIndex: Integer]: Boolean read GetHeader write SetHeader;

Description

Header is an indexed Boolean property which indicates if the specified item is used as a header (instead of a check box) in the control. When the property contains True, the item is rendered as text and does not include any check box behavior.

Reading the value in Header causes the CheckIndex method to be called to validate the value in Index. If a handle has been allocated for the control, the GetHeader method in the widget set class is called to get the value for the property. Otherwise, the cached item data for the control is examined to get the property value.

Setting a new value for the property causes the CheckIndex method to be called to validate the value in Index. If a handle has been allocated for the control, the SendItemHeader method is called to set the value for the property. Otherwise, the cached item data for the control is updated.

See also

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