fireGPI
Sends a Trigger GPI message to panels. When buttons, labels, and displayed parameters that have a matching GPI Trigger receive the message, their task lists are executed.
Tip: This function can be used for inter-panel communication, by triggering globally.
Syntax
ogscript.fireGPI (Trigger), (State), (Global);
Parameters
Parameter |
Type |
Required |
Description |
Trigger |
String |
Yes |
GPI Trigger message. |
State |
String |
No |
Sends optional data string, which can be read by the script. |
Global |
Boolean |
Yes |
When true, applies to all open panels. When false, applies only the panel initiating the trigger. |
Returns
N/A
Example
In this example, the GPI trigger message 'StartClock' and the state data 'ResetClock' are sent to all open panels.
ogscript.fireGPI ('StartClock','ResetClock',true);