Difference between revisions of "Extensions.HMI.CloseScreen"
Jump to navigation
Jump to search
| (5 intermediate revisions by one other user not shown) | |||
| Line 1: | Line 1: | ||
| − | [[Category:HMI]] | + | {{DISPLAYTITLE: '''CloseScreen'''}}[[Category:HMI]] |
== Classification == | == Classification == | ||
| − | {{ClassificationActivity | CloseScreen | Dismisses screen and release all associated resources | [[Action]]| [[HMI|OTX HMI extension]] | [[Custom screen related actions]] | - | - }} | + | {{ClassificationActivity | CloseScreen | Dismisses screen and release all associated resources | [[Action]]| [[Extensions.HMI|OTX HMI extension]] | [[Extensions.HMI#Actions|Custom screen related actions]] | - | - }} |
== 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 screen); | |
</syntaxhighlight> | </syntaxhighlight> | ||
== Description == | == Description == | ||
| − | The '''CloseScreen''' activity | + | The '''CloseScreen''' activity will 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 will not send any more events for processing to the OTX sequence and will not allow any more user interaction to be performed. | ||
| + | |||
| + | Closing an uninitialized or already closed screen will perform no operation and report no errors. It will be for all effects a NOP. | ||
== Properties == | == Properties == | ||
{| {{TableHeader}} | {| {{TableHeader}} | ||
{{TableRowPropertiesHeader}} | {{TableRowPropertiesHeader}} | ||
| − | {{ | + | {{TableRowPropertie2| Screen | [[Extensions.HMI.Screen|Screen]] | [[Variable]] | - | [1] | This element represents the screen handle of the screen that will be closed.}} |
|} | |} | ||
== 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; | ||
| + | |||
| + | /// Flow | ||
| − | + | HMI.OpenScreen(ScreenHandle1, ScreenSignature1, {ScreenInOutParameter1 = Integer1}, false); | |
| − | + | HMI.CloseScreen(ScreenHandle1); | |
} | } | ||
</syntaxhighlight> | </syntaxhighlight> | ||
== See also == | == See also == | ||
| − | [[OpenScreen]] <br/> | + | [[Extensions.HMI.OpenScreen|OpenScreen]] <br/> |
| − | [[HighlightScreen]] | + | [[Extensions.HMI.HighlightScreen|HighlightScreen]] |
Latest revision as of 02:36, 13 September 2019
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 will 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 will not send any more events for processing to the OTX sequence and will not allow any more user interaction to be performed.
Closing an uninitialized or already closed screen will perform no operation and report no errors. It will 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 will 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);
}