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

Allows users to implement their own Screens. More...

Inheritance diagram for OpenTestSystem.Otx.Runtime.Api.Custom.ICustomScreenImplementation:

Public Member Functions
void	CloseAll (IRuntimeContext runtimeContext)
	All screens related to the IRuntimeContext which are still open should be closed More...
void	CloseScreen (IScreenHandle screen)
	Invoked when a CloseScreen occurs in OTX-Runtime. More...
void	HighlightScreen (IScreenHandle screen)
	Invoked when a HighlightScreen occurs in OTX-Runtime. More...
void	OpenScreen (IRuntimeContext runtimeContext, IScreenHandle screen, List< IScreenParameter > parameters, bool modal)
	Invoked when an OpenScreen occurs in OTX-Runtime. More...
bool	ScreenIsOpen (IScreenHandle screen)
	Invoked when a ScreenIsOpen occurs in OTX-Runtime. More...
void	UpdateScreenParameterValues (IScreenHandle screen, List< string > parameterNames, object value)
	Invoked when one ore more ScreenParameters was changed in OTX-Runtime to the same value. More...

Detailed Description

Allows users to implement their own Screens.

Important: While the custom implementation is processing a method call, the OTX runtime is blocked. It waits until the custom implementation has finished processing before resuming execution.

Member Function Documentation

CloseAll()

void OpenTestSystem.Otx.Runtime.Api.Custom.ICustomScreenImplementation.CloseAll

(

IRuntimeContext

runtimeContext

)

All screens related to the IRuntimeContext which are still open should be closed

Parameters

runtimeContext

The related runtime context.

Implemented in OpenTestSystem.Otx.Runtime.Api.Custom.DefaultCustomScreenImplementation.

CloseScreen()

void OpenTestSystem.Otx.Runtime.Api.Custom.ICustomScreenImplementation.CloseScreen

(

IScreenHandle

screen

)

Invoked when a CloseScreen occurs in OTX-Runtime.

Parameters

screen

Represents a screen instance.

Implemented in OpenTestSystem.Otx.Runtime.Api.Custom.DefaultCustomScreenImplementation.

HighlightScreen()

void OpenTestSystem.Otx.Runtime.Api.Custom.ICustomScreenImplementation.HighlightScreen

(

IScreenHandle

screen

)

Invoked when a HighlightScreen occurs in OTX-Runtime.

Parameters

screen

Represents a screen instance.

Implemented in OpenTestSystem.Otx.Runtime.Api.Custom.DefaultCustomScreenImplementation.

OpenScreen()

void OpenTestSystem.Otx.Runtime.Api.Custom.ICustomScreenImplementation.OpenScreen	(	IRuntimeContext	runtimeContext,
		IScreenHandle	screen,
		List< IScreenParameter >	parameters,
		bool	modal
	)

Invoked when an OpenScreen occurs in OTX-Runtime.

Parameters

runtimeContext	The related runtime context.
screen	Represents a screen instance.
parameters	Arguments which are passed to OpenScreen.
modal	If modal is false, the OTX execution flow will immediately move on to the next Action, without waiting for the screen to close. If modal is true, the screen implementation must wait until the screen was closed. Please note, that this behavior must be implemented inside the screen implementation.

Implemented in OpenTestSystem.Otx.Runtime.Api.Custom.DefaultCustomScreenImplementation.

ScreenIsOpen()

bool OpenTestSystem.Otx.Runtime.Api.Custom.ICustomScreenImplementation.ScreenIsOpen

(

IScreenHandle

screen

)

Invoked when a ScreenIsOpen occurs in OTX-Runtime.

Parameters

screen

Represents a screen instance.

Implemented in OpenTestSystem.Otx.Runtime.Api.Custom.DefaultCustomScreenImplementation.

UpdateScreenParameterValues()

void OpenTestSystem.Otx.Runtime.Api.Custom.ICustomScreenImplementation.UpdateScreenParameterValues	(	IScreenHandle	screen,
		List< string >	parameterNames,
		object	value
	)

Invoked when one ore more ScreenParameters was changed in OTX-Runtime to the same value.

Parameters

screen	Represents a screen instance.
parameterNames	Names of the parameters which value was changed.
value	Value to all listed parameters was changed.

Implemented in OpenTestSystem.Otx.Runtime.Api.Custom.DefaultCustomScreenImplementation.

---

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

• ICustomScreenImplementation.cs