DashLoadConfiguration (Function)

Restores the configuration of a Dashboard control. This configuration includes the following elements:

position of internal windows or pages in the Dashboard control.
size of internal windows or pages in the Dashboard control.
visibility of internal windows or 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.

Versions 20 and later

This function is now available in WEBDEV Server.

This function is now available in Browser code.

This function is now available for WEBDEV sites in Linux.

New in version 20

This function is now available in WEBDEV Server.

This function is now available in Browser code.

This function is now available for WEBDEV sites in Linux.

This function is now available in WEBDEV Server.

This function is now available in Browser code.

This function is now available for WEBDEV sites in Linux.

Versions 22 and later

This function is now available for iPhone/iPad applications.

This function is now available for Android applications.

New in version 22

This function is now available for iPhone/iPad applications.

This function is now available for Android applications.

This function is now available for iPhone/iPad applications.

This function is now available for Android applications.

Example

// Asks the user for the configuration that will be loaded
sFile is string

// Opens the file picker
sFile = fSelect("", "", "Select a configuration file...",...
"Dashboard configuration" + TAB + "*.dashconf", "*.dashconf")
// If a file is selected
IF sFile <> "" THEN
// Retrieves the configuration found in the file
sConfiguration is string = fLoadText(sFile)
// Loads the configuration
IF DashLoadConfiguration(DASH_Dashboard, sConfiguration) THEN
ToastDisplay("The configuration was loaded", toastShort, vaMiddle, haCenter)
ELSE
Error("Error while loading the configuration", ErrorInfo())
END
END

// Get a file that was saved beforehand
IF fFileExist(fWebDir() + ["\"] + "DashConfig.tdb") THEN
sMyConfig = fLoadText(fWebDir() + ["\"] + "DashConfig.tdb")
DashLoadConfiguration(DASH_TimeZones, sMyConfig)
END

Versions 22 and later

// Get a file that was saved beforehand
IF fFileExist(fCurrentDir() + ["\"] + "DashConfig.tdb") THEN
sMyConfig = fLoadText(fCurrentDir() + ["\"] + "DashConfig.tdb")
DashLoadConfiguration(DASH_TimeZones, sMyConfig)
END

New in version 22

// Get a file that was saved beforehand
IF fFileExist(fCurrentDir() + ["\"] + "DashConfig.tdb") THEN
sMyConfig = fLoadText(fCurrentDir() + ["\"] + "DashConfig.tdb")
DashLoadConfiguration(DASH_TimeZones, sMyConfig)
END

Syntax

<Result> = DashLoadConfiguration(<Dashboard control> , <Configuration>)

<Result>: Boolean

True if the configuration was loaded.
False otherwise. For more details about the error, use the ErrorInfo function.

<Dashboard control>: Control name

Name of Dashboard control to use.

<Configuration>: Character string (with quotes)

Configuration to restore. This configuration is the result of DashSaveConfiguration.
Caution: If the format of this parameter is invalid or if it cannot be applied to the Dashboard control (because the internal windows/pages or the number of columns do not correspond for example), <Result> is set to False.

Remarks

The widgets declared visible since the last backup must be visible when loading the configuration.

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: wd260obj.dll