AAUI.sthelp_helpcb | () |
Description: | ||
This function will be called as part of the call back from the Help button. It will call AAI.step_help_doc, 130 in order to display a help document in the Browser. | ||
Input: Output: | ||
Error Conditions: | ||
None. |
AAUI.helpdoc_display | (doc_URL) |
Description: | ||
This function will display any specified HTML document available on the file system, or display any http: URL address. | ||
Input: | ||
STRING | doc_URL[] | This value specifies the path or URL address for the document to be displayed by the commercial browser that is used for auxiliary display. |
Output: | ||
Error Conditions: | ||
None. |
Important: | Because of parsing issues, the format for http references needs to be “http_//www....” instead of http://www....”. |
AAUI.helpdoc_display(“helpdocs/st2help.html”)
AAUI.helpdoc_display(“d:/testing/step_test/helpdocs/st2help.html”)
AAUI.helpdoc_display(“http_//www.macsch.com/helpdocs/st2help.html”)
AAUI.quickreview_quickcb | () |
Description: | ||
This function will post the Quick Review form to the screen. This is called as part of the callback from the “Quick Review” button. The Quick Review form displays user response variables from the State Table as indicated by the <uresponse> tags for each analysis step. | ||
Input: | ||
Output: | ||
Error Conditions: | ||
None. |
AAUI.quit_quitcb | () |
Description: | ||
This function will close down the MSC Acumen GUI. This is called as part of the callback for the “Quit” button. | ||
Input: | ||
Output: | ||
Error Conditions: | ||
None. |
AAUI.backup_backupcb | () |
Description: | ||
This function will cause the dialog to back up to the previous dialog. This call is made as part of the callback to the “Dialog Backup” button. | ||
Input: | ||
Output: | ||
INTEGER | This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error. | |
Error Conditions: | ||
None. |
AAUI.backup_status | (backup) |
Description: | ||
This function will indicate whether or not a backup action is in progress. | ||
Input: | ||
Output: | ||
LOGICAL | backup | This value returns TRUE if the dialog backup action is in progress, or a FALSE if a dialog backup action is not in progress. |
Error Conditions: | ||
None. |
AAUI.notify_backup_done | () |
Description: | ||
This function will reset the backup status to FALSE, so any subsequent call to AAUI.backup_status() will return FALSE. | ||
Input: | ||
Output: | ||
Error Conditions: | ||
None. |
AAUI.backup_enable | (on_off) |
Description: | ||
This function provides a mechanism for independent enabling and disabling of the UI form "Dialog Backup" button. Use this function to guard against <dialog> backup actions within a step where the workflow sequence is not designed to support a backup. | ||
Input: | ||
STRING | on_off[] | If this value is "ON" then the “Dialog Backup” button is enabled so that a user can select it. If this value is "OFF" (actually any value other than "ON") then the button is disabled so that no backup action selection is possible. |
Output: | ||
Error Conditions: | ||
None. |