Difference between revisions of "Extensions.HMI.IsScreenClosedEvent"
Jump to navigation
Jump to search
m (Hb moved page IsScreenClosedEvent to Extensions.HMI.IsScreenClosedEvent: #3153) |
|||
| Line 1: | Line 1: | ||
| − | [[Category:HMI]] | + | {{DISPLAYTITLE: '''IsScreenClosedEvent'''}}[[Category:HMI]] |
== Classification == | == Classification == | ||
| − | {{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]] | [[Extensions.HMI|OTX HMI extension]] | [[HMI related terms]] | - | - }} |
== OTL Syntax == | == OTL Syntax == | ||
| Line 11: | Line 11: | ||
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. | 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. | ||
| − | {{TermReturnValue| [[Boolean]] | This value is TRUE if the event of a [[ScreenClosedEventSource]] term comes.}} | + | {{TermReturnValue| [[Core.DataTypes.SimpleDataType.Boolean|Boolean]] | This value is TRUE if the event of a [[Extensions.HMI.ScreenClosedEventSource|ScreenClosedEventSource]] term comes.}} |
== Properties == | == Properties == | ||
{| {{TableHeader}} | {| {{TableHeader}} | ||
{{TableRowPropertiesHeader}} | {{TableRowPropertiesHeader}} | ||
| − | {{TableRowPropertie1| Event | [[Event]] | [[Value]] | - | [1] | The event, whose type is checked}} | + | {{TableRowPropertie1| Event | [[Extensions.EventHandling.Event|Event]] | [[Value]] | - | [1] | The event, whose type is checked}} |
| − | {{TableRowPropertie2| Screen | [[Screen]] | [[Variable]] | - | [0..1] | Optional are the special screen that triggers the event}} | + | {{TableRowPropertie2| Screen | [[Extensions.HMI.Screen|Screen]] | [[Variable]] | - | [0..1] | Optional are the special screen that triggers the event}} |
|} | |} | ||
| Line 41: | Line 41: | ||
== See also == | == See also == | ||
| − | [[ScreenClosedEventSource]] <br/> | + | [[Extensions.HMI.ScreenClosedEventSource|ScreenClosedEventSource]] <br/> |
| − | [[ScreenIsOpen]] | + | [[Extensions.HMI.ScreenIsOpen|ScreenIsOpen]] |
Revision as of 09:04, 15 February 2016
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);
}