Skip to main content

TdxCustomTileControl.StoreToIniFile(string,Boolean,string) Method

Saves the tile control’s settings to an INI file.

Declaration

procedure StoreToIniFile(AStorageName: string; AReCreate: Boolean = True; const ASaveName: string = '');

Parameters

Name Type
AStorageName string
AReCreate Boolean
ASaveName string

Remarks

The StoreTo~ and RestoreFrom~ methods allow you to persist tile control settings across multiple sessions. Call the StoreToIniFile method to save the tile control’s settings to an INI file. Later, you can call the RestoreFromIniFile method to apply the stored settings to this or another tile control, restoring its state from the INI file.

By default, the stored information includes the following element and layout-specific settings:

You can extend this list with any other settings that need to be persisted by handling the OnGetStoredProperties, OnGetStoredPropertyValue, OnSetStoredPropertyValue, and OnInitStoredObject events.

The AStorageName parameter specifies the INI file path and name.

The AReCreate parameter determines whether the INI file is recreated with each StoreToIniFile method call. If True is passed as the AReCreate parameter, the existing INI file is deleted and then created again. Otherwise, the existing file entries are identified based on the ASaveName parameter value and updated with the corresponding settings being stored. The rest of the settings are appended to the file.

For information on the ASaveName parameter, refer to the RestoreFromIniFile method description.

See Also