Difference between revisions of "Extensions.HMI.ScreenIsOpen"
Jump to navigation
Jump to search
(Created page with "Category:HMI == Classification == {{ClassificationActivity | ScreenIsOpen | Verifies whether a screen is open and active | Term | OTX HMI extension | HMI rel...") |
|||
| Line 5: | Line 5: | ||
== Pseudo-Code Syntax == | == Pseudo-Code Syntax == | ||
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | <syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | ||
| − | + | BooleanTerm = Hmi.ScreenIsOpen(ScreenVariable); | |
</syntaxhighlight> | </syntaxhighlight> | ||
| Line 19: | Line 19: | ||
|} | |} | ||
| − | == Examples == | + | == OTL Examples == |
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | <syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | ||
| − | Boolean | + | package Hmi.ScreenSignature ScreenSignature1(ref Integer ScreenInOutParameter1); |
| + | |||
| + | public procedure main() | ||
| + | { | ||
| + | Hmi.Screen ScreenHandle1; | ||
| + | Boolean Boolean1 = false; | ||
| + | |||
| + | Hmi.OpenScreen(ScreenSignature1, false, {ref ScreenInOutParameter1 = ScreenInOut1}, ScreenHandle1); | ||
| + | Boolean1 = Hmi.ScreenIsOpen(ScreenHandle1); | ||
| + | } | ||
</syntaxhighlight> | </syntaxhighlight> | ||
Revision as of 07:52, 10 February 2015
Contents
Classification
| Name | ScreenIsOpen |
| Short Description | Verifies whether a screen is open and active |
| Class | Term |
| Extension | OTX HMI extension |
| Group | HMI related terms |
| Exceptions | - |
| Checker Rules | - |
| Standard Compliant | Yes |
Pseudo-Code Syntax
BooleanTerm = Hmi.ScreenIsOpen(ScreenVariable);Description
This term is used to ensure that a screen is open and active.
Return Value
The Term returns the value, see table below.
In OTX, Terms are categorized according to its return data type!
| Data Type | Description |
| Boolean | This value is TRUE if the screen is open and active. |
Properties
| Name | Data Type | Class | Default | Cardinality | Description |
| Screen | Screen | Variable | - | [1] | The variable being evaluated, which is a handle on the Screen |
OTL Examples
package Hmi.ScreenSignature ScreenSignature1(ref Integer ScreenInOutParameter1);
public procedure main()
{
Hmi.Screen ScreenHandle1;
Boolean Boolean1 = false;
Hmi.OpenScreen(ScreenSignature1, false, {ref ScreenInOutParameter1 = ScreenInOut1}, ScreenHandle1);
Boolean1 = Hmi.ScreenIsOpen(ScreenHandle1);
}