Difference between revisions of "Extensions.HMI.CloseScreen"
Jump to navigation
Jump to search
| Line 5: | Line 5: | ||
== OTL Syntax == | == OTL Syntax == | ||
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | <syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | ||
| − | HMI.CloseScreen(ScreenVariable); | + | HMI.CloseScreen(ScreenVariable screen); |
</syntaxhighlight> | </syntaxhighlight> | ||
Revision as of 05:55, 7 November 2018
Classification
| Name | CloseScreen |
| Short Description | Dismisses screen and release all associated resources |
| Class | Action |
| Extension | OTX HMI extension |
| Group | Custom screen related actions |
| Exceptions | - |
| Checker Rules | - |
| Standard Compliant | Yes |
OTL Syntax
HMI.CloseScreen(ScreenVariable screen);Description
The CloseScreen activity shall cause the runtime system to dismiss the screen and release all resources associated to the screen.
After the execution of the CloseScreen action, the screen shall not send any more events for processing to the OTX sequence and shall not allow any more user interaction to be performed.
Closing an uninitialized or already closed screen shall perform no operation and report no errors. It shall be for all effects a NOP.
Properties
| Name | Data Type | Class | Default | Cardinality | Description |
| Screen | Screen | Variable | - | [1] | This element represents the screen handle of the screen that shall be closed. |
OTL Examples
/// Signatures
package HMI.ScreenSignature ScreenSignature1(ref Integer ScreenInOutParameter1);
/// Global Declarations
public procedure main()
{
/// Local Declarations
HMI.Screen ScreenHandle1;
Integer Integer1;
/// Flow
HMI.OpenScreen(ScreenHandle1, ScreenSignature1, {ScreenInOutParameter1 = Integer1}, false);
HMI.CloseScreen(ScreenHandle1);
}