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

Saves View-specific information to an INI file.

Declaration

procedure StoreToIniFile(const AStorageName: string; AReCreate: Boolean = True; AOptions: TcxGridStorageOptions = []; const ASaveViewName: string = ''; const AOwnerName: string = '');

Parameters

Name	Type
AStorageName	string
AReCreate	Boolean
AOptions	TcxGridStorageOptions
ASaveViewName	string
AOwnerName	string

Remarks

Use the StoreToIniFile method to save View-specific information to an INI file. This information can be restored after changes have been applied to a View. View structure is restored after the RestoreFromIniFile method call. Before restoring the View structure, ensure that the View is connected to a data set containing data fields assigned to the same View items as saved in the INI file.

View structure information includes:

• View class and instance names;

• View element settings. These settings include only those settings that can be adjusted by end-users: the position, size, and visibility within a View, sort order, etc.

The AStorageName parameter specifies the path and name of the file where to store View settings.

The AReCreate parameter determines whether the required INI file is recreated via each call of the StoreToIniFile method. If this parameter value is True, then the existing INI file is deleted and then created again. Otherwise, information is appended to the end of the existing file.

For information on the AOptions and ASaveViewName parameters, see the description of the RestoreFromIniFile method.

To customize the list of the View’s properties which are saved to an INI file, handle the OnGetStoredProperties and OnGetStoredPropertyValue events.