Sign in Join
FPDoc Onlineexperiment

TCustomGrid.GetGridDrawState function

Member of TCustomGridprotectedIn unit Grids

Gets the grid drawing state for the cell with the specified column and row numbers.

Declaration

pascal
function GetGridDrawState(ACol: Integer; ARow: Integer): TGridDrawState

Arguments

ACol

Column number for the cell examined in the method.

ARow

Row number for the cell examined in the method.

Function result

TGridDrawState instance with the state flags for the specified cell.

Description

GetGridDrawState is a TGridDrawState function used to get the state flags for the cell specified in ACol and ARow. The return value can contain the following enumeration values:

gdFixed
ARow is one of the FixedRows for the grid.
gdFocused
ACol and ARow have the same values as the Col and Row properties.
gdSelected
ACol and ARow have the same values as the Col and Row properties, or the cell is included in a selection range.
gdRowHighlight
Row highlighting is enabled in Options, Row and aRow have the same value, and the cell is not a fixed cell.
gdPushed
ACol and ARow match the cached PushedCell coordinates.
gdHot
ACol and ARow match the cached HotCell coordinates, and the cell is not "pushed".

GetGridDrawState is called from the DrawRow and ShowCellHintWIndow methods.

See also

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