PC SOFT

WINDEVWEBDEV AND WINDEV MOBILE
ONLINE HELP

Home | Sign in | English UK
WINDEV
WindowsLinuxUniversal Windows 10 AppJavaReports and QueriesUser code (UMC)
WEBDEV
WindowsLinuxPHPWEBDEV - Browser code
WINDEV Mobile
AndroidAndroid Widget iPhone/iPadApple WatchUniversal Windows 10 AppWindows Mobile
Others
Stored procedures
<Dashboard>.InitialConfiguration (Function)
In french: <Tableau de bord>.ConfigurationInitiale
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 <Dashboard>.AddWidget.
Versions 20 and later
WEBDEV - Server codeWindows This function is now available in WEBDEV Server.
WEBDEV - Browser code This function is now available in Browser code.
WEBDEV - Server codeLinux This function is now available for WEBDEV sites in Linux.
New in version 20
WEBDEV - Server codeWindows This function is now available in WEBDEV Server.
WEBDEV - Browser code This function is now available in Browser code.
WEBDEV - Server codeLinux This function is now available for WEBDEV sites in Linux.
WEBDEV - Server codeWindows This function is now available in WEBDEV Server.
WEBDEV - Browser code This function is now available in Browser code.
WEBDEV - Server codeLinux This function is now available for WEBDEV sites in Linux.
Versions 22 and later
iPhone/iPad This function is now available for iPhone/iPad applications.
Android This function is now available for Android applications.
New in version 22
iPhone/iPad This function is now available for iPhone/iPad applications.
Android This function is now available for Android applications.
iPhone/iPad This function is now available for iPhone/iPad applications.
Android This function is now available for Android applications.
Example
WINDEVAndroidiPhone/iPad
// -- Initialize DASH_Dashboard
// Adds information into the initial configuration:
// - key numbers for the last 3 months
nX = 1 ; nY = 3
FOR i = 1 TO 3
// Adds the widget
nSubscript = DASH_Dashboard.AddWidget(IW_Widget_KeyNumber, ...
StringBuild("Key numbers for %1", DateToString(dDate, "Mmm YYYY")), ...
dDate)
// Configures the widget (placed on the left)
DASH_Dashboard.InitialConfiguration(nSubscript, nX, nY)
// The next one will be lower
nY++
dDate..Month--
END
// - stock alert
// Adds the widget
nSubscript = DASH_Dashboard.AddWidget(IW_Widget_StockAlert, "Stock alert")
// Configures the widget (placed on the left)
DASH_Dashboard.InitialConfiguration(nSubscript, 5, 1)
Syntax

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

<Dashboard control>.InitialConfiguration(<Widget subscript> [, <X> [, <Y> [, <Width> [, <Height>]]]])
<Dashboard control>: Control name
Name of Dashboard control to use.
<Widget subscript>: Integer
Subscript of widget to use. This subscript corresponds to:
  • the addition number of widget defined in the window editor or in the page editor.
  • the addition number of widget returned by <Dashboard>.AddWidget.
<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 <Dashboard>.InitialConfiguration, the widget size corresponds to the size of source internal window or page (at least 1 cell).
  • during the next calls to <Dashboard>.InitialConfiguration, 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 <Dashboard>.InitialConfiguration, the widget size corresponds to the size of source internal window or page (at least 1 cell).
  • during the next calls to <Dashboard>.InitialConfiguration, the widget size corresponds to the size defined during the first call.

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

<Dashboard control>.InitialConfiguration(<Widget> [, <X> [, <Y> [, <Width> [, <Height>]]]])
<Dashboard control>: Control name
Name of Dashboard control to use.
<Widget>: Name of internal window or internal page
  • WINDEVAndroidiPhone/iPad Name of internal window to use.
  • Versions 20 and later
    WEBDEV - Server codeWEBDEV - Browser code Name of internal page to use.
    New in version 20
    WEBDEV - Server codeWEBDEV - Browser code Name of internal page to use.
    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 <Dashboard>.InitialConfiguration, the widget size corresponds to the size of source internal window or page (at least 1 cell).
  • during the next calls to <Dashboard>.InitialConfiguration, 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 <Dashboard>.InitialConfiguration, the widget size corresponds to the size of source internal window or page (at least 1 cell).
  • during the next calls to <Dashboard>.InitialConfiguration, the widget size corresponds to the size defined during the first call
Remarks
  • An error occurs if <Dashboard>.InitialConfiguration is called after the initialization of the Dashboard control.
  • The Widgets configured by <Dashboard>.InitialConfiguration will be loaded and made visible after the execution of the initialization processes.
  • <Dashboard>.InitialConfiguration is ignored in the following cases:
    • The option "Store the configuration of Widgets" is checked in the description window of the Dashboard control ("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 : wd240obj.dll
Minimum version required
  • Version 23
This page is also available for…
Comments
Click [Add] to post a comment