TcxCustomGridView.RestoreFromIniFile(string,Boolean,Boolean,TcxGridStorageOptions,string,string) Method

Restores previously saved grid View state information from an INI file.

Declaration

procedure RestoreFromIniFile(const AStorageName: string; AChildrenCreating: Boolean = True; AChildrenDeleting: Boolean = False; AOptions: TcxGridStorageOptions = [gsoUseFilter, gsoUseSummary]; const ARestoreViewName: string = ''; const AOwnerName: string = '');

Parameters

Name	Type	Description
AStorageName	string	The path to the source INI file.
AChildrenCreating	Boolean	Optional. Specifies if the procedure creates missing grid View elements (columns, bands, series, etc.): True Default. The procedure creates additional grid View elements to match the loaded structure state. Tip You can handle the OnInitStoredObject event to initialize created data items. False The procedure does not create any elements if the current structure contains fewer elements compared to the loaded structure state.
AChildrenDeleting	Boolean	Optional. Specifies if the procedure deletes redundant grid View elements (columns, bands, series, etc.): False Default. The procedure does not delete any elements if the current structure contains more elements than the loaded structure state. True The procedure deletes all elements that do not match the loaded structure state. If the current grid View structure matches the loaded state, the AChildrenDeleting parameter is ignored.
AOptions	TcxGridStorageOptions	Optional. Specifies a set of individual user interaction states restored from the source stream (AStream). If this parameter is omitted, the procedure loads only grid View structure information, even if the source stream contains user interaction state information.
ARestoreViewName	string	Optional. Specifies the source 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.

Remarks

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.

Stored Information

View Structure | Data Layout

Grid View structure information includes the following:

• Grid View type and name.
• All grid View element settings available to end users for customization: position, dimensions, visibility, sort order, etc. You can use optional AChildrenCreating and AChildrenDeleting parameters to update the current grid View data layout according to the loaded state.

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.

View and User Interaction States (Optional)

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 | gsoUseSummary

Allow 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 | gsoFocusedView

Store/restore the focus position. Require gsoUseDataViewState.

gsoSelected

Stores/restores selection. Requires gsoUseDataViewState.

gsoTopRecord

Stores/restores the grid View scroll position. Requires gsoUseDataViewState.

gsoExpanded

Stores/restores the expanded status for all records. Requires gsoUseDataViewState.

gsoDetail

Stores/restores the active detail grid View. Applicable only to master-detail grid View relationships. Requires gsoUseDataViewState.

Other View State Store/Restore Methods

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 | RestoreFromRegistry

Allow you to store the grid View state (both data layout and user interaction states) in the system registry.

StoreToStorage | RestoreFromStorage

Allow you to store the grid View state (both data layout and user interaction states) in a custom data format.

StoreToStream | RestoreFromStream

Allow you to store the grid View state (both data layout and user interaction states) in a stream.

StoreDataViewState | RestoreDataViewState

Allow you to store user interaction states in memory during the same session.

StoreDataViewStateToStream | RestoreDataViewStateFromStream

Allow you to store only user interaction states in a separate stream.