Difference between revisions of "Extensions.HMI.ShowDocumentDialog"
Jump to navigation
Jump to search
| (6 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
| − | [[Category:HMI]] | + | {{DISPLAYTITLE: '''ShowDocumentDialog'''}}[[Category:HMI]] |
== Classification == | == Classification == | ||
| − | {{ClassificationActivity | ShowDocumentDialog | Dialog that | + | {{ClassificationActivity | ShowDocumentDialog | Dialog that can display a document | [[Action]]| [[Extensions.HMI|OTX HMI extension]] | [[Extensions.HMI#Actions|Dialog related actions]] | [[Core.DataTypes.ComplexDataType.InvalidReferenceException|InvalidReferenceException]] | - }} |
== OTL Syntax == | == OTL Syntax == | ||
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | <syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | ||
| − | + | HMI.ShowDocumentDialog(StringTerm message, StringTerm title, StringTerm document); | |
</syntaxhighlight> | </syntaxhighlight> | ||
== Description == | == Description == | ||
| − | The '''ShowDocumentDialog''' activity | + | The '''ShowDocumentDialog''' activity will open a dialog that can display a document which is identified by e.g. a URI. The document can be any resource. The call will block until the user has confirmed reading the document. |
| + | |||
| + | Typical usage of this node is to show additional documentation to the users, such as repair guides and schematics, or lengthy security information that the user must read before proceeding with a potentially dangerous operation. | ||
| + | |||
| + | In case that a document type can not be opened and displayed by the test application itself, the runtime may delegate the opening of the document to the application which is registered for that document type on the operating system. | ||
| + | |||
| + | Ultimately, if a document type is supported neither by the test application nor by any external viewer, then the test application shall show a suitable error message indicating that the document type is not supported and can therefore not be displayed. | ||
| + | |||
== Properties == | == Properties == | ||
{| {{TableHeader}} | {| {{TableHeader}} | ||
{{TableRowPropertiesHeader}} | {{TableRowPropertiesHeader}} | ||
| − | {{ | + | {{TableRowPropertie2| Document | [[Core.DataTypes.SimpleDataType.String|String]] | [[Term]] | - | [1] | This element identifies the external document that should be shown.}} |
|} | |} | ||
== OTL Examples == | == OTL Examples == | ||
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | <syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | ||
| − | + | /// Local Declarations | |
| + | |||
| + | /// Flow | ||
| + | |||
| + | HMI.ShowDocumentDialog( "Message", "Title", "file:///D:/abc.txt"); | ||
</syntaxhighlight> | </syntaxhighlight> | ||
== See also == | == See also == | ||
| − | [[ConfirmDialog]] <br/> | + | [[Extensions.HMI.ConfirmDialog|ConfirmDialog]] <br/> |
| − | [[InputDialog]] <br/> | + | [[Extensions.HMI.InputDialog|InputDialog]] <br/> |
| − | [[ChoiceDialog]] | + | [[Extensions.HMI.ChoiceDialog|ChoiceDialog]] |
Latest revision as of 05:49, 7 November 2018
Classification
| Name | ShowDocumentDialog |
| Short Description | Dialog that can display a document |
| Class | Action |
| Extension | OTX HMI extension |
| Group | Dialog related actions |
| Exceptions | InvalidReferenceException |
| Checker Rules | - |
| Standard Compliant | Yes |
OTL Syntax
HMI.ShowDocumentDialog(StringTerm message, StringTerm title, StringTerm document);Description
The ShowDocumentDialog activity will open a dialog that can display a document which is identified by e.g. a URI. The document can be any resource. The call will block until the user has confirmed reading the document.
Typical usage of this node is to show additional documentation to the users, such as repair guides and schematics, or lengthy security information that the user must read before proceeding with a potentially dangerous operation.
In case that a document type can not be opened and displayed by the test application itself, the runtime may delegate the opening of the document to the application which is registered for that document type on the operating system.
Ultimately, if a document type is supported neither by the test application nor by any external viewer, then the test application shall show a suitable error message indicating that the document type is not supported and can therefore not be displayed.
Properties
| Name | Data Type | Class | Default | Cardinality | Description |
| Document | String | Term | - | [1] | This element identifies the external document that should be shown. |
OTL Examples
/// Local Declarations
/// Flow
HMI.ShowDocumentDialog( "Message", "Title", "file:///D:/abc.txt");