ActionKey (Screen function): Difference between revisions
Jump to navigation
Jump to search
mNo edit summary |
mNo edit summary |
||
Line 3: | Line 3: | ||
<h2>Syntax</h2> | <h2>Syntax</h2> | ||
{{Template:Screen:ActionKey syntax}} | {{Template:Screen:ActionKey syntax}} | ||
===Syntax terms=== | |||
<table class="syntaxTable"> | <table class="syntaxTable"> | ||
<tr><th>%key</th> | <tr><th>%key</th> |
Revision as of 21:47, 23 May 2011
Return name of key that activated last screen read (Screen class)
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.