Adding a widget

• Adding a simple widget (without parameters):
  
  // Adds a simple widget
  nSubscript = DASH_Dashboard.AddWidget(IW_Widget_StockAlert, "Stock alert")
  
• Adding a widget with parameters:
  
  nSubscript is int
   
  // Adds a widget that expects parameters
  nSubscript = DASH_Dashboard.AddWidget(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[nSubscript]..Visible = True
  ELSE
  ToastDisplay("Widget added to the dashboard as ""hidden"". "+ ...
  "Switch to edit mode to add it", toastShort, vaMiddle, haCenter)
  END
  

• <Dashboard>.AddWidget to define the Widget to add.
• <Dashboard>.InitialConfiguration to configure the Widget position in the initial configuration.

• Adding a simple widget (without parameters)
  
  // -- Initialize the DASH_Dashboard control
  // - stock alert
  // Adds the widget
  nSubscript = DASH_Dashboard.AddWidget(IW_Widget_StockAlert, "Stock alert")
  // Configures the widget (placed on the left)
  DASH_Dashboard.InitialConfiguration(nSubscript, 5, 1)
  
• Adding a widget with parameters
  
  // -- Initialize the DASH_Dashboard control
   
  dDate is Date
  nSubscript is int
  nX, nY are int
   
  // Adds information into the initial configuration:
  // - key numbers for the last 3 months
  nX = 1 ; nY = 3
  FOR i = 1 TO 3
  // Adds the widget
  nSubscript = DASH_Dashboard.AddWidget(IW_Widget_KeyNumber, ...
  StringBuild("Key numbers for %1", ...
  dDate.ToString("Mmm YYYY")), dDate)
  // Configures the widget (placed on the left)
  DASH_Dashboard.InitialConfiguration(nSubscript, nX, nY)
  // The next one will be lower
  nY++
  dDate..Month--
  END
  

• 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 <Dashboard>.DashDisplay.

Running a procedure defined for an internal window or page (used in Widget)

• Syntax that is using the name of internal window or page:
  
  NameInternalWindow.ProcedureName(Param1, Param2, ...)
  
  For example:
  
  IW_Widget_KeyNumber.NewDate(EDT_Date)
  
• Syntax that is using a Control variable (if the same internal window or page is used several times in the Dashboard control):
  
  VariableName is control <- DashboardName[WidgetSubscript]
  VariableName.ProcedureName(Param1, Param2, ...)
  
  For example:
  
  X is Control <-DASH_Dashboard[4]
  X.NewDate(EDT_Date)
  

• Syntax 1: Direct use of the Dashboard control:
  
  DashboardName[WidgetSubscript]
  
  For example:
  
  Trace(DASH_MyDashboard[1]..Caption)
  
• Syntax 2: Using a Control variable :
  
  VariableName is control <- DashboardName[WidgetSubscript]
  
  For example:
  
  X is Control <-DASH_Dashboard[4]
  Trace(X..Caption)