Difference between revisions of "Extensions.HMI.ChoiceDialog"
Jump to navigation
Jump to search
m (Hb moved page ChoiceDialog to Extensions.HMI.ChoiceDialog: #3153) |
|||
| Line 1: | Line 1: | ||
| − | [[Category:HMI]] | + | {{DISPLAYTITLE: '''ChoiceDialog'''}}[[Category:HMI]] |
== Classification == | == Classification == | ||
| − | {{ClassificationActivity | ChoiceDialog | Dialog that indicates to the user with a list of choices | [[Action]]| [[HMI|OTX HMI extension]] | [[Dialog related actions]] | [[OutOfBoundsException]] | [[HMIChk001|HMI_Chk001]] }} | + | {{ClassificationActivity | ChoiceDialog | Dialog that indicates to the user with a list of choices | [[Action]]| [[Extensions.HMI|OTX HMI extension]] | [[Dialog related actions]] | [[OutOfBoundsException]] | [[Extensions.HMI.HMIChk001|HMI_Chk001]] }} |
== OTL Syntax == | == OTL Syntax == | ||
| Line 14: | Line 14: | ||
{| {{TableHeader}} | {| {{TableHeader}} | ||
{{TableRowPropertiesHeader}} | {{TableRowPropertiesHeader}} | ||
| − | {{TableRowPropertie1| Options | [[List]] | [[Term]] | - | [1] | This element specifies a list of strings which contains the possible options that shall be displayed.}} | + | {{TableRowPropertie1| Options | [[Core.DataTypes.ComplexDataType.ContainerDataType.List|List]] | [[Term]] | - | [1] | This element specifies a list of strings which contains the possible options that shall be displayed.}} |
| − | {{TableRowPropertie2| Default | [[Integer]] | [[Term]] | - | [0..1] | This optional element represents the index of the option which shall be preselected in the dialog.}} | + | {{TableRowPropertie2| Default | [[Core.DataTypes.SimpleDataType.Integer|Integer]] | [[Term]] | - | [0..1] | This optional element represents the index of the option which shall be preselected in the dialog.}} |
| − | {{TableRowPropertie1| Result | [[Integer]] | [[Variable]] | - | [1] | The integer variable where the chosen option's index.}} | + | {{TableRowPropertie1| Result | [[Core.DataTypes.SimpleDataType.Integer|Integer]] | [[Variable]] | - | [1] | The integer variable where the chosen option's index.}} |
|} | |} | ||
| Line 28: | Line 28: | ||
== See also == | == See also == | ||
| − | [[ConfirmDialog]] <br/> | + | [[Extensions.HMI.ConfirmDialog|ConfirmDialog]] <br/> |
| − | [[InputDialog]] <br/> | + | [[Extensions.HMI.InputDialog|InputDialog]] <br/> |
| − | [[ShowDocumentDialog]] | + | [[Extensions.HMI.ShowDocumentDialog|ShowDocumentDialog]] |
Revision as of 08:47, 15 February 2016
Classification
| Name | ChoiceDialog |
| Short Description | Dialog that indicates to the user with a list of choices |
| Class | Action |
| Extension | OTX HMI extension |
| Group | Dialog related actions |
| Exceptions | OutOfBoundsException |
| Checker Rules | HMI_Chk001 |
| Standard Compliant | Yes |
OTL Syntax
Hmi.ChoiceDialog(StringTerm, StringTerm, IntegerVariable, ListTerm);Description
The ChoiceDialog shows the user a list of choices. Once the user has confirmed the selection of the options (eg by clicking on the "OK" button), the dialog is closed and the index of the selected option will be assigned to a result variable.
Properties
| Name | Data Type | Class | Default | Cardinality | Description |
| Options | List | Term | - | [1] | This element specifies a list of strings which contains the possible options that shall be displayed. |
| Default | Integer | Term | - | [0..1] | This optional element represents the index of the option which shall be preselected in the dialog. |
| Result | Integer | Variable | - | [1] | The integer variable where the chosen option's index. |
OTL Examples
Integer Integer1;
List<String> Options1 = {"Option1", "Option2"};
Hmi.ChoiceDialog("Massage", "Title", Integer1, Options1);