vcl-cxgridcustomview-dot-tcxcustomgridview-dot-storetoinifile-x28-system-dot-string-system-dot-boolean-cxgridcustomview-dot-tcxgridstorageoptions-system-dot-string-system-dot-string-x29.md
Saves grid View state information to an INI file.
procedure StoreToIniFile(const AStorageName: string; AReCreate: Boolean = True; AOptions: TcxGridStorageOptions = []; const ASaveViewName: string = ''; const AOwnerName: string = '');
| Name | Type | Description |
|---|---|---|
| AStorageName | string |
The path to the target INI file.
| | AReCreate | Boolean |
Optional. Specifies if the procedure recreates the target INI file if it exists.
True Default. The procedure deletes the target INI file if it exists and creates a new file.FalseThe procedure adds saved information to the end of the target INI file if it exists. |
| AOptions | TcxGridStorageOptions |
Optional. Specifies a set of individual user interaction states saved to the target INI file (AStorageName).
If this parameter is omitted, the procedure saves only grid View structure information.
| | ASaveViewName | string |
Optional. Specifies the saved grid View name.
Use this parameter if you need to apply a saved state to a different grid View.
| | AOwnerName | string |
Optional. Specifies the parent form name for the TcxGrid control.
Tip
This parameter can be useful for MDI application projects.
|
Call the StoreToIniFile procedure to save the current data layout and specified user interaction states to an INI file. A subsequent RestoreFromIniFile call restores the saved grid View state from the INI file.
Grid View structure information includes the following:
Important
After each StoreToIniFile procedure call, make sure that the grid View maps to the same underlying dataset fields before the corresponding RestoreFromIniFile call. Otherwise, errors may occur.
In addition to the base View Structure/Data Layout, the AOptions parameter available for StoreToIniFile and RestoreFromIniFile procedures allows you to store summaries, filter criteria, and a number of user interaction states (selection, focus, the scroll position, etc.).
Pass a set of all required flags as the AOptions parameter to store/restore corresponding grid View states:
gsoUseFilter | gsoUseSummaryAllow you to store filter criteria and summaries.gsoUseDataViewState
The main flag required for all other user interaction flags listed below. These flags have no effect without gsoUseDataViewState.
Tip
Alternatively, you can use only the cxGridStoreAllDataViewStates constant if you need to store all user interaction states for the grid View.
gsoFocusedItem | gsoFocusedRecord | gsoFocusedViewStore the focus position. Require gsoUseDataViewState.gsoSelectedStores selection. Requires gsoUseDataViewState.gsoTopRecordStores the grid View scroll position. Requires gsoUseDataViewState.gsoExpandedStores the expanded status for all records. Requires gsoUseDataViewState.gsoDetailStores the active detail grid View. Applicable only to master-detail grid View relationships. Requires gsoUseDataViewState.
Alternatively, you can store grid View data layout and user interaction states in a stream, system registry, or custom storage. The TcxCustomGridView class implements the following Store~/Restore~ method pairs in addition to StoreToIniFile and RestoreFromIniFile:
StoreToRegistry | RestoreFromRegistryAllow you to store the grid View state (both data layout and user interaction states) in the system registry.StoreToStorage | RestoreFromStorageAllow you to store the grid View state (both data layout and user interaction states) in a custom data format.StoreToStream | RestoreFromStreamAllow you to store the grid View state (both data layout and user interaction states) in a stream.StoreDataViewState | RestoreDataViewStateAllow you to store user interaction states in memory during the same session.StoreDataViewStateToStream | RestoreDataViewStateFromStreamAllow you to store only user interaction states in a separate stream. See Also