OpenTestSystem.Otx.Extensions.HMI.Actions.ShowDocumentDialog Class Reference

Dialog for displaying a document More...

Inheritance diagram for OpenTestSystem.Otx.Extensions.HMI.Actions.ShowDocumentDialog:

Public Attributes
StringTerm	document
	Cardinality [0..1] Path (URL) to the document, which will be shown. More...
Public Attributes inherited from OpenTestSystem.Otx.Extensions.HMI.Actions.Dialog
StringTerm	message
	Cardinality [0..1] If the runtime system contains the capability to show a message as part of the display, the String will be shown. More...
StringTerm	title
	Cardinality [0..1] If the runtime system contains the capability to show a dialog box with a Title bar, the String will be shown. It is assumed that this String will be shown with more prominence than the message parameter. More...
Public Attributes inherited from OpenTestSystem.Otx.Core.Actions.ActionRealisation
OtxLink	validFor
	Cardinality [0..1] Validity of ActionRealisation. More...

Detailed Description

Dialog for displaying a document

The ShowDocumentDialog activity represents the specified document. The process here is not interrupted until the user confirms that he has read 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.

Exceptions

Core.Exceptions.InvalidReferenceException

Syntax

HMI.ShowDocumentDialog(StringTerm message, StringTerm title, StringTerm document);

Examples

// Local Declarations
 
// Flow
HMI.ShowDocumentDialog( "Message", "Title", "file:///D:/abc.txt");

Member Data Documentation

document

StringTerm OpenTestSystem.Otx.Extensions.HMI.Actions.ShowDocumentDialog.document

Cardinality [0..1]
Path (URL) to the document, which will be shown.