Sign in Join
FPDoc Onlineexperiment

TCustomDBGrid.DoSaveColumn procedure

Member of TCustomDBGridprotectedIn unit DBGrids

Saves the specified column definition to the specified XML configuration file.

Declaration

pascal
procedure DoSaveColumn(sender: TCustomGrid; aColumn: TGridColumn; 
 aColIndex: Integer; aCfg: TXMLConfig; 
 aVersion: Integer; aPath: string); override

Arguments

sender

Grid control with the column information stored in the method.

aColumn

TGridColumn instance with the columnn information stored in the method.

aColIndex

Ordinal position for the column in the Columns collection.

aCfg

XML configuration file where the column information is stored.

aVersion

Value for the GRIDFILEVERSION constant used in the implementation.

aPath

XPATH-like path where the column information is stored in the XML document.

Description

DoSaveColumn is an overridden method in TCustomDBGrid. It ensures that AColumn is cast to the TColumn type used in the Columns collection, and the FieldName and DisplayFormat properties for the column are written to the XML configuration file. It calls the inherited method to signal the OnSaveColumn event handler (when assigned).

DoSaveColumn is called from the SaveContent method in the TCustomGrid ancestor.

See also

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