ONLINE HELP
 WINDEVWEBDEV AND WINDEV MOBILE

  • Overview
  • Handling Dashboard controls programmatically
  • Adding a widget
  • Running a procedure defined for an internal window or page (used as widget)
  • Handling a widget programmatically
  • Dragging and dropping widgets onto a Dashboard control
  • Properties specific to Dashboard controls
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
Overview
To programmatically handle a Dashboard control, WINDEV, WEBDEV and WINDEV Mobile include dashboard-specific functions.
This help page explains how to programmatically handle Dashboard controls.
Linux Remark: Dashboard controls are available in Linux WEBDEV sites only. Dashboard controls are not available in WINDEV applications for Linux.
Handling Dashboard controls programmatically

Adding a widget

Widgets can be added to Dashboard controls using DashAddWidget. By default, a Widget is invisible. It can be displayed by using the Visible property. If the widget is not visible, the user can make it visible via the context menu of the edit mode.
Examples:
  • Adding a simple widget (without parameters):
    // Adds a simple widget
    nIndex = DashAddWidget(DASH_Dashboard, IW_Widget_StockAlert, ...
    "Stock alert")
  • Adding a widget with parameters:
    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)
     
    // Displays this widget upon request
    IF YesNo(Yes, "Do you want to display this widget?") = Yes THEN
    DASH_Dashboard[nIndex].Visible = True
    ELSE
    ToastDisplay("Widget added to the dashboard as ""hidden"". "+ ...
    "Switch to edit mode to add it", toastShort, vaMiddle, haCenter)
    END
Special case: adding a widget to the initial configuration
By default, the Dashboard control displays the widgets as they have been defined in the window or page editor.
To add widgets programmatically when the Dashboard control is loaded, use:
Caution: In this case, these functions must be used in the initialization event of the Dashboard control.
Examples:
  • Adding a simple widget (without parameters)
    // -- Initialize the DASH_Dashboard control
    // - stock alert
    // Adds the widget
    nIndex = DashAddWidget(MySelf, IW_Widget_StockAlert, "Stock alert")
    // Configures the widget (placed on the left)
    DashInitialConfiguration(MySelf, nIndex, 5, 1)
  • Adding a widget with parameters
    // -- Initialize the DASH_Dashboard control
     
    dDate is Date
    nIndex is int
    nX, nY are int
     
    // Adds information to the initial configuration:
    // - key numbers for the last 3 months
    nX = 1 ; nY = 3
    FOR i = 1 TO 3
    // Adds the widget
    nIndex = DashAddWidget(MySelf, IW_Widget_KeyNumber, ...
    StringBuild("Key numbers for %1", ...
    DateToString(dDate, "Mmm YYYY")), dDate)
    // Configures the widget (placed on the left)
    DashInitialConfiguration(MySelf, nIndex, nX, nY)
    // The next one will be lower
    nY++
    dDate.Month--
    END
Remark: To refresh a widget with parameters, it is recommended to:
  • Add an optional event for refreshing the widget in the events of the internal window or page.
  • Enter the code used to refresh the widget. This code can be used for example to update the elements displayed in the internal window or page.
  • Refresh the widget with DashDisplay.

Running a procedure defined for an internal window or page (used as widget)

To run a procedure defined in the internal window or page used as Widget, use the following syntaxes:
  • Syntax that uses the name of the internal window or page:
    NameInternalWindow.ProcedureName(Param1, Param2, ...)

    For example:
    IW_Widget_KeyNumber.NewDate(EDT_Date)
  • Syntax that uses a Control variable (if the same internal window or page is used several times in the Dashboard control):
    VariableName is Control <- DashboardName[WidgetIndex]
    VariableName.ProcedureName(Param1, Param2, ...)

    For example:
    X is Control <-DASH_Dashboard[4]
    X.NewDate(EDT_Date)
Handling a widget programmatically
To programmatically handle a widget, use one of the following syntaxes:
  • Syntax 1: Direct use of the Dashboard control:
    DashboardName[WidgetIndex]

    For example:
    Trace(DASH_MyDashboard[1].Caption)
  • Syntax 2: Using a Control variable :
    VariableName is Control <- DashboardName[WidgetIndex]

    For example:
    X is Control <-DASH_Dashboard[4]
    Trace(X.Caption)
The properties that can be used on widgets are identical to those that can be used on internal windows or pages. For more details, see Properties associated with the internal windows and Properties associated with the internal pages.
Dragging and dropping widgets onto a Dashboard control
WINDEV WINDEV allows you to drag and drop Image, List Box and Looper controls (among others) onto a Dashboard control.
The different steps are as follows:
  1. Declare that the Dashboard control is the drop target.
    This declaration is made in the initialization code of the control via the DndTarget property.
    Example:
    // -- Initialize DASH_Dashboard
    // Allows drag-and-drop operations
    MySelf.DndTarget = dndAuto
  2. Declare that the Dashboard control is the drag source.
    In the initialization code of the source control, declare that the control is the drag source with the DndSource property.
    Example:
    // The image is the drag source
    MySelf.DndSource = dndProgram
  3. Define the procedure to start the drag operation (e.g. in the initialization code of the Source control).
    Example:
    // Defines the drag start procedure
    // This procedure uses DnDCacheDashElement
    // to define the widget to drop
    DnDEvent(onDndBegin, MySelf, dndBeginDrag)
  4. Type the code of the procedure.
    Example:
    PROCEDURE onDndBegin()
     
    // Define the widget to drop according to the source control
    SWITCH _DND.SourceControl
    // Indicates that the drop on the Dashboard control
    // must add the "Clock" widget
    // by using the "IW_Widget_Clock" internal window
    CASE IMG_Widget_Calendar.Name
    DnDCacheDashElement(IW_Widget_Calendar, "Clock")
     
    OTHER CASE
    Error("Only the IMG_Widget_Calendar image" + ...
    "is allowed for Drag and Drop")
    END
Properties specific to Dashboard controls
Use the following properties to programmatically handle Dashboard controls.
CompactOptionThe CompactOption property is used to:
  • find out whether the options found in a Check Box, Radio Button or Dashboard control are in compacted mode.
  • switch the options found in a Check Box, Radio Button or Dashboard control to compacted mode.
ElementWidthThe ElementWidth property is used to:
  • Find out or modify the width of the elements in an Organization Chart control.
  • Find out or modify the width of the cells in a Dashboard control.
ElementHeightThe ElementHeight property is used to:
  • Find out or modify the height of the elements in an Organization Chart control.
  • Find out or modify the height of the cells in a Dashboard control.
MarginHeightThe MarginHeight property is used to:
  • Find out the vertical margin between the widgets found in a Dashboard control.
  • Modify the vertical margin between the widgets found in a Dashboard control.
MarginWidthThe MarginWidth property is used to:
  • Find out the horizontal margin between the widgets found in a Dashboard control.
  • Modify the horizontal margin between the widgets found in a Dashboard control.
For a complete list of WLanguage properties that can be used with a Dashboard control, see Properties associated with the Dashboard control.
Minimum version required
  • Version 19
This page is also available for…
Comments
Click [Add] to post a comment