Difference between revisions of "Extensions.HMI.InputDialog"
Jump to navigation
Jump to search
m (Hb moved page InputDialog to Extensions.HMI.InputDialog: #3153) |
|||
| Line 1: | Line 1: | ||
| − | [[Category:HMI]] | + | {{DISPLAYTITLE: '''InputDialog'''}}[[Category:HMI]] |
== Classification == | == Classification == | ||
| − | {{ClassificationActivity | InputDialog | Dialog, the user's input requesting | [[Action]]| [[HMI|OTX HMI extension]] | [[Dialog related actions]] | [[OutOfBoundsException]] | - }} | + | {{ClassificationActivity | InputDialog | Dialog, the user's input requesting | [[Action]]| [[Extensions.HMI|OTX HMI extension]] | [[Dialog related actions]] | [[OutOfBoundsException]] | - }} |
== OTL Syntax == | == OTL Syntax == | ||
| Line 16: | Line 16: | ||
{| {{TableHeader}} | {| {{TableHeader}} | ||
{{TableRowPropertiesHeader}} | {{TableRowPropertiesHeader}} | ||
| − | {{TableRowPropertie1| InitialValue | [[String]] | [[Term]] | - | [0..1] | To initialize the string value using the input field.}} | + | {{TableRowPropertie1| InitialValue | [[Core.DataTypes.SimpleDataType.String|String]] | [[Term]] | - | [0..1] | To initialize the string value using the input field.}} |
| − | {{TableRowPropertie2| Instruction | [[String]] | [[Term]] | - | [0..1] | An additional message that can be displayed on the Input dialog to show information about the expected value.}} | + | {{TableRowPropertie2| Instruction | [[Core.DataTypes.SimpleDataType.String|String]] | [[Term]] | - | [0..1] | An additional message that can be displayed on the Input dialog to show information about the expected value.}} |
| − | {{TableRowPropertie1| Restriction | [[String]] | [[Term]] | - | [0..1] | A limitation on the amount of allowable input values. The restriction will be formulated by a regular expression, to be used by runtime systems, the input data to pre-validate.}} | + | {{TableRowPropertie1| Restriction | [[Core.DataTypes.SimpleDataType.String|String]] | [[Term]] | - | [0..1] | A limitation on the amount of allowable input values. The restriction will be formulated by a regular expression, to be used by runtime systems, the input data to pre-validate.}} |
| − | {{TableRowPropertie2| Result | [[String]] | [[Variable]] | - | [1] | The entered value is assigned to this string variable.}} | + | {{TableRowPropertie2| Result | [[Core.DataTypes.SimpleDataType.String|String]] | [[Variable]] | - | [1] | The entered value is assigned to this string variable.}} |
|} | |} | ||
| Line 30: | Line 30: | ||
== See also == | == See also == | ||
| − | [[ConfirmDialog]] <br/> | + | [[Extensions.HMI.ConfirmDialog|ConfirmDialog]] <br/> |
| − | [[ChoiceDialog]] <br/> | + | [[Extensions.HMI.ChoiceDialog|ChoiceDialog]] <br/> |
| − | [[ShowDocumentDialog]] | + | [[Extensions.HMI.ShowDocumentDialog|ShowDocumentDialog]] |
Revision as of 08:45, 15 February 2016
Classification
| Name | InputDialog |
| Short Description | Dialog, the user's input requesting |
| Class | Action |
| Extension | OTX HMI extension |
| Group | Dialog related actions |
| Exceptions | OutOfBoundsException |
| Checker Rules | - |
| Standard Compliant | Yes |
OTL Syntax
Hmi.InputDialog(StringTerm, StringTerm, StringTerm, StringTerm, StringVariable, StringTerm);Description
The InputDialog activity opens a dialog box that requests the user's input. If necessary, an initial value can be passed to the dialog that appears first in the input field. Also, an input constraint can be passed to the dialog.
InputDialog can handle only simple strings.
Properties
| Name | Data Type | Class | Default | Cardinality | Description |
| InitialValue | String | Term | - | [0..1] | To initialize the string value using the input field. |
| Instruction | String | Term | - | [0..1] | An additional message that can be displayed on the Input dialog to show information about the expected value. |
| Restriction | String | Term | - | [0..1] | A limitation on the amount of allowable input values. The restriction will be formulated by a regular expression, to be used by runtime systems, the input data to pre-validate. |
| Result | String | Variable | - | [1] | The entered value is assigned to this string variable. |
OTL Examples
String result;
Hmi.InputDialog("Message", "Title", "Init", "Instruction", result, "Restriction");