ActionKey (Screen function)

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

This read-only property returns an actionKey enumeration which is the keyboard key that activated the last screen read. ActionKey enumerations are pf1 through pf24, and enter.

Syntax

%key = screen:ActionKey

Syntax terms

%key

A declared ActionKey enumeration. Valid values are Enter and pf1, pf2, and so on through pf24. The value that is set initially is Enter.

%screen

A reference to an instance of a Screen object.

Usage notes

You can use the ActionKey class 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

Screen class ScreenField class	List of Screen methods List of ScreenField methods List of Screen API methods	Screen methods syntax ScreenField methods syntax
Notation conventions for methods