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 screen);

Description

The ScreenIsOpen term is used to verify that a Screen is open and active. A Screen is open and active if it has been opened by using an OpenScreen action, it has not been dismissed by the user and it has not been closed by using a CloseScreen action.

Important: Due to the fact that there may be multiple parallel lanes, and that a screen engine normally works in a different thread, if the ScreenIsOpen term returns true there is actually no guarantee that the screen is still open on the next step.

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]	This element represents the variable which is a handle to the screen that will be checked.

OTL Examples

/// Signatures

package HMI.ScreenSignature ScreenSignature1(ref Integer ScreenInOutParameter1);

/// Global Declarations

public procedure main()
{
	/// Local Declarations

	HMI.Screen ScreenHandle1;
	Integer Integer1;
	Boolean Boolean1 = false;

	/// Flow

	HMI.OpenScreen(ScreenHandle1, ScreenSignature1, {ScreenInOutParameter1 = Integer1}, false);
	Boolean1 = HMI.ScreenIsOpen(ScreenHandle1);
}

See also

ScreenClosedEventSource
IsScreenClosedEvent