![]() |
OTX-Runtime for DotNet
|
|
Default custom screen implementation. More...
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... | |
Default custom screen implementation.
|
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!
|
inline |
All screens related to the IRuntimeContext which are still open should be closed
runtimeContext | The related runtime context. |
Implements OpenTestSystem.Otx.Runtime.Api.Custom.ICustomScreenImplementation.
|
inline |
Invoked when a CloseScreen occurs in OTX-Runtime.
screen | Screen represents a screen signature. |
Implements OpenTestSystem.Otx.Runtime.Api.Custom.ICustomScreenImplementation.
|
inlinevirtual |
Invoked when a HighlightScreen occurs in OTX-Runtime.
screen | Screen represents a screen signature. |
Implements OpenTestSystem.Otx.Runtime.Api.Custom.ICustomScreenImplementation.
|
inline |
Invoked when an OpenScreen occurs in OTX-Runtime.
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.
|
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!
|
inline |
Invoked when a ScreenIsOpen occurs in OTX-Runtime.
screen | Screen represents a screen signature. |
Implements OpenTestSystem.Otx.Runtime.Api.Custom.ICustomScreenImplementation.
|
inline |
Start html Webserver when starting HtmlScreen binding.
|
inline |
Start html Webserver when starting HtmlScreen binding with optional configFilePath.
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 |
|
inline |
Stop html Webserver
|
inline |
Invoked when one or more ScreenParameters was changed in OTX-Runtime to the same value.
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.
|
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!
|
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!
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!