Sign in Join
FPDoc Onlineexperiment

TCustomGrid.ColumnIndexFromGridColumn function

Member of TCustomGridprotectedIn unit Grids

Gets the position of the specified column relative to the first column in the grid.

Declaration

pascal
function ColumnIndexFromGridColumn(Column: Integer): Integer

Arguments

Column

Column number to locate in the grid.

Function result

Relative position for the specified column.

Description

ColumnIndexFromGridColumn is an Integer function used to get the position of the specified column relative to the first column in the grid. The return value contains the difference between Column and FirstGridColumn when Columns have been enabled in the grid control. RealIndex is called to translate the position used in the return value. If Columns have not been enabled, the return value is -1.

ColumnIndexFromGridColumn is used in the implementation of TCustomGrid methods like:

  • ColumnFromGridColumn
  • DoOPExchangeColRow
  • DoOPInsertColRow
  • DoOPMoveColRow
  • DoOPDeleteColRow

See also

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