Difference between revisions of "Extensions.HMI.ScreenClosedEventSource"
Jump to navigation
Jump to search
m (Hb moved page ScreenClosedEventSource to Extensions.HMI.ScreenClosedEventSource: #3153) |
|||
| (5 intermediate revisions by one other user not shown) | |||
| Line 1: | Line 1: | ||
| − | [[Category:HMI]] | + | {{DISPLAYTITLE: ''' ScreenClosedEventSource'''}}[[Category:HMI]] |
== Classification == | == Classification == | ||
| − | {{ClassificationActivity | ScreenClosedEventSource | Screen | + | {{ClassificationActivity | ScreenClosedEventSource |Accepts a Screen object that is to be made an event source| [[Term]] | [[Extensions.HMI|OTX HMI extension]] | [[Extensions.HMI#Terms|HMI related terms]] | - | - }} |
== OTL Syntax == | == OTL Syntax == | ||
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | <syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | ||
| − | EventSourceTerm | + | EventSourceTerm HMI.ScreenClosedEventSource(ScreenTerm screen); |
</syntaxhighlight> | </syntaxhighlight> | ||
== Description == | == Description == | ||
| − | The '''ScreenClosedEventSource''' term | + | The '''ScreenClosedEventSource''' term accepts a ''Screen'' object that is to be made an event source. This term enables an OTX sequence to use a ''Screen'' as a source for events in the context of [[Extensions.EventHandling|the OTX EventHandling extension]]. A ''Screen'' will trigger an event every when the specified screen is closed. This can be used within a '''event:WaitForEventAction''' to continue execution after a screen was closed. |
| − | {{TermReturnValue| [[EventSource]] | Event source from a screen object.}} | + | |
| + | {{TermReturnValue| [[Extensions.EventHandling.EventSource|EventSource]] | Event source from a screen object.}} | ||
== Properties == | == Properties == | ||
{| {{TableHeader}} | {| {{TableHeader}} | ||
{{TableRowPropertiesHeader}} | {{TableRowPropertiesHeader}} | ||
| − | {{ | + | {{TableRowPropertie2| Screen | [[Extensions.HMI.Screen|Screen]] | [[Term]] | - | [1] | Represents the Screen that will be connected to the event source.}} |
|} | |} | ||
== OTL Examples == | == OTL Examples == | ||
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | <syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | ||
| − | package | + | /// Signatures |
| + | |||
| + | package HMI.ScreenSignature ScreenSignature1(ref Integer ScreenInOutParameter1); | ||
| + | |||
| + | /// Global Declarations | ||
public procedure main() | public procedure main() | ||
{ | { | ||
| − | + | /// Local Declarations | |
| − | + | ||
| − | + | HMI.Screen ScreenHandle1; | |
| + | Integer Integer1; | ||
| + | EventHandling.EventSource EventSource1; | ||
| + | |||
| + | /// Flow | ||
| − | + | HMI.OpenScreen(ScreenHandle1, ScreenSignature1, {ScreenInOutParameter1 = Integer1}, false); | |
| − | + | EventSource1 = HMI.ScreenClosedEventSource(ScreenHandle1); | |
| − | + | HMI.CloseScreen(ScreenHandle1); | |
} | } | ||
</syntaxhighlight> | </syntaxhighlight> | ||
== See also == | == See also == | ||
| − | [[IsScreenClosedEvent]] <br/> | + | [[Extensions.HMI.IsScreenClosedEvent|IsScreenClosedEvent]] <br/> |
| − | [[ScreenIsOpen]] | + | [[Extensions.HMI.ScreenIsOpen|ScreenIsOpen]] |
Latest revision as of 02:36, 13 September 2019
Contents
Classification
| Name | ScreenClosedEventSource |
| Short Description | Accepts a Screen object that is to be made an event source |
| Class | Term |
| Extension | OTX HMI extension |
| Group | HMI related terms |
| Exceptions | - |
| Checker Rules | - |
| Standard Compliant | Yes |
OTL Syntax
EventSourceTerm HMI.ScreenClosedEventSource(ScreenTerm screen);Description
The ScreenClosedEventSource term accepts a Screen object that is to be made an event source. This term enables an OTX sequence to use a Screen as a source for events in the context of the OTX EventHandling extension. A Screen will trigger an event every when the specified screen is closed. This can be used within a event:WaitForEventAction to continue execution after a 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 |
| EventSource | Event source from a screen object. |
Properties
| Name | Data Type | Class | Default | Cardinality | Description |
| Screen | Screen | Term | - | [1] | Represents the Screen that will be connected to the event source. |
OTL Examples
/// Signatures
package HMI.ScreenSignature ScreenSignature1(ref Integer ScreenInOutParameter1);
/// Global Declarations
public procedure main()
{
/// Local Declarations
HMI.Screen ScreenHandle1;
Integer Integer1;
EventHandling.EventSource EventSource1;
/// Flow
HMI.OpenScreen(ScreenHandle1, ScreenSignature1, {ScreenInOutParameter1 = Integer1}, false);
EventSource1 = HMI.ScreenClosedEventSource(ScreenHandle1);
HMI.CloseScreen(ScreenHandle1);
}