Difference between revisions of "Extensions.HMI.IsScreenClosedEvent"
Jump to navigation
Jump to search
| Line 3: | Line 3: | ||
{{ClassificationActivity | IsScreenClosedEvent | Checks whether the event of a '''ScreenClosedEventSource''' term comes | [[Term]] | [[HMI|OTX HMI extension]] | [[HMI related terms]] | - | - }} | {{ClassificationActivity | IsScreenClosedEvent | Checks whether the event of a '''ScreenClosedEventSource''' term comes | [[Term]] | [[HMI|OTX HMI extension]] | [[HMI related terms]] | - | - }} | ||
| − | == | + | == OTL Syntax == |
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | <syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | ||
| − | + | BooleanTerm = Hmi.IsScreenClosedEvent(EventTerm, ScreenHandle); | |
</syntaxhighlight> | </syntaxhighlight> | ||
| Line 20: | Line 20: | ||
|} | |} | ||
| − | == 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; | ||
| + | Integer ScreenInOut1; | ||
| + | EventHandling.EventSource EventSource1; | ||
| + | EventHandling.Event Event1; | ||
| + | Boolean Boolean1 = false; | ||
| + | |||
| + | Hmi.OpenScreen(ScreenSignature1, false, {ref ScreenInOutParameter1 = ScreenInOut1}, ScreenHandle1); | ||
| + | EventSource1 = Hmi.ScreenClosedEventSource(ScreenHandle1); | ||
| + | Hmi.CloseScreen(ScreenHandle1); | ||
| + | EventHandling.WaitForEvent({EventSource1}, Event1); | ||
| + | Boolean1 = Hmi.IsScreenClosedEvent(Event1, ScreenHandle1); | ||
| + | } | ||
</syntaxhighlight> | </syntaxhighlight> | ||
Revision as of 07:50, 10 February 2015
Contents
Classification
| Name | IsScreenClosedEvent |
| Short Description | Checks whether the event of a ScreenClosedEventSource term comes |
| Class | Term |
| Extension | OTX HMI extension |
| Group | HMI related terms |
| Exceptions | - |
| Checker Rules | - |
| Standard Compliant | Yes |
OTL Syntax
BooleanTerm = Hmi.IsScreenClosedEvent(EventTerm, ScreenHandle);Description
The term returns TRUE if exactly then the event of a ScreenClosedEventSource term comes. In the case of an optional screen variable is specified, the term will return TRUE if exactly then the event was triggered, because this particular screen was closed.
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 event of a ScreenClosedEventSource term comes. |
Properties
| Name | Data Type | Class | Default | Cardinality | Description |
| Event | Event | Value | - | [1] | The event, whose type is checked |
| Screen | Screen | Variable | - | [0..1] | Optional are the special screen that triggers the event |
OTL Examples
package Hmi.ScreenSignature ScreenSignature1(ref Integer ScreenInOutParameter1);
public procedure main()
{
Hmi.Screen ScreenHandle1;
Integer ScreenInOut1;
EventHandling.EventSource EventSource1;
EventHandling.Event Event1;
Boolean Boolean1 = false;
Hmi.OpenScreen(ScreenSignature1, false, {ref ScreenInOutParameter1 = ScreenInOut1}, ScreenHandle1);
EventSource1 = Hmi.ScreenClosedEventSource(ScreenHandle1);
Hmi.CloseScreen(ScreenHandle1);
EventHandling.WaitForEvent({EventSource1}, Event1);
Boolean1 = Hmi.IsScreenClosedEvent(Event1, ScreenHandle1);
}