Button Widget

The Button widget allows the user to execute an action upon clicking on it. The type of action executed is determined by the widget settings:

../_images/Button-View1.png

In the sequel we discuss and illustrate the type of actions which may be specified through the Settings wheel as shown in the picture above.

Note

Please note that calling the pre-defined function ExitAimms from within WebUI (for example, as part of an action behind a button) is currently not supported and will result in an error (for more info on this function, please see AIMMS Function Reference). In fact, calling ExitAimms only works for the main AIMMS thread itself and not for any of the other AIMMS contexts (of which WebUI is just one example). Exiting only from the underlying AIMMS session itself is not deemed as a proper behavior for an application with Web-based User Interface. See also: “Constructs to Avoid” section in the AIMMS PRO documentation.

Action

For example, in the TransNet application, when the action type is set to Procedure, then one may select one of the procedures in the model, e.g.. SolveProcedure, as the action to be executed:

../_images/Button-ActionProcedure.png

When the action type is set to PageLink, then one may select one of the other page is the app’s WebUI to link and open upon click (ResultsStatistics is here a potential other page):

../_images/Button-ActionPageLink.png

Finally, if the action type chosen is ExternalLink, then one may select an URL for a web page to open:

../_images/Button-ActionExternalLink.png

Miscellaneous

In the Miscellaneous tab of the button’s options editor, other options may be set that are explained below:

../_images/Button-Misc.png

Visibility

You can control the visibility of the button by either specifying a literal value 1 (visible) or 0 (hidden) or a binary parameter.

Title

Set the button title/text here. You can specify either a literal value like “OK” or “Accept” or a string parameter.

../_images/Button_Title.png

Custom Tooltip

You can specify a custom tooltip to display more information when the user hovers over a respective button. You can specify either a literal value like “Click here to confirm the action” or a string parameter.

The content for the string parameter can be data driven and also supports HTML.

As illustrated below, the definition of string parameter sp_TT_Button used to specify the Custom Tooltip option.

formatstring("Click to submit the details for <br><br>City: <strong>Amsterdam</strong>");
../_images/Button_CustomTooltip.png