ONLINE HELP
 WINDEVWEBDEV AND WINDEV MOBILE

Help / Developing an application or website / Controls, windows and pages / Controls: Available types / Dashboard control
  • Overview
  • AAFs in the Windows applications
  • Overview
  • Features of the context menu
  • Edit mode in the Dashboard control
  • AAF in the WEBDEV sites
  • AAFs in the Mobile applications
  • Switching to Edit mode
  • Edit mode toolbar
  • Exit the Edit mode
  • Moving a widget
  • Resizing a widget
  • Adding a widget
WINDEV
WindowsLinuxUniversal Windows 10 AppJavaReports and QueriesUser code (UMC)
WEBDEV
WindowsLinuxPHPWEBDEV - Browser code
WINDEV Mobile
AndroidAndroid Widget iPhone/iPadIOS WidgetApple WatchMac CatalystUniversal Windows 10 App
Others
Stored procedures
Dashboard control: Automatic Application Features (AAF)
Overview
The Dashboard control proposes several Automatic Application Features (AAF) allowing the user to benefit from all control capabilities. These features are available for the Windows applications, the WEBDEV sites and the Mobile applications.
WINDEV
AAFs in the Windows applications

Overview

By default, the Dashboard control proposes to the user to:
  • Change to edit mode: the Edit mode allows users to configure their dashboard.
  • Save the content of Dashboard control in image format.
When users switch to "Edit" mode, they can configure the different elements in the dashboard:
You can:
  • hide an element,
  • add an invisible element,
  • restore the initial configuration.
The edit mode can also be used to modify the position and size of elements.

Features of the context menu

  • Save as (image): This feature is used to save the content of Dashboard control in image format (to print it for example).
  • Edit mode: This feature allows users to switch to Edit mode so they can configure their dashboard.

Edit mode in the Dashboard control

The following options are available in the context menu of the Edit mode:
  • Add: This option opens a submenu that displays the list of widgets made invisible and that can be added.
  • Hide: This option is used to hide the current widget.
  • Restore initial configuration: This option is used to restore the dashboard to its previous status (before the modifications performed in edit mode). All the modifications performed (size, position, hiding, addition) are canceled.
The Edit mode can be configured through programming:
  • DashMode is used to:
    • know whether the Edit mode is enabled,
    • enable or disable the Edit mode,
    • configure the available actions in Edit mode. You can for example allow the widgets to be moved and resized only.
  • Using AAFDisable with the aafDashEditMode constant disables the context menu used to switch to edit mode.
WEBDEV - Server code
AAF in the WEBDEV sites
By default, the Dashboard control proposes to the user a popup menu used to :
  • Change to edit mode: This feature allows users to switch to Edit mode so they can configure their dashboard.
  • Restore initial configuration: This option is used to restore the dashboard to its previous status (before the modifications performed in edit mode). All the modifications performed (size, position, hiding, addition) are canceled.
  • Display (or not) the different widgets: All you have to do is check or uncheck the name of the widget to display.
When users switch to "Edit" mode, they can change the size and position of the elements in the dashboard. The Edit mode can be configured through programming:
  • DashMode is used to:
    • know whether the Edit mode is enabled,
    • enable or disable the Edit mode,
    • configure the available actions in Edit mode. You can for example allow the Widgets to be moved and resized only.
AndroidiPhone/iPadMac Catalyst
AAFs in the Mobile applications

Switching to Edit mode

To enter in edit mode in a Dashboard control, a long press must be performed on the control background or on a widget. A micro vibration is triggered (haptic feedback).
If the long press is performed on a widget, the widget is selected: sizing handles are displayed on the four sides of the widget.
Caution: If the long press is performed on a control found inside a widget and if this control intercepts the long press (code in the long press process, displaying a popup menu, etc.), the Dashboard control will not switch to edit mode.
In Edit mode:
  • Selecting a widget is performed via a simple click on the widget.
  • The controls displayed in the widgets no longer receive the click events and they can not gain focus anymore.
  • If at least one widget is displayed on the last dashboard row, an additional row is added in edit mode (with activation of the vertical scrollbar if necessary). This row is used to add new widgets or to move existing widgets.
  • A specific toolbar is displayed. For more details, see Edit mode toolbar.
  • You can:
Remark: DashMode is used to:
  • switch to "Edit" mode through programming. To prevent the user from switching to edit mode (long click without effect), use AAFDisable with the aafDashEditMode constant.
  • disable some features in the Dashboard control (as well as in the bar of the Edit mode).

Edit mode toolbar

When the Dashboard control switches to edit mode, a toolbar is displayed in the lower section of control. This toolbar is displayed in semi-transparency above the dashboard widgets.
This toolbar includes three buttons:
  • "Reinitialize" button : used to restore the initial configuration of the dashboard
  • "OK" button : used to exit the Edit mode.
  • Bin button : is used to hide the selected widget via a click. You also have the ability to perform a Drag and Drop of a widget on the button in order to hide this widget (a micro vibration is performed when hovering the bin with the widget to hide).
Remark: The text color and the bar can be configured in the style of Dashboard control. The color of the icon for the bin button corresponds to the text color.
Remark: If DashMode prevents the deletion of widgets, the bin button is not displayed in the toolbar.

Exit the Edit mode

You can use multiple methods to exit the Edit mode in the Dashboard control :
  • Click the background of Dashboard control.
  • Click the OK button displayed in the toolbar of the Edit mode.
  • Android Press the "back" key of the phone.

Moving a widget

To move a widget:
  • If the widget is not selected: perform a long press on the widget. A ghost view of the widget to move is automatically created.
  • If the widget is selected: all you have to do is press the pointer on the selected widget. A ghost view of the widget to move is automatically created.
During the move, the sizing handles of selected widget are not drawn.
When the widget is moved onto a cell containing another widget, the second widget is moved onto the first free location and it goes back to its initial location as soon as the moved widget does not hover it anymore. The move of hovered widgets is performed with an animation.

Resizing a widget

To resize a widget, you must:
  • keep the pointer down on one of the widget borders (the one that displays the sizing handles).
  • and move the pointer in the requested direction.
A widget cannot be resized horizontally and vertically at the same time.
During the resize operation, only the handle found on the border on which the pointer was pressed down is displayed.
The widgets that occupy the cells on which the widget is enlarged are automatically moved with an animation onto the first free location. They go back to their initial location if the widget is reduced.

Adding a widget

In Edit mode, a "+" sign is displayed in the middle of empty cells (with the same color as the border of the widgets in Edit mode).
A click on an empty cell opens a context menu with the list of widgets to add.
If all the dashboard widgets are displayed, the "+" sign is not displayed and a click on an empty cell allows you to exit Edit mode.
Remark: When moving and resizing a widget, the "+" sign is not drawn in the empty cells.
Minimum version required
  • Version 19
This page is also available for…
Comments
Click [Add] to post a comment

Last update: 06/08/2022

Send a report | Local help