ActionKey (Screen function) - Revision history

JALWiccan: 1 revision

2012-11-16T22:25:11Z

1 revision

← Older revision	Revision as of 22:25, 16 November 2012
(No difference)

JAL2 at 22:25, 16 November 2012

2012-11-16T22:25:10Z

← Older revision		Revision as of 22:25, 16 November 2012
Line 1:		Line 1:
	{{Template:Screen:ActionKey subtitle}}		{{Template:Screen:ActionKey subtitle}}
	The <var>ActionKey</var> ~~read-only~~ property returns an <var>[[Screen classes#ActionKey enumeration\|ActionKey]]</var> enumeration which is the keyboard key that activated the last screen read.		The <var>ActionKey</var> [[Classes and Objects#readWrite\|readOnly]] property returns an <var>[[Screen classes#ActionKey enumeration\|ActionKey]]</var> enumeration which is the keyboard key that activated the last screen read.

	==Syntax==		==Syntax==

JAL2 at 01:52, 17 August 2011

2011-08-17T01:52:33Z

← Older revision		Revision as of 01:52, 17 August 2011
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.		The <var>ActionKey</var> read-only property returns an <var>[[Screen classes#ActionKey enumeration\|ActionKey]]</var> enumeration which is the keyboard key that activated the last screen read.

	==Syntax==		==Syntax==
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 value ~~(see below)~~.</td></tr>		<td>A declared <var>ActionKey</var> enumeration value.</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>
	</table>		</table>

	~~===ActionKey enumeration===~~
	~~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>.~~

	~~Besides the [[#Common Enumeration methods\|common enumeration methods]], the~~
	~~<var>ActionKey</var> enumeration has an additional method available (<var>ToNumber</var>), as~~
	~~described in the following section.~~
	~~====ToNumber function====~~
	This function converts <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.
	~~====ToNumber syntax====~~
	~~<p class="syntax"> <span class="term">%num</span> <span class="literal">= </span><span class="term">key</span><span class="literal">:ToNumber</span>~~
	~~</p>~~

	~~====Syntax terms====~~
	~~<table class="syntaxTable">~~
	~~<tr><th>%num</th>~~
	~~<td>A number variable that is assigned the integer part of the action key name.~~
	~~</td></tr>~~
	~~<tr><th>key</th>~~
	~~<td>An <var>ActionKey</var> enumeration variable or expression.~~
	~~</td></tr></table>~~

	==Usage notes==		==Usage notes==
	<ul><li>~~You can use the~~ <var>ActionKey</var> enumeration <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><li>The <var>ActionKey</var> enumeration <var>[[Screen classes#ToNumber function\|ToNumber]]</var> method provides integer values that you can use in a value-testing loop in conjunction with the <var class="product">User Language</var> <var>Jump</var> statement, as demonstrated in [[Screen object sample code\|"Screen object sample code"]].
	</ul>		</ul>

	==See also==		==See also==
	{{Template:Screen:ActionKey footer}}		{{Template:Screen:ActionKey footer}}

JAL2 at 01:25, 17 August 2011

2011-08-17T01:25:29Z

← Older revision		Revision as of 01:25, 17 August 2011
Line 14:		Line 14:
	===ActionKey enumeration===		===ActionKey enumeration===
	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>.		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>.

			Besides the [[#Common Enumeration methods\|common enumeration methods]], the
			<var>ActionKey</var> enumeration has an additional method available (<var>ToNumber</var>), as
			described in the following section.
			====ToNumber function====
			This function converts <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.
			====ToNumber syntax====
			<p class="syntax"> <span class="term">%num</span> <span class="literal">= </span><span class="term">key</span><span class="literal">:ToNumber</span>
			</p>

			====Syntax terms====
			<table class="syntaxTable">
			<tr><th>%num</th>
			<td>A number variable that is assigned the integer part of the action key name.
			</td></tr>
			<tr><th>key</th>
			<td>An <var>ActionKey</var> enumeration variable or expression.
			</td></tr></table>

	==Usage notes==		==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><li>You can use the <var>ActionKey</var> enumeration <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>		</ul>

	==See also==		==See also==
	{{Template:Screen:ActionKey footer}}		{{Template:Screen:ActionKey footer}}

JAL2 at 01:03, 17 August 2011

2011-08-17T01:03:31Z

← Older revision		Revision as of 01:03, 17 August 2011
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 <~~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~~>.		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==

Goff: unvar

2011-06-28T10:01:33Z

unvar

← Older revision		Revision as of 10:01, 28 June 2011
Line 6:		Line 6:
	===Syntax terms===		===Syntax terms===
	<table class="syntaxTable">		<table class="syntaxTable">
	<tr><th~~><var~~>%key~~</var>~~</th>		<tr><th>%key</th>
	<td>A declared <var>ActionKey</var> enumeration (see below). </td></tr>		<td>A declared <var>ActionKey</var> enumeration (see below).</td></tr>
	<tr><th~~><var~~>screen~~</var>~~</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>
	</table>		</table>

Goff: re-

2011-06-25T23:47:29Z

re-<var>

← Older revision		Revision as of 23:47, 25 June 2011
Line 6:		Line 6:
	===Syntax terms===		===Syntax terms===
	<table class="syntaxTable">		<table class="syntaxTable">
	<tr><th>%key</th>		<tr><th><var>%key</var></th>
	<td>A declared <var>ActionKey</var> enumeration (see below). </td></tr>		<td>A declared <var>ActionKey</var> enumeration (see below). </td></tr>
	<tr><th>screen</th>		<tr><th><var>screen</var></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>
	</table>		</table>

Goff: match syntax table to syntax template; edits, tags and links

2011-06-25T08:59:58Z

match syntax table to syntax template; edits, tags and links

← Older revision		Revision as of 08:59, 25 June 2011
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.

	~~<h2>~~Syntax~~</h2>~~		==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>
	~~<h3>ActionKey enumeration</h3>~~
	~~Valid values of this 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>.~~

	<h2>Usage notes<~~/h2~~>		===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>.
	<h2>See also~~</h2>~~
			==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}}

Dme at 21:47, 23 May 2011

2011-05-23T21:47:35Z

← Older revision		Revision as of 21:47, 23 May 2011
Line 3:		Line 3:
	<h2>Syntax</h2>		<h2>Syntax</h2>
	{{Template:Screen:ActionKey syntax}}		{{Template:Screen:ActionKey syntax}}
	~~<h3>~~Syntax terms~~</h3>~~		===Syntax terms===
	<table class="syntaxTable">		<table class="syntaxTable">
	<tr><th>%key</th>		<tr><th>%key</th>

JAL2 at 23:22, 17 May 2011

2011-05-17T23:22:10Z

New page

{{Template:Screen:ActionKey subtitle}}

<h2>Syntax</h2>
{{Template:Screen:ActionKey syntax}}
<h3>Syntax terms</h3>
<table class="syntaxTable">
<tr><th>%key</th>
<td>A declared <var>ActionKey</var> enumeration (see below). </td></tr>
<tr><th>screen</th>
<td>A reference to an instance of a <var>Screen</var> object.</td></tr>
</table>
<h3>ActionKey enumeration</h3>
Valid values of this 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>.

<h2>Usage notes</h2>
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.
<h2>See also</h2>
{{Template:Screen:ActionKey footer}}