Difference between revisions of "Extensions.HMI.OpenScreen"
Jump to navigation
Jump to search
| Line 1: | Line 1: | ||
{{DISPLAYTITLE: '''OpenScreen'''}}[[Category:HMI]] | {{DISPLAYTITLE: '''OpenScreen'''}}[[Category:HMI]] | ||
== Classification == | == Classification == | ||
| − | {{ClassificationActivity | OpenScreen | Creates and displays a custom screen | + | {{ClassificationActivity | OpenScreen | Creates and displays a custom screen at runtime | [[Action]]| [[Extensions.HMI|OTX HMI extension]] | [[Extensions.HMI#Actions|Custom screen related actions]] | [[Extensions.HMI.ScreenException|ScreenException]] | [[Core.Validation.CoreChk053|Core_Chk053]] <br/> [[Extensions.HMI.HMIChk002|HMI_Chk002]] <br/> [[Extensions.HMI.HMIChk003|HMI_Chk003]] <br/> [[Extensions.HMI.HMIChk004|HMI_Chk004]] <br/> [[Extensions.HMI.HMIChk005|HMI_Chk005]]}} |
== OTL Syntax == | == OTL Syntax == | ||
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | <syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | ||
| − | Hmi.OpenScreen( | + | Hmi.OpenScreen(ScreenVariable, OtxLink, ScreenArguments, boolean); |
</syntaxhighlight> | </syntaxhighlight> | ||
== Description == | == Description == | ||
| − | The '''OpenScreen''' creates activity and | + | The '''OpenScreen''' creates activity and displays a custom ''screen'' at runtime. The ''screen'' will be displayed immediately and can accept user input. If other ''screens'' are already open when the new ''screen'' is opened, the test application shall ensure that the new screen is not hidden by other screens. |
== Properties == | == Properties == | ||
{| {{TableHeader}} | {| {{TableHeader}} | ||
{{TableRowPropertiesHeader}} | {{TableRowPropertiesHeader}} | ||
| − | {{TableRowPropertie1| Screen | [[ | + | {{TableRowPropertie1| Screen | [[OtxLink]] | - | - | [1] | This attribute contains a name which points to a '''ScreenSignature''' which contains a parameter description for the screen that shall be opened.}} |
| − | {{TableRowPropertie2| ArgumentsList | [[ScreenArguments]] | - | - | [0.. | + | {{TableRowPropertie2| ArgumentsList | [[ScreenArguments]] | - | - | [0..1] | This simple container element represents a list of arguments for an open screen call.}} |
| − | {{TableRowPropertie1| Modal | [[Core.DataTypes.SimpleDataType.Boolean|Boolean]] | [[Value]] | false | | + | {{TableRowPropertie1| Modal | [[Core.DataTypes.SimpleDataType.Boolean|Boolean]] | [[Value]] | false | [0..1] | This option tells the runtime system to make this screen modal or non-modal.}} |
{{TableRowPropertie2| ScreenHandle | [[Extensions.HMI.Screen|Screen]] | [[Variable]] | - | [0..1] | This optional element represents the variable which shall be the handle for the opened screen.}} | {{TableRowPropertie2| ScreenHandle | [[Extensions.HMI.Screen|Screen]] | [[Variable]] | - | [0..1] | This optional element represents the variable which shall be the handle for the opened screen.}} | ||
|} | |} | ||
| Line 22: | Line 22: | ||
== OTL Examples == | == OTL Examples == | ||
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | <syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | ||
| − | package | + | 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); | |
} | } | ||
</syntaxhighlight> | </syntaxhighlight> | ||
Revision as of 07:40, 28 September 2018
Classification
| Name | OpenScreen |
| Short Description | Creates and displays a custom screen at runtime |
| Class | Action |
| Extension | OTX HMI extension |
| Group | Custom screen related actions |
| Exceptions | ScreenException |
| Checker Rules | Core_Chk053 HMI_Chk002 HMI_Chk003 HMI_Chk004 HMI_Chk005 |
| Standard Compliant | Yes |
OTL Syntax
Hmi.OpenScreen(ScreenVariable, OtxLink, ScreenArguments, boolean);Description
The OpenScreen creates activity and displays a custom screen at runtime. The screen will be displayed immediately and can accept user input. If other screens are already open when the new screen is opened, the test application shall ensure that the new screen is not hidden by other screens.
Properties
| Name | Data Type | Class | Default | Cardinality | Description |
| Screen | OtxLink | - | - | [1] | This attribute contains a name which points to a ScreenSignature which contains a parameter description for the screen that shall be opened. |
| ArgumentsList | ScreenArguments | - | - | [0..1] | This simple container element represents a list of arguments for an open screen call. |
| Modal | Boolean | Value | false | [0..1] | This option tells the runtime system to make this screen modal or non-modal. |
| ScreenHandle | Screen | Variable | - | [0..1] | This optional element represents the variable which shall be the handle for the opened screen. |
OTL Examples
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);
}