PC SOFT

ONLINE HELP
 WINDEVWEBDEV AND WINDEV MOBILE

Home | Sign in | English EN
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
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
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
  • 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: wd280obj.dll
Minimum version required
  • Version 19
This page is also available for…
Comments
Click [Add] to post a comment