The Head property is an application property that is used to return the head number assigned to the Window Container in which a script is running (see Assign a Head Number to a Window Container in the ClearSCADA Guide to Client Administration). This is only of any practical use on a Multi-Monitor setup.
If the Head property is used in a Mimic script, the returned value will represent the Window Container that includes the document in which the script is running. If the Head property is used in an Alarm Banner script, the number will represent the Window Container that includes the Alarm Banner.
| Syntax |
App.Head |
| Description |
Returns the head number assigned to the Window Container in which the script is running. |
| Arguments |
None. |
| Returns |
Integer. This can be: 0 - For a WebX client. WebX clients return 0, even if there are multiple browser windows open. 1—10 - The script is running in the Window Container that has the returned value assigned to it as a head number. |
Example:
In this example, the script will cause a WebX client to navigate back to the previous page. However, the same script will cause a ViewX client to close the Mimic instead.
IF App.Head =0 THEN
Mimic.GoBack()
ELSE
Mimic.Close
END IF