Extensions.HMI.HighlightScreen

Classification

Name	HighlightScreen
Short Description	Raises a specific screen shown to the user's attention to focus on the screen
Class	Action
Extension	OTX HMI extension
Group	Custom screen related actions
Exceptions	-
Checker Rules	-
Standard Compliant	Yes

OTL Syntax

Hmi.HighlightScreen(ScreenHandle);

Description

The HighlightScreen activity raises a particular screen out for attention of the user on the screen to set. This supports the use cases where the user's attention is required, eg. Example, if a situation occurs the instant the user input is required or if important information is displayed to inform the user to take the measures to eg to solve a critical situation, etc.

Properties

Name	Data Type	Class	Default	Cardinality	Description
Screen	Screen	Variable	-	[1]	The handle of the screen that to be highlighted.

OTL Examples

package Hmi.ScreenSignature ScreenSignature1(ref Integer ScreenInOutParameter1);

public procedure main()
{
   Hmi.Screen ScreenHandle1;
   Integer ScreenInOut1;

   Hmi.OpenScreen(ScreenSignature1, false, {ref ScreenInOutParameter1 = ScreenInOut1}, ScreenHandle1);
   Hmi.HighlightScreen(ScreenHandle1);
}

See also

OpenScreen
CloseScreen