TcxCustomTreeList.StoreToIniFile(string,Boolean,string,TcxTreeListStorageOptions) Method

Saves Tree List state information to an INI file.

Declaration

procedure StoreToIniFile(AStorageName: string; AReCreate: Boolean = True; const ASaveTreeListName: string = ''; AOptions: TcxTreeListStorageOptions = []);

Parameters

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. False The procedure adds saved information to the end of the target INI file if it exists.
ASaveTreeListName	string	Optional. Specifies the saved Tree List name. Use this parameter if you need to apply a saved state to a different Tree List control.
AOptions	TcxTreeListStorageOptions	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 Tree List structure information.

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 Tree List state from the INI file.

Stored Information

Tree List Structure | Data Layout

Tree List structure information includes the following:

• Tree List name.
• All Tree List element settings available to end users for customization: position, dimensions, visibility, sort order, captions, etc.

Important

After each StoreToIniFile procedure call, make sure that the Tree List control maps to the same underlying dataset fields before the corresponding RestoreFromIniFile call. Otherwise, errors may occur.

Tree List User Interaction States (Optional)

In addition to the base Tree List Structure/Data Layout, the AOptions parameter available for StoreToIniFile and RestoreFromIniFile procedures allows you to store a number of user interaction states (selection, focus, scroll position, node expanded status, etc.)

Pass a set of all required flags as the AOptions parameter to store/restore corresponding Tree List user interaction states:

tsoUseDataViewState

The main flag required for all other user interaction flags listed below. These flags have no effect without tsoUseDataViewState.

Tip

Alternatively, you can use only the cxTreeListStoreAllDataViewStates constant if you need to store all user interaction states for the Tree List.

tsoFocusedItem | tsoFocusedRecord

Store the focus position.

tsoSelected

Stores selection.

tsoTopRecord

Stores the Tree List scroll position (the record at the top control border).

tsoExpanded

Stores the expanded status for all nodes.

Other Tree List Store/Restore Methods

Alternatively, you can store Tree List data layout and user interaction states in memory, a stream, or the system registry. The TcxCustomTreeList class implements the following Store~/Restore~ method pairs in addition to StoreToIniFile and RestoreFromIniFile:

StoreToRegistry | RestoreFromRegistry

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

StoreToStream | RestoreFromStream

Allow you to store the Tree List 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.