Difference between revisions of "Extensions.HMI.IsScreenClosedEvent"

From emotive
Jump to navigation Jump to search
(Created page with "Category:DiagCom == Classification == {{ClassificationActivity | IsScreenClosedEvent | Checks whether the event of a '''ScreenClosedEventSource''' term comes | Term |...")
 
Line 17: Line 17:
 
{{TableRowPropertiesHeader}}
 
{{TableRowPropertiesHeader}}
 
{{TableRowPropertie1| Event | [[Event]] | [[Value]] | - | [1] | The event, whose type is checked}}
 
{{TableRowPropertie1| Event | [[Event]] | [[Value]] | - | [1] | The event, whose type is checked}}
{{TableRowPropertie2| Screen | [[Screen]] | [[Variable]] | - | [1] | Optional are the special screen that triggers the event}}
+
{{TableRowPropertie2| Screen | [[Screen]] | [[Variable]] | - | [0..1] | Optional are the special screen that triggers the event}}
 
|}
 
|}
  

Revision as of 07:43, 4 August 2014

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

Pseudo-Code Syntax

Boolean IsScreenClosedEvent(Event event);

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.

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

Examples

Boolean result = IsScreenClosedEvent(myEvent);

See also

ScreenClosedEventSource
ScreenIsOpen