Extensions.HMI.ChoiceDialog

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);

See also

ConfirmDialog
InputDialog
ShowDocumentDialog