ONLINE HELP
 WINDEVWEBDEV AND WINDEV MOBILE

Help / WLanguage / WLanguage functions / Controls, pages and windows / Dashboard functions
WINDEV
WindowsLinuxUniversal Windows 10 AppJavaReports and QueriesUser code (UMC)
WEBDEV
WindowsLinuxPHPWEBDEV - Browser code
WINDEV Mobile
AndroidAndroid Widget iPhone/iPadIOS WidgetApple WatchMac CatalystUniversal Windows 10 App
Others
Stored procedures
DashInitialConfiguration (Function)
In french: TDBConfigurationInitiale
AjaxNot available
Modifies the configuration of a Dashboard control (defined in the editor) before its first display. This allows you to configure and to take into account the widgets declared in programming by DashAddWidget.
Example
WINDEVAndroidiPhone/iPadMac Catalyst
// -- Initialize DASH_Dashboard
// Adds information to the initial configuration:
// - key numbers for the last 3 months
nX = 1 ; nY = 3
FOR i = 1 TO 3
// Adds the widget
nIndex = DashAddWidget(MySelf, IW_Widget_KeyNumber, ...
StringBuild("Key numbers for %1", DateToString(dDate, "Mmm YYYY")), ...
dDate)
// Configures the widget (placed on the left)
DashInitialConfiguration(MySelf, nIndex, nX, nY)
// The next one will be lower
nY++
dDate.Month--
END
// - stock alert
// Adds the widget
nIndex = DashAddWidget(MySelf, IW_Widget_StockAlert, "Stock alert")
// Configures the widget (placed on the left)
DashInitialConfiguration(MySelf, nIndex, 5, 1)
Syntax

Initial configuration: handling the widget by its index Hide the details

DashInitialConfiguration(<Dashboard control> , <Widget index> [, <X> [, <Y> [, <Width> [, <Height>]]]])
<Dashboard control>: Control name
Name of the Dashboard control to be used.
<Widget index>: Integer
Index of the widget to use. This index corresponds to:
  • the addition number of widget defined in the window editor or in the page editor.
  • the addition number of widget returned by DashAddWidget.
<X>: Optional integer
Horizontal position of widget in number of cells.
If [<X>, <Y>] are not specified or if their value is equal to [0,0], the widget is positioned on the first free location.
The first cell is cell [1, 1].
<Y>: Optional integer
Vertical position of widget in number of cells.
If [<X>, <Y>] are not specified or if their value is equal to [0,0], the widget is positioned on the first free location.
The first cell is cell [1, 1].
<Width>: Optional integer
Width of widget in number of cells.
If [<Width>, <Height>] are not specified or if their value is equal to [0, 0]:
  • during the first call to DashInitialConfiguration, the widget size corresponds to the size of source internal window or page (at least 1 cell).
  • during the next calls to DashInitialConfiguration, the widget size corresponds to the size defined during the first call.
<Height>: Optional integer
Height of widget in number of cells.
If [<Width>, <Height>] are not specified or if their value is equal to [0, 0]:
  • during the first call to DashInitialConfiguration, the widget size corresponds to the size of source internal window or page (at least 1 cell).
  • during the next calls to DashInitialConfiguration, the widget size corresponds to the size defined during the first call.

Initial configuration: handling the widget by its name Hide the details

DashInitialConfiguration(<Dashboard control> , <Widget> [, <X> [, <Y> [, <Width> [, <Height>]]]])
<Dashboard control>: Control name
Name of the Dashboard control to be used.
<Widget>: Name of internal window or internal page
  • WINDEVAndroidiPhone/iPadMac Catalyst Name of the internal window to be used.
  • WEBDEV - Server codeWEBDEV - Browser code Name of internal page to use.
<X>: Optional integer
Horizontal position of widget in number of cells.
If [<X>, <Y>] are not specified or if their value is equal to [0,0], the widget is positioned on the first free location.
The first cell is cell [1, 1].
<Y>: Optional integer
Vertical position of widget in number of cells.
If [<X>, <Y>] are not specified or if their value is equal to [0,0], the widget is positioned on the first free location.
The first cell is cell [1, 1].
<Width>: Optional integer
Width of widget in number of cells.
If [<Width>, <Height>] are not specified or if their value is equal to [0, 0]:
  • during the first call to DashInitialConfiguration, the widget size corresponds to the size of source internal window or page (at least 1 cell).
  • during the next calls to DashInitialConfiguration, the widget size corresponds to the size defined during the first call
<Height>: Optional integer
Height of widget in number of cells.
If [<Width>, <Height>] are not specified or if their value is equal to [0, 0]:
  • during the first call to DashInitialConfiguration, the widget size corresponds to the size of source internal window or page (at least 1 cell).
  • during the next calls to DashInitialConfiguration, the widget size corresponds to the size defined during the first call
Remarks
  • An error occurs if DashInitialConfiguration is called after the initialization of the Dashboard control.
  • The widgets configured by DashInitialConfiguration will be loaded and made visible after the execution of the initialization processes.
  • DashInitialConfiguration is ignored in the following cases:
    • The "Remember configuration of Widgets" option is checked in the Dashboard control description window ("Details" tab) and the user makes the widget invisible.
    • The user made the widget invisible and the configuration of the Dashboard control was saved then reloaded.
Related Examples:
WD Dashboard 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.
Component: wd290obj.dll
Minimum version required
  • Version 19
This page is also available for…
Comments
Click [Add] to post a comment

Last update: 07/03/2023

Send a report | Local help