Default custom screen implementation. More...

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

Public Member Functions
virtual void	ActivateHmiScreen ()
	Activates the top screen of the Assembly-Screen Implementation More...

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...

virtual 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...

virtual void	RefreshHmiScreen ()
	Refreshes all screens of the Assembly-Screen Implementation More...

bool	ScreenIsOpen (IScreenHandle screen)
	Invoked when a ScreenIsOpen occurs in OTX-Runtime. More...

void	StartHtmlWebServer ()
	Start html Webserver when starting HtmlScreen binding. More...

void	StartHtmlWebServer (string configFilePath)
	Start html Webserver when starting HtmlScreen binding with optional configFilePath. More...

void	StopHtmlWebServer ()
	Stop html Webserver More...

void	UpdateScreenParameterValues (IScreenHandle screen, List< string > parameterNames, object value)
	Invoked when one or more ScreenParameters was changed in OTX-Runtime to the same value. More...

Properties
object	HmiScreenContainer `[get, set]`

int	HmiScreenHandle `[get, set]`
	Sets a HWND where screens of the Assembly-Screen Implementation will be displayed More...

Events
KeyEventHandler	KeyDown
	Occurs when a key is pressed inside a screen of the Assembly-Screen Implementation when the is active. More...

Detailed Description

Default custom screen implementation.

Member Function Documentation

◆ ActivateHmiScreen()

virtual void OpenTestSystem.Otx.Runtime.Api.Custom.DefaultCustomScreenImplementation.ActivateHmiScreen ( )

inlinevirtual

Activates the top screen of the Assembly-Screen Implementation

Important: The method is not part of OTX HMI extension and is only valid for Assembly-Screen Implementation!

◆ CloseAll()

void OpenTestSystem.Otx.Runtime.Api.Custom.DefaultCustomScreenImplementation.CloseAll ( IRuntimeContext runtimeContext )

inline

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

Parameters

runtimeContext The related runtime context.

Implements OpenTestSystem.Otx.Runtime.Api.Custom.ICustomScreenImplementation.

◆ CloseScreen()

void OpenTestSystem.Otx.Runtime.Api.Custom.DefaultCustomScreenImplementation.CloseScreen ( IScreenHandle screen )

inline

Invoked when a CloseScreen occurs in OTX-Runtime.

Parameters

screen Screen represents a screen signature.

Implements OpenTestSystem.Otx.Runtime.Api.Custom.ICustomScreenImplementation.

◆ HighlightScreen()

virtual void OpenTestSystem.Otx.Runtime.Api.Custom.DefaultCustomScreenImplementation.HighlightScreen ( IScreenHandle screen )

inlinevirtual

Invoked when a HighlightScreen occurs in OTX-Runtime.

Parameters

screen Screen represents a screen signature.

Implements OpenTestSystem.Otx.Runtime.Api.Custom.ICustomScreenImplementation.

◆ OpenScreen()

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

inline

Invoked when an OpenScreen occurs in OTX-Runtime.

Parameters

runtimeContext	The related runtime context.
screen	Screen represents an OTX ScreenSignature.
parameters	Arguments which are passed to OpenScreen.
modal	Modal is false, the OTX execution flow will immediately move on to the next Action, without waiting for the screen to close. Otherwise, if modal is true.

Implements OpenTestSystem.Otx.Runtime.Api.Custom.ICustomScreenImplementation.

◆ RefreshHmiScreen()

virtual void OpenTestSystem.Otx.Runtime.Api.Custom.DefaultCustomScreenImplementation.RefreshHmiScreen ( )

inlinevirtual

Refreshes all screens of the Assembly-Screen Implementation

Important: The method is not part of OTX HMI extension and is only valid for Assembly-Screen Implementation!

◆ ScreenIsOpen()

bool OpenTestSystem.Otx.Runtime.Api.Custom.DefaultCustomScreenImplementation.ScreenIsOpen ( IScreenHandle screen )

inline

Invoked when a ScreenIsOpen occurs in OTX-Runtime.

Parameters

screen Screen represents a screen signature.

Implements OpenTestSystem.Otx.Runtime.Api.Custom.ICustomScreenImplementation.

◆ StartHtmlWebServer() [1/2]

void OpenTestSystem.Otx.Runtime.Api.Custom.DefaultCustomScreenImplementation.StartHtmlWebServer ( )

inline

Start html Webserver when starting HtmlScreen binding.

◆ StartHtmlWebServer() [2/2]

void OpenTestSystem.Otx.Runtime.Api.Custom.DefaultCustomScreenImplementation.StartHtmlWebServer ( string configFilePath )

inline

Start html Webserver when starting HtmlScreen binding with optional configFilePath.

Parameters

configFilePath Optional path to web server configuration file. The path must address a JSON file with a valid web server configuration. If not set the file [UserPublic]/OpenTestSystem/HtmlScreen/config.json will be used

◆ StopHtmlWebServer()

void OpenTestSystem.Otx.Runtime.Api.Custom.DefaultCustomScreenImplementation.StopHtmlWebServer ( )

inline

Stop html Webserver

◆ UpdateScreenParameterValues()

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

inline

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

Parameters

screen	Screen represents a screen signature.
parameterNames	Names of the parameters which value was changed.
value	Value to all listed parameters was changed.

Implements OpenTestSystem.Otx.Runtime.Api.Custom.ICustomScreenImplementation.

Property Documentation

◆ HmiScreenContainer

object OpenTestSystem.Otx.Runtime.Api.Custom.DefaultCustomScreenImplementation.HmiScreenContainer

getset

Sets a container where screens of the Assembly-Screen Implementation will be displayed

If an application sets this value to a [System.Windows.Forms.Control, System.Windows.Forms.Form, System.Windows.Controls.ContentControl, System.Windows.Window] all screens of the Assembly-Screen Implementation will be displayed inside this window. If the value is not set, a new window will be created. This is the default behavior.

If the value will be set to NULL, all open screens will be closed.

Important: The property is not part of OTX HMI extension and is only valid for Assembly-Screen Implementation!

◆ HmiScreenHandle

int OpenTestSystem.Otx.Runtime.Api.Custom.DefaultCustomScreenImplementation.HmiScreenHandle

getset

Sets a HWND where screens of the Assembly-Screen Implementation will be displayed

If an application sets this value to a windows handle (HWND) all screens of the Assembly-Screen Implementation will be displayed inside this window. If the value is not set, a new window will be created. This is the default behavior.

If the value will be set to 0, all open screens will be closed.

Important: The property is not part of OTX HMI extension and is only valid for Assembly-Screen Implementation!

Event Documentation

◆ KeyDown

KeyEventHandler OpenTestSystem.Otx.Runtime.Api.Custom.DefaultCustomScreenImplementation.KeyDown

Occurs when a key is pressed inside a screen of the Assembly-Screen Implementation when the is active.

Important: The event is not part of OTX HMI extension and is only valid for Assembly-Screen Implementation!

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

DefaultCustomScreenImplementation.cs

Public Member Functions

Properties

Events

Detailed Description

Member Function Documentation

◆ ActivateHmiScreen()

◆ CloseAll()

◆ CloseScreen()

◆ HighlightScreen()

◆ OpenScreen()

◆ RefreshHmiScreen()

◆ ScreenIsOpen()

◆ StartHtmlWebServer() [1/2]

◆ StartHtmlWebServer() [2/2]

◆ StopHtmlWebServer()

◆ UpdateScreenParameterValues()

Property Documentation

◆ HmiScreenContainer

◆ HmiScreenHandle

Event Documentation

◆ KeyDown