CONTROL
- Introduction to CTRL
- CONTROL Classes
- Types of Control Functions
- Control graphics
- CONTROL Functions
  - Funtions A
  - Funtions B
  - Funtions C
  - Funtions D
  - Functions E
  - Functions F
  - Functions G
  - Functions H
  - Functions I
  - Functions J
  - Functions K
  - Functions L
  - Functions M
  - Functions N
  - Functions O
  - Functions P
  - Functions Q
  - Functions R
  - Functions S
  - Functions T
    - textEditor()
      Opens the text editor as a main window (not modally).
    - The Extension timedFuncConflicts()
      The timed function extension "timedFuncConflicts()" is designed to discover call conflicts between two or more timed functions. It compares the given parameters to analyze all conflicts and returns the result times.
    - trackZoomMode()
      Complies with the function "Rubber band zoom". After calling this function a cursor "cross" is displayed, which allows to create a window by left-clicking. The panel is scaled in accordance with the specified window size.
    - tanh()
      Calculates the hyperbolic tangent.
    - triggerAction()
      The function can be used to trigger an action from a GEDI or Script Editor extension script.
    - tan()
      Calculates the tangent.
    - tcpRead()
      Reads the data of a defined socket, which was opened with tcpOpen().
    - timedFuncEvents()
      The function timedFuncEvents() returns up to a given max_count all planned start_times (occurrences) when WinCC OA timedFunc would trigger a (start-)event. This function also handles the time periods (broadcast periods) (see Timed function extension) within the range defined by ’r;valid from’ and ’r;valid until’.
    - translate()
      Translates a term.
    - tcpShutdownOutput()
      Closes the write direction of a TCP socket.
    - timeFromGMT()
      Returns the difference between local time and GMT.
    - Timed function extension
      The timed function was extended and now provides several new functions:
    - throw()
      Signals an erroneous condition by using an error class variable.
    - tcpOpen()
      Opens the connection to a TCP/IP server socket.
    - triggerGlobalEvent()
      The function triggers a UI global event.
    - tcpWrite()
      Writes data to the defined socket.
    - timedFunc()
      Starts timed CTRL functions.
    - titleBar()
      Shows or hides the title bar in the specified module or in a child panel.
    - triggerEvent()
      The function triggers a specific event.
    - tcpClose()
      Closes a TCP/IP socket connection.
    - triggerEventWait()
      The function triggers a specific event and waits for the execution of the event.
    - throwError()
      Passes a WinCC OA error to the internal error handler.
    - tmpnam()
      Creates temporary file names.
  - Functions U
  - Functions V
  - Functions W
  - Functions X
  - Functions Y
  - Functions Z
- CTRL Debugger
  With the CTRL Debugger you can debug the programming language Control.
- CtrlExtension, basics

triggerGlobalEvent()

The function triggers a UI global event.

Synopsis

int triggerGlobalEvent(string event, ...);

Parameters


Parameter	Description
event	Name of the event that is triggered.
...	Arguments that are expected by the event.

Return value

-1 in case of an error and 0 in case of success.

Errors

Missing or incorrect arguments.

Description

The function triggerGlobalEvent() allows to trigger a specific UI global event inside of your code. This event can afterwards be used to connect to it using the function uiConnect().

To see all currently connected events the UI manager parameter "-report UI" can be used.

If a global event is no longer connected by anyone, it is internally removed and will no longer be displayed within the report output. If a script triggers an event to which no-one is connected, the event is simply ignored.

Example

In the example below the PushButton1 is used to connect or disconnect to the event "myGlobalEvent". Please note that the button property "Togglebutton" must be set to "TRUE" inside of the GEDI for the Pushbutton1.

Using the PushButton2 the event "myGlobalEvent" is triggered and the parameters "arg1 and arg2 are forwarded to the callback function "myCallback".

PushButton1 - Clicked Event

main(mapping event)
{
  string eventName = "myGlobalEvent";
  if(this.toggleState)
  {
    uiConnect("myCallback", eventName);
    DebugN("Connect - " + eventName);
  }
  else
  {
    uiDisconnect("myCallback", eventName);
    DebugN("Disconnect - " + eventName);
  }
}
myCallback(anytype arg1, anytype arg2)
{
  DebugN("Callback triggered!");
  DebugN("First Argument: " + arg1);
  DebugN("Second Argument: " + arg2);
}

PushButton2 - Clicked Event

main(mapping event)
{
  triggerGlobalEvent("myGlobalEvent", "myArg1", "myArg2");
}

Assignment

OOP

Availability

CTRL

Return value

triggerEvent(), triggerEventWait(), uiConnect()