OpenTestSystem.Otx.Extensions.HMI.Actions.InputDialog Class Reference

Dialog for user input More...

Inheritance diagram for OpenTestSystem.Otx.Extensions.HMI.Actions.InputDialog:

Public Attributes
StringTerm	initialValue
	Cardinality [0..1] Points to the value that will be used to initialize the input dialog. More...
StringTerm	instruction
	Cardinality [0..1] An additional message that can be shown on the input dialog to provide with information regarding the expected value that should be introduced. More...
StringTerm	restriction
	Cardinality [0..1] Optional property for setting the permitted input values. The restriction is described using a regular expression according to "PERL 5 Regular Expression Description Version 12", e.g. "^ (_ * [a-zA-Z] [a-zA-Z0-9 _] *) $". The input dialog can only be closed with "Ok" if the entered value matches the regular expression. More...
StringVariable	result
	Cardinality [1] After the user dismisses the input dialog, the value that the user typed will be stored in the variable defined with this parameter. More...
Public Attributes inherited from OpenTestSystem.Otx.Extensions.HMI.Actions.Dialog
StringTerm	message
	Cardinality [0..1] If the runtime system contains the capability to show a message as part of the display, the String will be shown. More...
StringTerm	title
	Cardinality [0..1] If the runtime system contains the capability to show a dialog box with a Title bar, the String will be shown. It is assumed that this String will be shown with more prominence than the message parameter. More...
Public Attributes inherited from OpenTestSystem.Otx.Core.Actions.ActionRealisation
OtxLink	validFor
	Cardinality [0..1] Validity of ActionRealisation. More...

Detailed Description

Dialog for user input

The InputDialog activity opens a question-message dialog requesting input from the user. The input value will be initialized to Initial Value.

Note

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.

Exceptions

Core.Exceptions.OutOfBoundsException

Syntax

HMI.InputDialog(StringTerm message = "", StringTerm title = "", StringTerm initialValue = "", StringTerm instruction = "", StringTerm restriction = "", StringVariable result);

Examples

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

Member Data Documentation

initialValue

StringTerm OpenTestSystem.Otx.Extensions.HMI.Actions.InputDialog.initialValue

Cardinality [0..1]
Points to the value that will be used to initialize the input dialog.

instruction

StringTerm OpenTestSystem.Otx.Extensions.HMI.Actions.InputDialog.instruction

Cardinality [0..1]
An additional message that can be shown on the input dialog to provide with information regarding the expected value that should be introduced.

restriction

StringTerm OpenTestSystem.Otx.Extensions.HMI.Actions.InputDialog.restriction

Cardinality [0..1]
Optional property for setting the permitted input values. The restriction is described using a regular expression according to "PERL 5 Regular Expression Description Version 12", e.g. "^ (_ * [a-zA-Z] [a-zA-Z0-9 _] *) $". The input dialog can only be closed with "Ok" if the entered value matches the regular expression.

result

StringVariable OpenTestSystem.Otx.Extensions.HMI.Actions.InputDialog.result

Cardinality [1]
After the user dismisses the input dialog, the value that the user typed will be stored in the variable defined with this parameter.