TCustomCheckListBox.State

Provides indexed access to the TCheckBoxState for Items in the control.

Declaration

Source position: checklst.pas line 85

Description

State is an indexed TCheckBoxState property which provides access to the check box state for Items in the control. The TCheckBoxState enumeration value indicates whether the specified item is in a Checked, Unchecked, or Grayed state.

Reading the value in State causes the CheckIndex method to be called to validate the value in AIndex. If a handle has been allocated for the control, the GetState 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 value for the property.

Setting the value in State causes the CheckIndex method to be called to validate the value in AIndex. If a handle has been allocated for the control, the SendItemState method is called to set the value for the property in the widget set class. Otherwise, the cached item data for the control is updated with the new property value.

Use Checked to get or set the check box state for an item in the control using a Boolean value. Use CheckAll to set the check box state for all Items in the control. Use Toggle to select the next check box state for an item in the control.

See also