Extensions.HMI.HighlightScreen
Jump to navigation
Jump to search
Classification
Name | HighlightScreen |
Short Description | Highlights a given screen |
Class | Action |
Extension | OTX HMI extension |
Group | Custom screen related actions |
Exceptions | - |
Checker Rules | - |
Standard Compliant | Yes |
OTL Syntax
HMI.HighlightScreen(ScreenVariable screen);
Description
The HighlightScreen activity will highlight a given screen in a way appropriate for drawing the user's attention to the screen. This supports use cases where user attention is required, e.g. when a situation occurs which immediately requires user input on a particular screen, or when a screen displays important information which tells the user which actions to take to solve e.g. a critical situation, etc.
Properties
Name | Data Type | Class | Default | Cardinality | Description |
Screen | Screen | Variable | - | [1] | This element represents the screen handle of the screen that will be highlighted. |
OTL Examples
/// Signatures
package HMI.ScreenSignature ScreenSignature1(ref Integer ScreenInOutParameter1);
/// Global Declarations
public procedure main()
{
/// Local Declarations
HMI.Screen ScreenHandle1;
Integer Integer1;
/// Flow
HMI.OpenScreen(ScreenHandle1, ScreenSignature1, {ScreenInOutParameter1 = Integer1}, false);
HMI.HighlightScreen(ScreenHandle1);
}