The HEAD function returns the head number that is assigned to the Window Container in which the Mimic or Trend is being displayed (see Assign a Head Number to a Window Container). The HEAD function is only of any practical use on a Multi-Monitor setup (it does not apply to Virtual ViewX, as those clients only support a single monitor setup).
The HEAD function is only available in client expressions. It cannot be used in server expressions.
| Function Name |
HEAD |
| Description |
Returns the head number that is assigned to the Window Container in which the Mimic or Trend is being displayed. The number can be: 0 - The Mimic or Trend is being displayed in Original WebX . 0 is returned even if there are multiple instances of the browser open. 1—10 - The Mimic or Trend is being displayed in the Window Container that has the returned value assigned to it as a head number. If a Mimic is shared and embedded, the primary window container (1) is always returned when the function is called, irrespective of where the Mimic is displayed. |
| Arguments |
HEAD() |
| Returns |
REAL The head number that is assigned to the Window Container in which the Mimic or Trend is being displayed, or 0 if the Mimic or Trend is displayed in Original WebX. For more information on integers and real values, see Number (Integer or Real). |
Example:
IIF (HEAD () <=1,1,0)
In this example, the HEAD function is used to animate the Visible animation property of a text box on a Mimic. If the Mimic is displayed in the Window Container with a head value of 1, or the Original WebX client, the text box will be displayed. If the Mimic is displayed in any other Window Container, the text box will not be shown.