Difference between revisions of "Extensions.HMI.ShowDocumentDialog"
Jump to navigation
Jump to search
(Created page with "Category:HMI == Classification == {{ClassificationActivity | ShowDocumentDialog | Dialog that indicates to the user with a list of choices | Action| HMI|OTX HMI exte...") |
|||
| Line 3: | Line 3: | ||
{{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]]| [[HMI|OTX HMI extension]] | [[Dialog related actions]] | [[InvalidReferenceException]] | - }} | ||
| − | == | + | == OTL Syntax == |
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | <syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | ||
| − | ShowDocumentDialog( | + | Hmi.ShowDocumentDialog(StringTerm, StringTerm, StringTerm); |
</syntaxhighlight> | </syntaxhighlight> | ||
| Line 16: | Line 16: | ||
|} | |} | ||
| − | == Examples == | + | == OTL Examples == |
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | <syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | ||
| − | ShowDocumentDialog( | + | Hmi.ShowDocumentDialog("Title", "Message", "DocumentUri"); |
</syntaxhighlight> | </syntaxhighlight> | ||
Revision as of 07:25, 10 February 2015
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");