MaxActionKey (Screen property): Difference between revisions
Jump to navigation
Jump to search
mNo edit summary |
mNo edit summary |
||
| (10 intermediate revisions by 4 users not shown) | |||
| Line 1: | Line 1: | ||
{{Template:Screen:MaxActionKey subtitle}} | {{Template:Screen:MaxActionKey subtitle}} | ||
The <var>MaxActionKey</var> property sets or gets the enumeration of the keyboard action key on this screen that has the highest equivalent numeric value. | |||
Each action key, which activates a screen read, is identified by an <var>[[ActionKey_(Screen_function)#ActionKey_enumeration|ActionKey enumeration]]</var> (<code>Enter</code> and <code>pf1</code> through <code>pf24</code>). A key's numeric value is the number associated with its enumeration: for <code>Enter</code> this is <code>0</code>; for <code>pf1</code> it is <code>1</code>; for <code>pf2</code> it is <code>2</code>, and so on. | |||
<var>MaxActionKey</var> lets you limit the range of possible <var>ActionKey</var> enumeration return values you need to allow for in your program code (for example, if the values are the possible targets of a <var class="product">User Language</var> computed <var>JUMP TO</var> statement as shown in [[Screen object sample code|"Screen object sample code"]]). | |||
==Syntax== | ==Syntax== | ||
{{Template:Screen:MaxActionKey syntax}} | |||
===Syntax terms=== | ===Syntax terms=== | ||
< | <table class="syntaxTable"> | ||
< | <tr><th>%currentActionKey</th> | ||
< | <td>Gets the current value of the <var>MaxActionKey</var> property. Valid values 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>.</td></tr> | ||
< | <tr><th>screen</th> | ||
< | <td>A reference to an instance of a <var>Screen</var> object.</td></tr> | ||
<tr><th>newActionKey</th> | |||
<td>Sets the new value for the <var>MaxActionKey</var> property. Valid values are <code>Enter</code> and <code>pf1</code>, <code>pf2</code>, and so on through <code>pf24</code>.</td></tr> | |||
</table> | |||
==Usage | ==Usage notes== | ||
<ul> | |||
<li>You can use the <var>ActionKey</var> class <var>ToNumber</var> method to convert <var>ActionKey</var> enumeration values to their equivalent numeric values.</ul> | |||
==See also== | ==See also== | ||
{{Template:Screen:MaxActionKey footer}} | {{Template:Screen:MaxActionKey footer}} | ||
Latest revision as of 22:42, 16 November 2012
Return name of key that activated last screen read (Screen class)
The MaxActionKey property sets or gets the enumeration of the keyboard action key on this screen that has the highest equivalent numeric value.
Each action key, which activates a screen read, is identified by an ActionKey enumeration (Enter and pf1 through pf24). A key's numeric value is the number associated with its enumeration: for Enter this is 0; for pf1 it is 1; for pf2 it is 2, and so on.
MaxActionKey lets you limit the range of possible ActionKey enumeration return values you need to allow for in your program code (for example, if the values are the possible targets of a User Language computed JUMP TO statement as shown in "Screen object sample code").
Syntax
%currentActionKey = screen:MaxActionKey screen:MaxActionKey = newActionKey
Syntax terms
| %currentActionKey | Gets the current value of the MaxActionKey property. 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. |
| newActionKey | Sets the new value for the MaxActionKey property. Valid values are Enter and pf1, pf2, and so on through pf24. |
Usage notes
- You can use the ActionKey class ToNumber method to convert ActionKey enumeration values to their equivalent numeric values.