Extensions.HMI.ConfirmDialog

From emotive
Revision as of 03:59, 28 September 2018 by Hb (talk | contribs)
Jump to navigation Jump to search

Classification

Name ConfirmDialog
Short Description Requests dialog, the user's confirmation
Class Action
Extension OTX HMI extension
Group Dialog related actions
Exceptions -
Checker Rules -
Standard Compliant Yes

OTL Syntax

Hmi.ConfirmDialog(StringTerm, StringTerm, MessageTypeTerm, ConfimationTypeVariable);

Description

The ConfirmDialog activity shows a dialog, the user's confirmation requests. The selection of buttons and decorations can be configured by a parameter. Once one of the confirmation options is selected, the result field will contain the selected index of the options.

Confirmation dialogs are typically used to ask the user for acceptance before performing a procedure. Depending on the type of procedure to execute, it is possible to select different levels of severity.

Properties

Name Data Type Class Default Cardinality Description
MessageType MessageType Term @MessageType:INFO [0..1] This optional element defines the type of message and the buttons that shall be shown to the user to confirm the action Message type = {INFO|WARNING|ERROR|YESNO_QUESTION|YESNOCANCEL_QUESTION}.
Result ConfirmationType Variable - [0..1] The variable where the user's selection will be stored.

OTL Examples

HMI.ConfirmationType ConfirmationType1 = @ConfirmationType:YES;

/// Flow

HMI.ConfirmDialog("Message", "Title", @MessageType:INFO, ConfirmationType1);

See also

InputDialog
ChoiceDialog
ShowDocumentDialog