Extensions.HMI.ScreenIsOpen

Classification

Name	ScreenIsOpen
Short Description	Verifies whether a screen is open and active
Class	Term
Extension	OTX HMI extension
Group	HMI related terms
Exceptions	-
Checker Rules	-
Standard Compliant	Yes

OTL Syntax

BooleanTerm = Hmi.ScreenIsOpen(ScreenVariable);

Description

This term is used to ensure that a screen is open and active.

Return Value

The Term returns the value, see table below.

In OTX, Terms are categorized according to its return data type!

Data Type	Description
Boolean	This value is TRUE if the screen is open and active.

Properties

Name	Data Type	Class	Default	Cardinality	Description
Screen	Screen	Variable	-	[1]	The variable being evaluated, which is a handle on the Screen

OTL Examples

package Hmi.ScreenSignature ScreenSignature1(ref Integer ScreenInOutParameter1);

public procedure main()
{
   Hmi.Screen ScreenHandle1;
   Boolean Boolean1 = false;

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

See also

ScreenClosedEventSource
IsScreenClosedEvent