<Dashboard>.Mode (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

Disabling options and bar of edit mode
Deleting the Edit mode for the end user (via the AAF)

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

<Dashboard>.Mode (Function)

In french: <Tableau de bord>.Mode

Not available

Opens or closes the "Edit" mode of Dashboard control.

Versions 20 and later

This function is now available in WEBDEV Server.

This function is now available for WEBDEV sites in Linux.

This function is now available in Browser code.

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 Browser code.

This function is now available in WEBDEV Server.

This function is now available for WEBDEV sites in Linux.

This function is now available in Browser code.

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

// Informs the user if the Dashboard control is already in edit mode
IF DASH_Dashboard.Mode() <> dashNoModif THEN
Error("The dashboard is in edit mode already")
RETURN
END

nOption is int

// Defines the edit option
IF CBOX_EditOptions[1] THEN nOption += dashMove
IF CBOX_EditOptions[2] THEN nOption += dashResize
IF CBOX_EditOptions[3] THEN nOption += dashDelete

// Checks that at least one option is checked
IF nOption = 0 THEN
Error("At least one edit option must be checked")
ReturnToCapture(CBOX_EditOptions)
END

// Modifies the edit mode
DASH_Dashboard.Mode(nOption)

// Disable the deletion of widgets
// but not their move or resizing:
DASH_NoName1.Mode(dashMove + dashResize)
// Caution, to avoid displaying the toolbar,
// you must use DissableAAF (or AAFDisable) with the constant aafDashEditTdbMode.

Syntax

Modifying the mode of Dashboard control Hide the details

<Dashboard control>.Mode(<Mode>)

<Dashboard control>: Control name

Name of Dashboard control to use.

<Mode>: Integer constant (or combination of constants)

Edit options available for the user:
dashMove Switch to edit mode: the user can move the widgets in the Dashboard control.
dashResize Switch to edit mode: the user can resize the widgets in the Dashboard control.
dashNoModif Close the edit mode: the user cannot modify the widgets in the Dashboard control.
This constant cannot be combined with the other constants.
dashDelete Switch to edit mode: the user can hide the widgets in the Dashboard control.

Finding out the current mode of Dashboard control Hide the details

<Result> = <Dashboard control>.Mode()

<Result>: Integer constant

Current edit mode of Dashboard control:
dashMove Edit mode: the user can move the widgets in the Dashboard control.
dashResize Edit mode: the user can resize the widgets in the Dashboard control.
dashNoModif Standard mode: the user cannot modify the widgets in the Dashboard control.
dashDelete Edit mode: the user can hide the widgets in the Dashboard control.

<Dashboard control>: Control name

Name of Dashboard control to use.

Remarks

Disabling options and bar of edit mode

<Dashboard>.Mode is used to disable some features of the Dashboard control. Deleting these features can have consequences on the bar of edit mode. Therefore, if the deletion of widgets is not allowed, the bin button is not displayed in the toolbar.

Remark: To entirely disable the toolbar display on the Dashboard control, use AAFDisable associated with the aafDashEditMode constant.

Deleting the Edit mode for the end user (via the AAF)

<Dashboard>.Mode is used to switch to edit mode by programming.

To remove the possibility for the user to switch to edit mode (via the popup menu or the long click), use the function AAFDisable with the constant aafDashEditMode.

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.

Training (WEBDEV): WW_Dashboard

Component: wd260obj.dll