ActionKey (Screen function): Difference between revisions
Jump to navigation
Jump to search
m (unvar) |
mNo edit summary |
||
| Line 7: | Line 7: | ||
<table class="syntaxTable"> | <table class="syntaxTable"> | ||
<tr><th>%key</th> | <tr><th>%key</th> | ||
<td>A declared <var>ActionKey</var> enumeration (see below).</td></tr> | <td>A declared <var>ActionKey</var> enumeration value (see below).</td></tr> | ||
<tr><th>screen</th> | <tr><th>screen</th> | ||
<td>A reference to an instance of a <var>Screen</var> object.</td></tr> | <td>A reference to an instance of a <var>Screen</var> object.</td></tr> | ||
| Line 13: | Line 13: | ||
===ActionKey enumeration=== | ===ActionKey enumeration=== | ||
Valid values of this enumeration are < | Valid values of this [[Enumerations|enumeration]] are <var>Enter</var> and <var>Pf1</var>, <var>Pf2</var>, and so on through <var>Pf24</var>. The value that is set initially is <var>Enter</var>. | ||
==Usage notes== | ==Usage notes== | ||
Revision as of 01:03, 17 August 2011
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.
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.