Sign in Join
FPDoc Onlineexperiment

TCustomCheckCombo.CheckAll procedure

Member of TCustomCheckCombopublicIn unit ComboEx

Sets the state for all check boxes defined in the control meeting the specified criteria.

Declaration

pascal
procedure CheckAll(AState: TCheckBoxState; AAllowGrayed: Boolean=True; 
 AAllowDisabled: Boolean=True)

Arguments

AState

Checked state for the matching check boxes.

AAllowGrayed

Indicates if grayed check boxes can be updated in the method.

AAllowDisabled

Indicates if disabled check boxes can be updated in the method.

Description

CheckAll is a procedure used to set the checked state for all check boxes defined in the Items for the control. AState contains the state applied to the check boxes defined in the control.

AAllowGrayed indicates whether check boxes with an indeterminate ("grayed") state can be updated in the method. AAllowDisabled indicates whether check boxes which are not enabled can be updated in the method.

CheckAll iterates over the Items defined for the control, and when allowed using the specified arguments, sets the value in the State property to the value in AState.

CheckAll is a convenience method; the same result can be achieved by setting the value in the State or Checked properties for an individual check box at a specified position.

See also

An experiment, built from development snapshots. Not the official Free Pascal or Lazarus documentation.