Extensions.HMI.InputDialog

From emotive
Revision as of 08:32, 15 February 2016 by Hb (talk | contribs) (Hb moved page InputDialog to Extensions.HMI.InputDialog: #3153)
Jump to navigation Jump to search

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.

Icons Note.png 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");

See also

ConfirmDialog
ChoiceDialog
ShowDocumentDialog