<Dashboard>.InitialConfiguration (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

This content has been translated automatically. Click here to view the French version.

Help / WLanguage / WLanguage functions / Controls, pages and windows / Dashboard functions

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

<Dashboard>.InitialConfiguration (Function)

In french: <Tableau de bord>.ConfigurationInitiale

Not 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.

Example

// -- Initialisation de TDB_TableauDeBord
// Ajoute des informations dans la configuration initiale :
// - chiffres clés des 3 derniers mois
nX = 1 ; nY = 3
FOR i = 1 TO 3
	// Ajoute le widget
	nIndice = TDB_TableauDeBord.AjouteWidget(FI_Widget_ChiffreClé, ...
			StringBuild("Chiffres de %1", DateToString(dDate, "Mmm AAAA")), ...
			dDate)
	// Configure le widget (calé à gauche)
	TDB_TableauDeBord.ConfigurationInitiale(nIndice, nX, nY)
	// Le prochain sera plus bas
	nY++
	dDate.Month--
END
// - alerte de stock
// Ajoute le widget
nIndice = TDB_TableauDeBord.AjouteWidget(FI_Widget_AlerteStock, "Alerte stock")
// Configure le widget (calé à gauche) 
TDB_TableauDeBord.ConfigurationInitiale(nIndice, 5, 1)

Syntax

Initial configuration: manipulate the Widget by its index Hide the details

<Dashboard control>.InitialConfiguration(<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 <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: manipulate the Widget by name Hide the details

<Dashboard control>.InitialConfiguration(<Widget> [, <X> [, <Y> [, <Width> [, <Height>]]]])

<Dashboard control>: Control name

Name of the Dashboard control to be used.

<Widget>: Name of the internal window or page

Name of the internal window to be used.
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.
The <Dashboard>.InitialConfiguration function is not taken into account 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:

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