Extensions.HMI.ScreenClosedEventSource

Classification

Name	ScreenClosedEventSource
Short Description	Accepts a Screen object that is to be made an event source
Class	Term
Extension	OTX HMI extension
Group	HMI related terms
Exceptions	-
Checker Rules	-
Standard Compliant	Yes

OTL Syntax

EventSource = HMI.ScreenClosedEventSource(ScreenTerm);

Description

The ScreenClosedEventSource term accepts a Screen object that is to be made an event source. This term enables an OTX sequence to use a Screen as a source for events in the context of the OTX EventHandling extension. A Screen shall trigger an event every when the specified screen is closed. This can be used within a event:WaitForEventAction to continue execution after a 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
EventSource	Event source from a screen object.

Properties

Name	Data Type	Class	Default	Cardinality	Description
Screen	Screen	Term	-	[1]	Represents the Screen that shall be connected to the event source.

OTL Examples

package HMI.ScreenSignature ScreenSignature1(ref Integer ScreenInOutParameter1);

/// Global Declarations

public procedure main()
{
	/// Local Declarations

	HMI.Screen ScreenHandle1;
	Integer Integer1;
	EventHandling.EventSource EventSource1;

	/// Flow

	HMI.OpenScreen(ScreenHandle1, ScreenSignature1, {ScreenInOutParameter1 = Integer1}, false);
	EventSource1 = HMI.ScreenClosedEventSource(ScreenHandle1);
        HMI.CloseScreen(ScreenHandle1);
}

See also

IsScreenClosedEvent
ScreenIsOpen