Difference between revisions of "Extensions.HMI.ScreenClosedEventSource"

From emotive
Jump to navigation Jump to search
Line 3: Line 3:
 
{{ClassificationActivity | ScreenClosedEventSource | Screen used as an event source when the window | [[Term]] | [[HMI|OTX HMI extension]] | [[HMI related terms]] | - | - }}
 
{{ClassificationActivity | ScreenClosedEventSource | Screen used as an event source when the window | [[Term]] | [[HMI|OTX HMI extension]] | [[HMI related terms]] | - | - }}
  
== Pseudo-Code Syntax ==
+
== OTL Syntax ==
 
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;">
 
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;">
EventSource ScreenClosedEventSource(Screen screen);
+
EventSourceTerm = Hmi.ScreenClosedEventSource(ScreenHandle);
 
</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;">
EventSource result = ScreenClosedEventSource(screen);
+
package Hmi.ScreenSignature ScreenSignature1(ref Integer ScreenInOutParameter1);
 +
 
 +
public procedure main()
 +
{
 +
  Hmi.Screen ScreenHandle1;
 +
  Integer ScreenInOut1;
 +
  EventHandling.EventSource EventSource1;
 +
 
 +
  Hmi.OpenScreen(ScreenSignature1, false, {ref ScreenInOutParameter1 = ScreenInOut1}, ScreenHandle1);
 +
  Hmi.CloseScreen(ScreenHandle1);
 +
  EventSource1 = Hmi.ScreenClosedEventSource(ScreenHandle1);
 +
}
 
</syntaxhighlight>
 
</syntaxhighlight>
  

Revision as of 07:45, 10 February 2015

Classification

Name ScreenClosedEventSource
Short Description Screen used as an event source when the window
Class Term
Extension OTX HMI extension
Group HMI related terms
Exceptions -
Checker Rules -
Standard Compliant Yes

OTL Syntax

EventSourceTerm = Hmi.ScreenClosedEventSource(ScreenHandle);

Description

The ScreenClosedEventSource term takes a screen to object, from an event source is made. This term allows for OTX sequence a screen as an event source in connection with the OTX EventHandling library to use. A screen will trigger an event if the specified screen is closed.

Return Value

The Term returns the value, see table below.

Icons Note.png 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] The screen, which is connected the event source

OTL Examples

package Hmi.ScreenSignature ScreenSignature1(ref Integer ScreenInOutParameter1);

public procedure main()
{
   Hmi.Screen ScreenHandle1;
   Integer ScreenInOut1;
   EventHandling.EventSource EventSource1;

   Hmi.OpenScreen(ScreenSignature1, false, {ref ScreenInOutParameter1 = ScreenInOut1}, ScreenHandle1);
   Hmi.CloseScreen(ScreenHandle1);
   EventSource1 = Hmi.ScreenClosedEventSource(ScreenHandle1);
}

See also

IsScreenClosedEvent
ScreenIsOpen