StoreTheConfiguration (Property)

Determine whether the configuration of the panes in a dynamic Tab control or Ribbon control is automatically saved and restored.
Modify the configuration of the panes in a dynamic Tab control or Ribbon control so that it is automatically saved and restored (or not)

Remark: This property corresponds to the "Remember configuration of panes" option in the "Details" tab of the control description window.

Versions 26 and later

This property is now available for Ribbon controls.

New in version 26

This property is now available for Ribbon controls.

Example

TAB_Dynamic.StoreTheConfiguration = True

Syntax

Finding out whether the configuration of the panes is automatically stored and restored Hide the details

<Result> = <Control used>.StoreTheConfiguration

<Result>: Boolean

True if the configuration of the control panes is automatically saved and restored,
False if the configuration of the control panes is not automatically saved and restored.

<Control used>: Control name

Name of the control to be used:
Dynamic Tab control.
Versions 26 and later
Ribbon control.
New in version 26
Ribbon control.
Ribbon control.

Configuring the saving of the panes Hide the details

<Control used>.StoreTheConfiguration = <New configuration>

<Control used>: Control name

Name of the control to be used:
Dynamic tab control.
Versions 26 and later
Ribbon control.
New in version 26
Ribbon control.
Ribbon control.

<New configuration>: Boolean

True if the configuration of the control panes is automatically saved and restored,
False if the configuration of the control panes is not automatically saved and restored.

Remarks

If this property is set to True after the initialization step, the previous configuration will not be restored in the control.
This property is useful to configure the controls created by ControlCreate and ControlClone.
For a dynamic Tab control, the configuration includes the dynamic panes and their position (i.e. their order).
- "Undocked" dynamic panes will still be undocked when restored, with the same size and position.
- If the internal window accepts simple parameters (strings, integer, boolean), they are stored.
- If the internal window accepts complex parameters (objects, HFSQL connections, ...), the backup is not performed.
- If the internal window is using global variables (the position of a record for example), the restore operation will not give the same result as the backup.
Versions 26 and later
For a Ribbon control, the configuration includes the panes and their position (i.e. their order). "Undocked" panes will still be undocked when restored, with the same size and position.
New in version 26
For a Ribbon control, the configuration includes the panes and their position (i.e. their order). "Undocked" panes will still be undocked when restored, with the same size and position.
For a Ribbon control, the configuration includes the panes and their position (i.e. their order). "Undocked" panes will still be undocked when restored, with the same size and position.
Dynamic Tab control: You can manually save or restore the configuration of the dynamic panes using TabSaveConfiguration/TabLoadConfiguration.