DashInitialConfiguration (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.

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

DashInitialConfiguration (Function)

In french: TDBConfigurationInitiale

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

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

// -- 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 = DashAddWidget(MySelf, IW_Widget_KeyNumber, ...
StringBuild("Key numbers for %1", DateToString(dDate, "Mmm YYYY")), ...
dDate)
// Configures the widget (placed on the left)
DashInitialConfiguration(MySelf, nSubscript, nX, nY)
// The next one will be lower
nY++
dDate.Month--
END
// - stock alert
// Adds the widget
nSubscript = DashAddWidget(MySelf, IW_Widget_StockAlert, "Stock alert")
// Configures the widget (placed on the left)
DashInitialConfiguration(MySelf, nSubscript, 5, 1)

Syntax

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

DashInitialConfiguration(<Dashboard control> , <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 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 Dashboard control to use.

<Widget>: Name of internal window or internal page

Name of internal window to use.
Versions 20 and later
Name of internal page to use.
New in version 20
Name of internal page to use.
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 option "Remember 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:

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