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

New widget

WINDEV

WEBDEV

WINDEV Mobile

Others

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 by programming are not displayed automatically. You must use DashInitialConfiguration before the Dashboard control is displayed for the first time.

Example

IndWgt is int 
// Ajoute un Widget qui attend des paramètres
IndWgt = DashAddWidget(TDB_FuseauxHoraires, PI_Heure, "Heure" + GetIdentifier(), "Paris", +0)
DashInitialConfiguration(TDB_FuseauxHoraires, IndWgt)
// Ajoute un Widget qui attend des paramètres
IndWgt = DashAddWidget(TDB_FuseauxHoraires, PI_Heure, "Heure" + GetIdentifier(), "Honolulu", -12)
DashInitialConfiguration(TDB_FuseauxHoraires, IndWgt)
// Ajoute un Widget qui attend des paramètres
IndWgt = DashAddWidget(TDB_FuseauxHoraires, PI_Heure, "Heure" + GetIdentifier(), "Sydney", +9) 
DashInitialConfiguration(TDB_FuseauxHoraires, IndWgt)

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 the internal window or page

Name of the internal page to be added to the Dashboard control.

<Caption>: Character string

Widget text. 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.
Please note: Only 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.
Please note: Only simple types are available.

Remarks

New widget

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

This widget can be made visible:

by using DashInitialConfiguration before the first display.
by the end user via the context 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: wd300obj.dll