Difference between revisions of "Extensions.HMI.OpenScreen"
Jump to navigation
Jump to search
m (Hb moved page OpenScreen to Extensions.HMI.OpenScreen: #3153) |
|||
| Line 1: | Line 1: | ||
| − | [[Category:HMI]] | + | {{DISPLAYTITLE: '''OpenScreen'''}}[[Category:HMI]] |
== Classification == | == Classification == | ||
| − | {{ClassificationActivity | OpenScreen | Creates and displays a custom screen during the term | [[Action]]| [[HMI|OTX HMI extension]] | [[Custom screen related actions]] | [[ScreenException]] | [[CoreChk053|Core_Chk053]] <br/> [[HMIChk002|HMI_Chk002]] <br/> [[HMIChk003|HMI_Chk003]] <br/> [[HMIChk004|HMI_Chk004]] <br/> [[HMIChk005|HMI_Chk005]]}} | + | {{ClassificationActivity | OpenScreen | Creates and displays a custom screen during the term | [[Action]]| [[Extensions.HMI|OTX HMI extension]] | [[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 == | ||
| Line 14: | Line 14: | ||
{| {{TableHeader}} | {| {{TableHeader}} | ||
{{TableRowPropertiesHeader}} | {{TableRowPropertiesHeader}} | ||
| − | {{TableRowPropertie1| Screen | [[Screen]] | - | - | [1] | This attribute contains a name which points to a '''ScreenSignature''' which contains a parameter description for the screen that shall be opened.}} | + | {{TableRowPropertie1| Screen | [[Extensions.HMI.Screen|Screen]] | - | - | [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..*] | This simple container element represents a list of arguments for an open screen call.}} | {{TableRowPropertie2| ArgumentsList | [[ScreenArguments]] | - | - | [0..*] | This simple container element represents a list of arguments for an open screen call.}} | ||
| − | {{TableRowPropertie1| Modal | [[Boolean]] | [[Value]] | false | - | This option tells the runtime system to make this screen modal or non-modal.}} | + | {{TableRowPropertie1| Modal | [[Core.DataTypes.SimpleDataType.Boolean|Boolean]] | [[Value]] | false | - | This option tells the runtime system to make this screen modal or non-modal.}} |
| − | {{TableRowPropertie2| ScreenHandle | [[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 33: | Line 33: | ||
== See also == | == See also == | ||
| − | [[HighlightScreen]] <br/> | + | [[Extensions.HMI.HighlightScreen|HighlightScreen]] <br/> |
| − | [[CloseScreen]] | + | [[Extensions.HMI.CloseScreen|CloseScreen]] |
Revision as of 08:55, 15 February 2016
Classification
| Name | OpenScreen |
| Short Description | Creates and displays a custom screen during the term |
| 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(Screen, ScreenArguments, ScreenHandle);Description
The OpenScreen creates activity and shows a custom screen during the term. The screen will be displayed immediately and can accept user input. When other screens are already open when the new screen opens, to ensure the application that the new screen from other screens hidden.
Properties
| Name | Data Type | Class | Default | Cardinality | Description |
| Screen | Screen | - | - | [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..*] | This simple container element represents a list of arguments for an open screen call. |
| Modal | Boolean | Value | false | - | 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);
public procedure main()
{
Hmi.Screen ScreenHandle1;
Integer ScreenInOut1;
Hmi.OpenScreen(ScreenSignature1, false, {ref ScreenInOutParameter1 = ScreenInOut1}, ScreenHandle1);
}