ActionKey (Screen function): Difference between revisions
Jump to navigation
Jump to search
mNo edit summary |
m (match syntax table to syntax template; edits, tags and links) |
||
| Line 1: | Line 1: | ||
{{Template:Screen:ActionKey subtitle}} | {{Template:Screen:ActionKey subtitle}} | ||
The <var>ActionKey</var> read-only property returns an <var>[[#ActionKey enumeration|ActionKey]]</var> enumeration which is the keyboard key that activated the last screen read. | |||
==Syntax== | |||
{{Template:Screen:ActionKey syntax}} | {{Template:Screen:ActionKey syntax}} | ||
===Syntax terms=== | ===Syntax terms=== | ||
| Line 10: | Line 11: | ||
<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> | ||
</table> | </table> | ||
< | ===ActionKey enumeration=== | ||
You can use the <var>ActionKey</var> class <var>ToNumber</var> method to convert <var>ActionKey</var> enumeration values to a numeric value: the integer that remains after the key name is stripped of its "PF" prefix. For <var>Enter</var>, the numeric value is 0. These values are useful in a value-testing loop in conjunction with the <var class="product">User Language</var> <var>Jump</var> statement. | Valid values of this enumeration are <code>Enter</code> and <code>Pf1</code>, <code>Pf2</code>, and so on through <code>Pf24</code>. The value that is set initially is <code>Enter</code>. | ||
< | |||
==Usage notes== | |||
<ul><li>You can use the <var>ActionKey</var> class <var>ToNumber</var> method to convert <var>ActionKey</var> enumeration values to a numeric value: the integer that remains after the key name is stripped of its "PF" prefix. For <var>Enter</var>, the numeric value is 0. These values are useful in a value-testing loop in conjunction with the <var class="product">User Language</var> <var>Jump</var> statement. | |||
</ul> | |||
==See also== | |||
{{Template:Screen:ActionKey footer}} | {{Template:Screen:ActionKey footer}} | ||
Revision as of 08:59, 25 June 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 (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.