TabSaveConfiguration (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

Help

WLanguage

WLanguage functions

Controls, pages and windows

Tab functions

Prefix syntax

TabSaveConfiguration

Presentation

Example

See also

TabSaveConfiguration (Function)

In french: OngletSauveConfiguration

Saves the configuration of the dynamic panes found in a Tab control in character string format. This configuration can be restored by TabLoadConfiguration.

Example

// Asks the user for the backup file
sFile is string

// Opens the file picker
sFile = fSelect("", "", ...
"Select a configuration file...", ...
"Dashboard configuration" + TAB + "*.conf", "*.conf", ...
fselCreate + fselExist)
// If a file is selected
IF sFile <> "" THEN
// Gets the current configuration in a string
sConfiguration is string = TabSaveConfiguration(TAB_Dashboard)
// Saves the configuration
IF fSaveText(sFile, sConfiguration) THEN
ToastDisplay("The configuration was saved", toastShort, vaMiddle, haCenter)
ELSE
Error("Error while saving the configuration file", ErrorInfo())
END
END

Syntax

<Result> = TabSaveConfiguration(<Tab control>)

<Result>: Character string

Configuration saved in the format of a character string.

<Tab control>: Control name

Name of the Tab control to be used.

Remarks

The configuration of the dynamic panes found in a Tab control includes the following elements:
- the existing dynamic panes as well as their rank.
- the internal window associated with each dynamic pane.
To automatically save or restore the user configuration, you can:
- in the editor, check "Remember configuration of tabs" in the "Details" tab of the control description window.
- in the code, use the StoreTheConfiguration property.

Component: wd280obj.dll