OTX Reference  
OpenTestSystem.Otx.Extensions.HMI.Actions.OpenScreen Class Reference

Open Screen More...

Inheritance diagram for OpenTestSystem.Otx.Extensions.HMI.Actions.OpenScreen:
Inheritance graph

Classes

class  ScreenArguments
 Contains a list of arguments for an open screen call More...
 

Public Attributes

ScreenArguments arguments
 Cardinality [0..1]
Maps the parameters to variables or expressions. More...
 
System.Boolean modal
 Cardinality [0..1]
A window (screen) can be modal or modeless opened. "Modal" means that the execution of the sequence will only continue after the closing of the window. "Modeless" means that the process will continue after the opening of the window. The window can be closed via the close-screen activity. More...
 
OtxLink screen
 Cardinality [1]
Reference to a screen signature, which contains the description of the parameters used in the screen. More...
 
ScreenVariable screenHandle
 Cardinality [0..1]
Variable in which a reference of the form (screen) is stored for later use (eg. CloseScreen, ScreenIsOpen). More...
 
- Public Attributes inherited from OpenTestSystem.Otx.Core.Actions.ActionRealisation
OtxLink validFor
 Cardinality [0..1]
Validity of ActionRealisation. More...
 

Detailed Description

Open Screen

The OpenScreen activity creates and display a non modal screen into the runtime system. The Screen is displayed immediately and it will accept user input.

Exceptions
Exceptions.ScreenException
Checker rules
Core.CheckerRule.Core_Chk053 – no dangling OtxLink associations
CheckerRule.HMI_Chk002 - correct target for OpenScreen
CheckerRule.HMI_Chk003 - correct OpenScreen arguments
CheckerRule.HMI_Chk004 - OpenScreen term, input and input/output argument omission
CheckerRule.HMI_Chk005 - no Path in connected OpenScreen arguments

Syntax
Hmi.OpenScreen(OtxLink screen, ScreenVariable screenHandle = NULL, {ScreenArguments[ ] arguments} = NULL, Boolean modal = false);
ScreenVariable screenHandle
Cardinality [0..1] Variable in which a reference of the form (screen) is stored for later use (eg....
Definition: HMI.cs:1007
ScreenArguments arguments
Cardinality [0..1] Maps the parameters to variables or expressions.
Definition: HMI.cs:1017
System.Boolean modal
Cardinality [0..1] A window (screen) can be modal or modeless opened. "Modal" means that the executio...
Definition: HMI.cs:1037
OtxLink screen
Cardinality [1] Reference to a screen signature, which contains the description of the parameters use...
Definition: HMI.cs:1027
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);
}

Member Data Documentation

◆ arguments

ScreenArguments OpenTestSystem.Otx.Extensions.HMI.Actions.OpenScreen.arguments

Cardinality [0..1]
Maps the parameters to variables or expressions.

◆ modal

System.Boolean OpenTestSystem.Otx.Extensions.HMI.Actions.OpenScreen.modal

Cardinality [0..1]
A window (screen) can be modal or modeless opened. "Modal" means that the execution of the sequence will only continue after the closing of the window. "Modeless" means that the process will continue after the opening of the window. The window can be closed via the close-screen activity.

◆ screen

OtxLink OpenTestSystem.Otx.Extensions.HMI.Actions.OpenScreen.screen

Cardinality [1]
Reference to a screen signature, which contains the description of the parameters used in the screen.

◆ screenHandle

ScreenVariable OpenTestSystem.Otx.Extensions.HMI.Actions.OpenScreen.screenHandle

Cardinality [0..1]
Variable in which a reference of the form (screen) is stored for later use (eg. CloseScreen, ScreenIsOpen).