DashSaveConfiguration (Function)

Saves the configuration of a Dashboard control in string format. This configuration includes the following elements:

position of internal windows/pages in the Dashboard control.
size of internal windows/pages in the Dashboard control.
visibility of internal windows/pages in the Dashboard control.

Remark: To automatically save or restore the user configuration, check "Remember configuration of Widgets" in the "Details" tab of the control description window.

Example

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

// Opens the file picker
sFile = fSelect("", "", "Select a configuration file...", ...
"Dashboard configuration" + TAB + "*.dashconf", "*.dashconf", ...
fselCreate + fselExist)
// If a file is selected
IF sFile <> "" THEN
// Gets the current configuration in a string
sConfiguration is string = DashSaveConfiguration(DASH_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> = DashSaveConfiguration(<Dashboard control>)

<Result>: Character string

Configuration of Dashboard control.
This configuration can be saved by fSaveText or SaveParameter.
This configuration can be restored by DashLoadConfiguration.

<Dashboard control>: Control name

Name of the Dashboard control to be used.

Related Examples:

Training (WINDEV): WD Dashboard

[ + ] The "WD Dashboard" example is an educational example for using the Dashboard control.
This example explains how to:
- handle the control in "edit" mode,
- save/load a configuration,
- configure the control (initial configuration, addition/deletion of widgets, ...),
- refresh a widget,
- etc.

Training (WEBDEV): WW_Dashboard

[ + ] The "WD Dashboard" example is an educational example for using the Dashboard control.
This example explains how to:
- handle the control in "edit" mode,
- save/load a configuration,
- configure the control (initial configuration, addition/deletion of widgets, ...),
- refresh a widget.

Component: wd280obj.dll