DashAddWidget (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

Help

WLanguage

WLanguage functions

Controls, pages and windows

Dashboard functions

Prefix syntax

DashAddWidget

Presentation

Example

New widget

Related examples

See also

DashAddWidget (Function)

In french: TDBAjouteWidget

Not available

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

Caution: Widgets added programmatically are not automatically displayed. You must use DashInitialConfiguration before the Dashboard control is displayed for the first time.

Example

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

nIndex is int

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

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

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

Index of the added element. This index can be used to handle the widget.

<Dashboard control>: Control name

Name of the Dashboard control to be used.

<Widget>: Name of internal window or internal page

Name of the internal window that must be added into the Dashboard control.
Name of the internal page that must be added into the Dashboard control.

<Caption>: Character string

Widget caption. This caption will be displayed in the context 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_Dashboard[Index].Visible = True

where <Index> 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: wd280obj.dll