Extensions.HMI.IsScreenClosedEvent

Classification

Name	IsScreenClosedEvent
Short Description	Checks whether the event of a ScreenClosedEventSource term comes
Class	Term
Extension	OTX HMI extension
Group	HMI related terms
Exceptions	-
Checker Rules	-
Standard Compliant	Yes

OTL Syntax

BooleanTerm = Hmi.IsScreenClosedEvent(EventTerm, ScreenHandle);

Description

The term returns TRUE if exactly then the event of a ScreenClosedEventSource term comes. In the case of an optional screen variable is specified, the term will return TRUE if exactly then the event was triggered, because this particular screen was closed.

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 event of a ScreenClosedEventSource term comes.

Properties

Name	Data Type	Class	Default	Cardinality	Description
Event	Event	Value	-	[1]	The event, whose type is checked
Screen	Screen	Variable	-	[0..1]	Optional are the special screen that triggers the event

OTL Examples

package Hmi.ScreenSignature ScreenSignature1(ref Integer ScreenInOutParameter1);

public procedure main()
{
   Hmi.Screen ScreenHandle1;
   Integer ScreenInOut1;
   EventHandling.EventSource EventSource1;
   EventHandling.Event Event1;
   Boolean Boolean1 = false;

   Hmi.OpenScreen(ScreenSignature1, false, {ref ScreenInOutParameter1 = ScreenInOut1}, ScreenHandle1);
   EventSource1 = Hmi.ScreenClosedEventSource(ScreenHandle1);
   Hmi.CloseScreen(ScreenHandle1);
   EventHandling.WaitForEvent({EventSource1}, Event1);
   Boolean1 = Hmi.IsScreenClosedEvent(Event1, ScreenHandle1);
}

See also

ScreenClosedEventSource
ScreenIsOpen