Difference between revisions of "Extensions.HMI.ConfirmDialog"
Jump to navigation
Jump to search
m (Hb moved page ConfirmDialog to Extensions.HMI.ConfirmDialog: #3153) |
|||
| (6 intermediate revisions by one other user not shown) | |||
| Line 1: | Line 1: | ||
| − | [[Category:HMI]] | + | {{DISPLAYTITLE: '''ConfirmDialog'''}}[[Category:HMI]] |
== Classification == | == Classification == | ||
| − | {{ClassificationActivity | ConfirmDialog | Requests dialog, the user's confirmation | [[Action]]| [[HMI|OTX HMI extension]] | [[Dialog related actions]] | - | - }} | + | {{ClassificationActivity | ConfirmDialog | Requests dialog, the user's confirmation | [[Action]]| [[Extensions.HMI|OTX HMI extension]] | [[Extensions.HMI#Actions|Dialog related actions]] | - | - }} |
== OTL Syntax == | == OTL Syntax == | ||
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | <syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | ||
| − | + | HMI.ConfirmDialog(StringTerm message, StringTerm title, MessageTypeTerm messageType, ConfimationTypeVariable result); | |
</syntaxhighlight> | </syntaxhighlight> | ||
== Description == | == Description == | ||
| − | The '''ConfirmDialog''' activity shows a dialog, the user's confirmation requests. The selection of buttons and decorations can be configured by a parameter. ''' | + | 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 == | == Properties == | ||
{| {{TableHeader}} | {| {{TableHeader}} | ||
{{TableRowPropertiesHeader}} | {{TableRowPropertiesHeader}} | ||
| − | {{TableRowPropertie1| MessageType | [[MessageType]] | [[ | + | {{TableRowPropertie1| MessageType | [[Extensions.HMI.MessageType|MessageType]] | [[Term]] | @MessageType:INFO | [0..1] | This optional element defines the type of message and the buttons that will be shown to the user to confirm the action |
| − | {{TableRowPropertie2| Result | [[ | + | <nowiki>Message type = {INFO|WARNING|ERROR|YESNO_QUESTION|YESNOCANCEL_QUESTION}</nowiki>}} |
| + | {{TableRowPropertie2| Result | [[Extensions.HMI.ConfirmationType|ConfirmationType]] | [[Variable]] | - | [0..1] | The variable where the user's selection will be stored.}} | ||
|} | |} | ||
== OTL Examples == | == OTL Examples == | ||
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | <syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | ||
| − | + | /// Local Declarations | |
| + | |||
| + | HMI.ConfirmationType ConfirmationType1 = @ConfirmationType:YES; | ||
| + | |||
| + | /// Flow | ||
| − | + | HMI.ConfirmDialog("Message", "Title", @MessageType:INFO, ConfirmationType1); | |
</syntaxhighlight> | </syntaxhighlight> | ||
== See also == | == See also == | ||
| − | [[InputDialog]] <br/> | + | [[Extensions.HMI.InputDialog|InputDialog]] <br/> |
| − | [[ChoiceDialog]] <br/> | + | [[Extensions.HMI.ChoiceDialog|ChoiceDialog]] <br/> |
| − | [[ShowDocumentDialog]] | + | [[Extensions.HMI.ShowDocumentDialog|ShowDocumentDialog]] |
Latest revision as of 02:31, 13 September 2019
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 message, StringTerm title, MessageTypeTerm messageType, ConfimationTypeVariable result);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 will 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
/// Local Declarations
HMI.ConfirmationType ConfirmationType1 = @ConfirmationType:YES;
/// Flow
HMI.ConfirmDialog("Message", "Title", @MessageType:INFO, ConfirmationType1);