Difference between revisions of "Extensions.HMI.ShowDocumentDialog"
Jump to navigation
Jump to search
m (Hb moved page ShowDocumentDialog to Extensions.HMI.ShowDocumentDialog: #3153) |
|||
| Line 1: | Line 1: | ||
| − | [[Category:HMI]] | + | {{DISPLAYTITLE: '''ShowDocumentDialog'''}}[[Category:HMI]] |
== Classification == | == Classification == | ||
| − | {{ClassificationActivity | ShowDocumentDialog | Dialog that indicates to the user with a list of choices | [[Action]]| [[HMI|OTX HMI extension]] | [[Dialog related actions]] | [[InvalidReferenceException]] | - }} | + | {{ClassificationActivity | ShowDocumentDialog | Dialog that indicates to the user with a list of choices | [[Action]]| [[Extensions.HMI|OTX HMI extension]] | [[Dialog related actions]] | [[InvalidReferenceException]] | - }} |
== OTL Syntax == | == OTL Syntax == | ||
| Line 13: | Line 13: | ||
{| {{TableHeader}} | {| {{TableHeader}} | ||
{{TableRowPropertiesHeader}} | {{TableRowPropertiesHeader}} | ||
| − | {{TableRowPropertie1| Document | [[String]] | [[Term]] | - | [1] | This element identifies the externaldocument that should be shown.}} | + | {{TableRowPropertie1| Document | [[Core.DataTypes.SimpleDataType.String|String]] | [[Term]] | - | [1] | This element identifies the externaldocument that should be shown.}} |
|} | |} | ||
| Line 22: | Line 22: | ||
== See also == | == See also == | ||
| − | [[ConfirmDialog]] <br/> | + | [[Extensions.HMI.ConfirmDialog|ConfirmDialog]] <br/> |
| − | [[InputDialog]] <br/> | + | [[Extensions.HMI.InputDialog|InputDialog]] <br/> |
| − | [[ChoiceDialog]] | + | [[Extensions.HMI.ChoiceDialog|ChoiceDialog]] |
Revision as of 08:50, 15 February 2016
Classification
| Name | ShowDocumentDialog |
| Short Description | Dialog that indicates to the user with a list of choices |
| Class | Action |
| Extension | OTX HMI extension |
| Group | Dialog related actions |
| Exceptions | InvalidReferenceException |
| Checker Rules | - |
| Standard Compliant | Yes |
OTL Syntax
Hmi.ShowDocumentDialog(StringTerm, StringTerm, StringTerm);Description
The ShowDocumentDialog activity opens a dialog that can show through URI identified a document. The document can be any resource. Typical use of this dialogue is to show additional documentation for users, such as repair manuals and wiring diagrams or long security information that needs to read the user before a potentially dangerous operation.
Properties
| Name | Data Type | Class | Default | Cardinality | Description |
| Document | String | Term | - | [1] | This element identifies the externaldocument that should be shown. |
OTL Examples
Hmi.ShowDocumentDialog("Title", "Message", "DocumentUri");