Extensions.HMI.ScreenIsOpen

From emotive
Revision as of 07:42, 4 August 2014 by Nb (talk | contribs) (Created page with "Category:HMI == Classification == {{ClassificationActivity | ScreenIsOpen | Verifies whether a screen is open and active | Term | OTX HMI extension | HMI rel...")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

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

Pseudo-Code Syntax

Boolean ScreenIsOpen(Screen screen);

Description

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

Return Value

The Term returns the value, see table below.

Icons Note.png 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

Examples

Boolean result = ScreenIsOpen(myScreen);

See also

ScreenClosedEventSource
IsScreenClosedEvent