ActionKey (Screen function)

From m204wiki
Revision as of 01:25, 17 August 2011 by JAL2 (talk | contribs)
Jump to navigation Jump to search

Return name of key that activated last screen read (Screen class)

The ActionKey read-only property returns an ActionKey enumeration which is the keyboard key that activated the last screen read.

Syntax

%key = screen:ActionKey

Syntax terms

%key A declared ActionKey enumeration value (see below).
screen A reference to an instance of a Screen object.

ActionKey enumeration

Valid values of this enumeration are Enter and Pf1, Pf2, and so on through Pf24. The value that is set initially is Enter.

Besides the common enumeration methods, the ActionKey enumeration has an additional method available (ToNumber), as described in the following section.

ToNumber function

This function converts ActionKey enumeration values to a numeric value: the integer that remains after the key name is stripped of its "PF" prefix. For Enter, the numeric value is 0. These values are useful in a value-testing loop in conjunction with the User Language Jump statement.

ToNumber syntax

%num = key:ToNumber

Syntax terms

%num A number variable that is assigned the integer part of the action key name.
key An ActionKey enumeration variable or expression.

Usage notes

  • You can use the ActionKey enumeration ToNumber method to convert ActionKey enumeration values to a numeric value: the integer that remains after the key name is stripped of its "PF" prefix. For Enter, the numeric value is 0. These values are useful in a value-testing loop in conjunction with the User Language Jump statement.

See also