OpenTestSystem.Otx.Runtime.Api.Custom.IBasicScreenImplementation Interface Reference

Allows users to implement their own basic Screens, consisting of ConfirmDialog, InputDialog, ChoiceDialog and ShowDocumentDialog. More...

Public Member Functions
int	ChoiceDialog (string title, string message, List< string > options, int _default)
	Invoked when a ChoiceDialog occurs in OTX-Runtime. More...
ConfirmationTypes	ConfirmDialog (string title, string message, MessageTypes messageType)
	Invoked when a ConfirmDialog occurs in OTX-Runtime. More...
string	InputDialog (string title, string message, string initValue, string instruction, string restriction)
	Invoked when an InputDialog occurs in OTX-Runtime. More...
void	ShowDocumentDialog (string title, string message, string document)
	Invoked when a ShowDocumentDialog occurs in OTX-Runtime. More...

Detailed Description

Allows users to implement their own basic Screens, consisting of ConfirmDialog, InputDialog, ChoiceDialog and ShowDocumentDialog.

Member Function Documentation

ChoiceDialog()

int OpenTestSystem.Otx.Runtime.Api.Custom.IBasicScreenImplementation.ChoiceDialog	(	string	title,
		string	message,
		List< string >	options,
		int	_default
	)

Invoked when a ChoiceDialog occurs in OTX-Runtime.

Parameters

title	Title of the dialog.
message	Message of the dialog.
options	Options specifies a list of strings which contains the possible options that shall be displayed.
_default	Default represents the index of the option which shall be preselected in the dialog.

Returns

Selection from the user will be sent to OTX-Runtime.

ConfirmDialog()

ConfirmationTypes OpenTestSystem.Otx.Runtime.Api.Custom.IBasicScreenImplementation.ConfirmDialog	(	string	title,
		string	message,
		MessageTypes	messageType
	)

Invoked when a ConfirmDialog occurs in OTX-Runtime.

Parameters

title	Title of the dialog.
message	Message of the dialog.
messageType	Type of message and the buttons that shall be shown to the user to confirm the action.

Returns

Selection from the user will be sent to OTX-Runtime.

InputDialog()

string OpenTestSystem.Otx.Runtime.Api.Custom.IBasicScreenImplementation.InputDialog	(	string	title,
		string	message,
		string	initValue,
		string	instruction,
		string	restriction
	)

Invoked when an InputDialog occurs in OTX-Runtime.

Parameters

title	Title of the dialog.
message	Message of the dialog.
initialValue	Initial value represents the string value that shall be used to initialize the dialog's input field.
instruction	Instruction is an additional message to provide information regarding the expected value that should be introduced.
restriction	Restriction shall be formulated by a regular expression which validates the input data.

Returns

Returned value will be sent to OTX-Runtime.

ShowDocumentDialog()

void OpenTestSystem.Otx.Runtime.Api.Custom.IBasicScreenImplementation.ShowDocumentDialog	(	string	title,
		string	message,
		string	document
	)

Invoked when a ShowDocumentDialog occurs in OTX-Runtime.

Parameters

title	Title of the dialog.
message	Message of the dialog.
document	This identifies the external document that should be shown.

---

The documentation for this interface was generated from the following file:

• IBasicScreenImplementation.cs