DashAddWidget (Function)

Adds and displays a widget (internal window or page) in a Dashboard control.

Caution: The widgets added by programming are not automatically displayed. You must use DashInitialConfiguration before the Dashboard control is displayed for the first time.

Versions 20 and later

This function is now available in WEBDEV Server.

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 for WEBDEV sites in Linux.

This function is now available in WEBDEV Server.

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

// Add 2 elements
DashAddWidget(DASH_MyDashboard, IW_Sales, "Sales")
DashAddWidget(DASH_MyDashboard, IW_MonthlyStat, "Monthly statistics for July", "201307")

nSubscript is int

// Adds a widget that expects parameters
nSubscript = DashAddWidget(DASH_Dashboard, IW_Widget_Clock, "Clock " + ...
COMBO_AddWidget [COMBO_AddWidget].DisplayValue, ...
COMBO_AddWidget[COMBO_AddWidget].DisplayedValue)

// Display this widget upon request
IF YesNo(Yes, "Do you want to display this widget?") = Yes THEN
DASH_Dashboard[nSubscript].Visible = True
ELSE
ToastDisplay("The widget was added to the dashboard as ""hidden""." + ...
"Switch to edit mode to add it.", ...
toastShort, vaMiddle, haCenter)
END

Versions 20 and later

WgtSub is int
// Adds a widget that expects parameters
WgtSub = DashAddWidget(DASH_TimeZones, IP_Time, "Time" + GetIdentifier(), ...
"Paris", +0)
DashInitialConfiguration(DASH_TimeZones, WgtSub)
// Adds a widget that expects parameters
WgtSub = DashAddWidget(DASH_TimeZones, IP_Time, "Time" + GetIdentifier(), ...
"Honolulu", -12)
DashInitialConfiguration(DASH_TimeZones, WgtSub)
// Adds a widget that expects parameters
WgtSub = DashAddWidget(DASH_TimeZones, IP_Time, "Time" + GetIdentifier(), ...
"Sydney", +9)
DashInitialConfiguration(DASH_TimeZones, WgtSub)

New in version 20

WgtSub is int
// Adds a widget that expects parameters
WgtSub = DashAddWidget(DASH_TimeZones, IP_Time, "Time" + GetIdentifier(), ...
"Paris", +0)
DashInitialConfiguration(DASH_TimeZones, WgtSub)
// Adds a widget that expects parameters
WgtSub = DashAddWidget(DASH_TimeZones, IP_Time, "Time" + GetIdentifier(), ...
"Honolulu", -12)
DashInitialConfiguration(DASH_TimeZones, WgtSub)
// Adds a widget that expects parameters
WgtSub = DashAddWidget(DASH_TimeZones, IP_Time, "Time" + GetIdentifier(), ...
"Sydney", +9)
DashInitialConfiguration(DASH_TimeZones, WgtSub)

Syntax

<Result> = DashAddWidget(<Dashboard control> , <Widget> , <Caption> [, <Parameter 1> [... [, <Parameter N>]]])

<Result>: Integer

Subscript of added element. This subscript can be used to handle the widget.

<Dashboard control>: Control name

Name of Dashboard control to use.

<Widget>: Name of internal window or internal page

Name of the internal window that must be added into the Dashboard control.
Versions 20 and later
Name of the internal page that must be added into the Dashboard control.
New in version 20
Name of the internal page that must be added into the Dashboard control.
Name of the internal page that must be added into the Dashboard control.

<Caption>: Character string (with quotes)

Caption of the Widget. This caption will be displayed in the popup menu of the Dashboard control and it will allow the user to handle the Widget.

<Parameter 1>: Type of value sent to the window or page (optional)

First parameter that will be passed to the "Global declarations" event of the internal window or internal page to open. This parameter is passed by reference and it is considered as being a variable global to the internal window or internal page.
Caution: Only the simple types are available.

<Parameter N>: Type of value sent to the window or page (optional)

Nth parameter that will be passed to the "Global declarations" event of the internal window or internal page to open. This parameter is passed by reference and it is considered as being a variable global to the internal window or internal page.
Caution: Only the simple types are available.

Remarks

New Widget

The widget is declared in addition to the widgets defined in the description of Dashboard control.

This widget can be made visible:

by using DashInitialConfiguration before the first display.
by the end user via the popup menu.
by using the following syntax:

DASH_DashboardName[Subscript].Visible = True

where <Subscript> is the Widget number returned by DashAddWidget.

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