Extensions.HMI.InputDialog

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 message, StringTerm title, StringTerm initialValue, StringTerm instruction, StringTerm restriction, StringVariable result);

Description

The InputDialog activity opens a dialog requesting string input from the user. If needed, an initial value can be passed to the dialog which will be shown initially in the input field. Also an input restriction can be passed to the dialog; this will be used by runtime systems to pre-validate inputs before they are passed back to the test sequence. Finally the entered value is assigned to a string variable for later use in the test sequence.

InputDialog can only handle simple strings. There are no facilities provided for number parsing etc. It is assumed that the OTX sequence will perform these actions upon receiving the value.

Properties

Name	Data Type	Class	Default	Cardinality	Description
InitialValue	String	Term	-	[0..1]	The string value that will be used to initialize the dialog's input field.
Instruction	String	Term	-	[0..1]	An additional message that can be shown on the input dialog to provide information regarding the expected value that will be introduced.
Restriction	String	Term	-	[0..1]	A restriction onto the set of allowed input values. The restriction will be formulated by a regular expression which will be used by runtime systems to pre-validate the input data.
Result	String	Variable	-	[1]	After the user dismisses the input dialog, the entered value will be assigned to the string variable given by this element.

OTL Examples

/// Local Declarations

String String1;

/// Flow
		
HMI.InputDialog("Message", "Title", "Init", "Instruction", "Restriction", String1);

See also

ConfirmDialog
ChoiceDialog
ShowDocumentDialog