Events associated with a Dashboard control

WINDEV, WEBDEV AND WINDEV MOBILE
ONLINE HELP

Version:

Home | Sign in | English

Help

Editors

Controls (window/page/report)

Controls

Dashboard control

Events associated with a Dashboard control

Events managed by default

Events with procedures

Optional events

Widget optional events

See also

Events associated with a Dashboard control

Events managed by default

Versions 22 and later

This feature is now available for Android applications.

This feature is now available for iPhone/iPad applications.

New in version 22

This feature is now available for Android applications.

This feature is now available for iPhone/iPad applications.

This feature is now available for Android applications.

This feature is now available for iPhone/iPad applications.

WINDEV and WINDEV Mobile manage the following events by default (order of appearance in the code editor):

Event	Runtime condition

Initializing	Run when opening the window. * Widgets added by programming must be added in this event (DashAddWidget then DashInitialConfiguration).
Adding a widget	Run once a Widget was added via the popup menu of Dashboard control in edit mode.
Deleting a Widget	Run when hiding a Widget via the popup menu of Dashboard control in edit mode. If this event does not return a value or returns True, the Widget will be hidden. If this event returns False, the Widget will not be hidden.
Moving a Widget	Run once a Widget was moved in the Dashboard control in edit mode.
Resizing a Widget	Run once a Widget was resized in the Dashboard control in edit mode.

(*) By default, the event "Initializing" of each control is run according to the order in which the controls were created in the window. To modify this runtime order:

On the "Window" pane, in the "Order" group, click "Initialization".
In the window displayed, use the arrows on the right to modify the order in which the controls are initialized.

Versions 20 and later

WINDEV manages the following events by default (in order of appearance in the code editor):

Event	Runtime condition

Initializing	Run when opening the page. Widgets added by programming must be added in this event (DashAddWidget then DashInitialConfiguration).
Adding a Widget (Browser)	Run once a Widget was added via the popup menu of Dashboard control in edit mode.
Adding a Widget (Server)	Run once a Widget was added via the popup menu of Dashboard control in edit mode.
Deleting a Widget (Browser)	Run when hiding a Widget via the popup menu of Dashboard control in edit mode. If this event does not return a value or returns True, the event "Deleting a Widget (Server)" is run. If this event returns False, the Widget will not be hidden.
Deleting a Widget (Server)	Run when hiding a Widget via the popup menu of the Dashboard control in edit mode, after the event "Deleting a Widget (Browser)". If this event does not return a value or returns True, the Widget will be hidden. If this event returns False, the Widget will not be hidden.
Moving a Widget (Browser)	Run once a Widget was moved in the Dashboard control in edit mode.
Moving a Widget (Server)	Run once a Widget was moved in the Dashboard control in edit mode.
Changing the size of a Widget (Browser)	Run once a Widget was resized in the Dashboard control in edit mode.
Changing the size of a Widget (Server)	Run once a Widget was resized in the Dashboard control in edit mode.

New in version 20

WINDEV manages the following events by default (in order of appearance in the code editor):

Event	Runtime condition

Initializing	Run when opening the page. Widgets added by programming must be added in this event (DashAddWidget then DashInitialConfiguration).
Adding a Widget (Browser)	Run once a Widget was added via the popup menu of Dashboard control in edit mode.
Adding a Widget (Server)	Run once a Widget was added via the popup menu of Dashboard control in edit mode.
Deleting a Widget (Browser)	Run when hiding a Widget via the popup menu of Dashboard control in edit mode. If this event does not return a value or returns True, the event "Deleting a Widget (Server)" is run. If this event returns False, the Widget will not be hidden.
Deleting a Widget (Server)	Run when hiding a Widget via the popup menu of the Dashboard control in edit mode, after the event "Deleting a Widget (Browser)". If this event does not return a value or returns True, the Widget will be hidden. If this event returns False, the Widget will not be hidden.
Moving a Widget (Browser)	Run once a Widget was moved in the Dashboard control in edit mode.
Moving a Widget (Server)	Run once a Widget was moved in the Dashboard control in edit mode.
Changing the size of a Widget (Browser)	Run once a Widget was resized in the Dashboard control in edit mode.
Changing the size of a Widget (Server)	Run once a Widget was resized in the Dashboard control in edit mode.

WINDEV manages the following events by default (in order of appearance in the code editor):

Event	Runtime condition

Initializing	Run when opening the page. Widgets added by programming must be added in this event (DashAddWidget then DashInitialConfiguration).
Adding a Widget (Browser)	Run once a Widget was added via the popup menu of Dashboard control in edit mode.
Adding a Widget (Server)	Run once a Widget was added via the popup menu of Dashboard control in edit mode.
Deleting a Widget (Browser)	Run when hiding a Widget via the popup menu of Dashboard control in edit mode. If this event does not return a value or returns True, the event "Deleting a Widget (Server)" is run. If this event returns False, the Widget will not be hidden.
Deleting a Widget (Server)	Run when hiding a Widget via the popup menu of the Dashboard control in edit mode, after the event "Deleting a Widget (Browser)". If this event does not return a value or returns True, the Widget will be hidden. If this event returns False, the Widget will not be hidden.
Moving a Widget (Browser)	Run once a Widget was moved in the Dashboard control in edit mode.
Moving a Widget (Server)	Run once a Widget was moved in the Dashboard control in edit mode.
Changing the size of a Widget (Browser)	Run once a Widget was resized in the Dashboard control in edit mode.
Changing the size of a Widget (Server)	Run once a Widget was resized in the Dashboard control in edit mode.

Events with procedures

To simplify the operations performed on Widgets in a Dashboard control, several procedures are proposed in each event. These procedures take in parameter the Widget variable to use. This variable is a Control variable. The Widget can be handled by this variable.

Example: To find tout the Widgets deleted by the user:

PROCEDURE DeleteWidget(Widget is Control)
Trace("Deletion" + Widget..Caption)
Trace("Deletion" + Widget..SourceWindow)

Versions 20 and later

PROCEDURE DeleteWidget(Widget is Control)
Trace("Deletion" + Widget..Caption)
Trace("Deletion" + Widget..SourcePage)

New in version 20

PROCEDURE DeleteWidget(Widget is Control)
Trace("Deletion" + Widget..Caption)
Trace("Deletion" + Widget..SourcePage)

Versions 22 and later

PROCEDURE DeleteWidget(Widget)
Trace("Deletion" + Widget..Caption)
Trace("Deletion" + Widget..SourceWindow)

New in version 22

PROCEDURE DeleteWidget(Widget)
Trace("Deletion" + Widget..Caption)
Trace("Deletion" + Widget..SourceWindow)

Optional events

Several optional events can be managed.

To add an optional event:

Select the requested control.
Display the code window of this control (F2 key).
Click the link "Add other events to xxx" at the bottom of the window code, after the last event.
All the optional events available for the control are displayed.
Check the optional event to add and validate.
Remark: You can select several optional events.
The selected optional event is automatically added to the events managed by the control.

To disable an optional event, simply perform the same operations to display the list of optional events. Then simply uncheck the optional events to delete.
Remark: If the disabled code contains WLanguage code, this code is automatically deleted.

You can manage, for example:

the mouse hover over the control,
left mouse button down, up, with a double click,
right mouse button down, up, with double click,
the mouse wheel, etc.

See the Optional events for more details.

Widget optional events

Widgets are internal windows displayed in a Dashboard control.

In this case, a specific optional event can be associated with the internal window or page: "Refreshing the Widget".

This event is run when DashDisplay is run.