The App.Head property is an application property. You can use the property to return the head number that is assigned to the Window Container in which the script is running (see Assign a Head Number to a Window Container in the Geo SCADA Expert Guide to Client Administration). This is only of any practical use on a Multi-Monitor setup.
The App.Head property is only for use in Mimic Scripts.
When the App.Head property is used in a Mimic script:
-
The property will return the head number that is assigned to the Window Container within which the Mimic is located.
-
If the script is used on an embedded Mimic that is shared across several Window Containers, the App.Head property will return the head number that is assigned to the Primary Window Container. (An embedded Mimic is shared when the Shared with Other Embedded Mimics property is selected in the Properties window of that embedded Mimic.)
| Syntax |
App.Head |
| Description |
Returns the head number that is assigned to the Window Container in which the script is running. |
| Arguments |
None |
| Returns |
Integer. This can be: 0 - For a Virtual ViewX Client. Virtual ViewX 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 Virtual ViewX 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
Further Information
Embedded Mimics: see Embed a Mimic on a Mimic in the Geo SCADA Expert Guide to Mimics.
Shared with Other Embedded Mimics Property.