Difference between revisions of "Extensions.HMI.ScreenIsOpen"
Jump to navigation
Jump to search
m (Hb moved page ScreenIsOpen to Extensions.HMI.ScreenIsOpen: #3153) |
|||
| Line 1: | Line 1: | ||
| − | [[Category:HMI]] | + | {{DISPLAYTITLE: '''ScreenIsOpen'''}}[[Category:HMI]] |
== Classification == | == Classification == | ||
| − | {{ClassificationActivity | ScreenIsOpen | Verifies whether a screen is open and active | [[Term]] | [[HMI|OTX HMI extension]] | [[HMI related terms]] | - | - }} | + | {{ClassificationActivity | ScreenIsOpen | Verifies whether a screen is open and active | [[Term]] | [[Extensions.HMI|OTX HMI extension]] | [[HMI related terms]] | - | - }} |
== OTL Syntax == | == OTL Syntax == | ||
| Line 11: | Line 11: | ||
This term is used to ensure that a ''screen'' is open and active. | This term is used to ensure that a ''screen'' is open and active. | ||
| − | {{TermReturnValue| [[Boolean]] | This value is TRUE if the screen is open and active.}} | + | {{TermReturnValue| [[Core.DataTypes.SimpleDataType.Boolean|Boolean]] | This value is TRUE if the screen is open and active.}} |
== Properties == | == Properties == | ||
{| {{TableHeader}} | {| {{TableHeader}} | ||
{{TableRowPropertiesHeader}} | {{TableRowPropertiesHeader}} | ||
| − | {{TableRowPropertie1| Screen | [[Screen]] | [[Variable]] | - | [1] |The variable being evaluated, which is a handle on the Screen}} | + | {{TableRowPropertie1| Screen | [[Extensions.HMI.Screen|Screen]] | [[Variable]] | - | [1] |The variable being evaluated, which is a handle on the Screen}} |
|} | |} | ||
| Line 34: | Line 34: | ||
== See also == | == See also == | ||
| − | [[ScreenClosedEventSource]] <br/> | + | [[Extensions.HMI.ScreenClosedEventSource|ScreenClosedEventSource]] <br/> |
| − | [[IsScreenClosedEvent]] | + | [[Extensions.HMI.IsScreenClosedEvent|IsScreenClosedEvent]] |
Revision as of 09:06, 15 February 2016
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 |
OTL 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);
}