Sign in Join
FPDoc Onlineexperiment

TCustomGrid.ClearCols function

Member of TCustomGridpublicIn unit Grids

Clears the values in the FixedCols and Cols properties.

Declaration

pascal
function ClearCols: Boolean

Function result

True if the vales are successfully cleared in the method.

Description

ClearCols is a Boolean function used to reset values stored in the FixedCols and Cols properties. No actions are performed in the method when the Cols property is empty (Count=0). In this case, the return value is False.

ClearCols ensures that values in EditorMode, ColCount, and FixedCols are reset. For ColCount, this means the length of the internal Integer list is set to 0. The top, left column offset for the visible area in the control is also reset in GCache.

ClearCols is called from the Clear method prior to updating other visuals aspects for the control.

See also

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