Value (ScreenField property) - Revision history

JAL: /* Examples */

2012-11-20T20:09:58Z

Examples

← Older revision		Revision as of 20:09, 20 November 2012
Line 22:		Line 22:
	==Examples==		==Examples==
	In the following example, a screenfield <code>%scrfmsg</code> set up to display an error message to the user is populated according to the user command input in screenfield <code>%scrfcmd</code>. The <var>[[$SirMsg]]</var> argument identifies the number of the line to be returned from a procedure designated by <var>[[$SirMsgP]]</var> (not shown).		In the following example, a screenfield <code>%scrfmsg</code> set up to display an error message to the user is populated according to the user command input in screenfield <code>%scrfcmd</code>. The <var>[[$SirMsg]]</var> argument identifies the number of the line to be returned from a procedure designated by <var>[[$SirMsgP]]</var> (not shown).
	<p class="code"> ...		<p class="code"> ...
	%scr is object screen		%scr is object screen
	%scrfmsg is object screenfield		%scrfmsg is object screenfield
	%scrfcmd is object screenfield		%scrfcmd is object screenfield
	%scrfmsg = %sscr:<var>addField</var>(row=3, column=1, -		%scrfmsg = %sscr:<var>addField</var>(row=3, column=1, -
	width=%scr:columns - 1, -		width=%scr:columns - 1, color=red)
	color=red)		...
	...		%scr:read
	%scr:read		if %scrfcmd:value = 'x' then
	if %scrfcmd:value = 'x' then		%msg = <var>$Sirmsg</var>(11)
	%msg = <var>$Sirmsg</var>(11)		if %scrfcmd:value = 'y' then
	if %scrfcmd:value = 'y' then		%msg = <var>$Sirmsg</var>(12)
	%msg = <var>$Sirmsg</var>(12)		...
	...		%scrfmsg:<var>value</var> = %msg
	%scrfmsg:<var>value</var> = %msg		...
	...
	</p>		</p>

JAL: /* See also */

2012-11-20T20:08:35Z

JALWiccan: 1 revision

2012-03-19T18:31:33Z

1 revision

← Older revision	Revision as of 18:31, 19 March 2012
(No difference)

JAL2: /* Syntax terms */

2012-03-19T18:31:33Z

Syntax terms

← Older revision		Revision as of 18:31, 19 March 2012
Line 1:		Line 1:
	{{Template:ScreenField:Value subtitle}}		{{Template:ScreenField:Value subtitle}}
	The <var>Value</var> property sets or returns the value of a <var>ScreenField</var>. The value is set from or copied to a User Language string, and it may be from 0-255 characters in length.		The <var>Value</var> property sets or returns the value of a <var>ScreenField</var>. The value is set from or copied to a <var class="product">User Language</var> string, and it may be from 0-255 characters in length.

	==Syntax==		==Syntax==

JAL2: /* Syntax terms */

2012-03-19T18:21:48Z

Syntax terms

← Older revision		Revision as of 18:21, 19 March 2012
Line 7:		Line 7:
	<table class="syntaxTable">		<table class="syntaxTable">
	<tr><th>%currentString</th>		<tr><th>%currentString</th>
	<td>A User Language string variable to contain the returned <var class="term">sfield</var> data.</td></tr>		<td>A <var class="product">User Language</var> string variable to contain the returned <var class="term">sfield</var> data.</td></tr>
	<tr><th>sfield</th>		<tr><th>sfield</th>
	<td>A reference to an instance of a <var>ScreenField</var> object. </td></tr>		<td>A reference to an instance of a <var>ScreenField</var> object. </td></tr>

JAL2: /* Usage notes */

2012-03-19T18:20:42Z

Usage notes

← Older revision		Revision as of 18:20, 19 March 2012
Line 15:		Line 15:

	==Usage notes==		==Usage notes==
	<ul><li>After <var>[[Read_(Screen_function)\|Read]]</var>~~ing~~ a <var>Screen</var> object, you use the <var>Value</var> method to get any user-entered data for a non-protected field.		<ul><li>After a <var>[[Read_(Screen_function)\|Read]]</var> of a <var>Screen</var> object, you use the <var>Value</var> method to get any user-entered data for a non-protected field.
	<li>For an example using <var>Value</var> to set field display data, see the [[Screen_object_sample_code\|"Screen object sample code"]].		<li>For an example using <var>Value</var> to set field display data, see the [[Screen_object_sample_code\|"Screen object sample code"]].
	<li>For an example using <var>Value</var> to get user-entered data, see the example below.		<li>For an example using <var>Value</var> to get user-entered data, see the example below.

JAL2: /* See also */

2012-03-19T18:19:44Z

JAL2: /* Examples */

2012-03-19T13:31:07Z

Examples

← Older revision		Revision as of 13:31, 19 March 2012
Line 21:		Line 21:

	==Examples==		==Examples==
	~~<ol><li>~~In the following example, a screenfield <code>%scrfmsg</code> set up to display an error message to the user is populated according to the user command input in screenfield <code>%scrfcmd</code>. The <var>[[$SirMsg]]</var> argument identifies the number of the line to be returned from a procedure designated by <var>[[$SirMsgP]]</var> (not shown).		In the following example, a screenfield <code>%scrfmsg</code> set up to display an error message to the user is populated according to the user command input in screenfield <code>%scrfcmd</code>. The <var>[[$SirMsg]]</var> argument identifies the number of the line to be returned from a procedure designated by <var>[[$SirMsgP]]</var> (not shown).
	<p class="code"> ...		<p class="code"> ...
	%scr is object screen		%scr is object screen
Line 39:		Line 39:
	...		...
	</p>		</p>
	~~</li>~~

	==See also==		==See also==

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

2011-07-01T06:13:26Z

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

← Older revision		Revision as of 06:13, 1 July 2011
Line 1:		Line 1:
	{{Template:ScreenField:Value subtitle}}		{{Template:ScreenField:Value subtitle}}
			The <var>Value</var> property sets or returns the value of a <var>ScreenField</var>. The value is set from or copied to a User Language string, and it may be from 0-255 characters in length.

	~~This property sets or returns the value of a ScreenField. The value is set from or copied to a User Language string, and it may be from 0-255 characters in length.~~
	==Syntax==		==Syntax==
	{{Template:ScreenField:Value syntax}}		{{Template:ScreenField:Value syntax}}
	===Syntax terms===		===Syntax terms===
	<table class="syntaxTable">		<table class="syntaxTable">
	<tr><th>%~~sfield~~</th>		<tr><th>%currentString</th>
	<td>A ~~reference~~ to ~~an instance of a ScreenField object~~. </td></tr>		<td>A User Language string variable to contain the returned <var class="term">sfield</var> data.</td></tr>
	<tr><th>~~newvalue~~</th>		<tr><th>sfield</th>
	<td>~~The string value~~ to ~~assign to %sfield~~. </td></tr>		<td>A reference to an instance of a <var>ScreenField</var> object. </td></tr>
	<tr><th>~~%string~~</th>		<tr><th>newString</th>
	<td>~~A User Language~~ string ~~variable~~ to ~~contain the returned %~~sfield ~~data~~.</td></tr>		<td>The string value to assign to <var class="term">sfield</var>. </td></tr>
	</table>		</table>

	==Usage notes==		==Usage notes==
			<ul><li>After <var>[[Read_(Screen_function)\|Read]]</var>ing a <var>Screen</var> object, you use the <var>Value</var> method to get any user-entered data for a non-protected field.
			<li>For an example using <var>Value</var> to set field display data, see the [[Screen_object_sample_code\|"Screen object sample code"]].
			<li>For an example using <var>Value</var> to get user-entered data, see the example below.
			</ul>

	~~After~~ a ~~Read method~~ (~~&#x201C;Read function&#x201D; on page 904~~) ~~on the Screen~~ object, ~~you use the Value method to get any user~~-~~entered data for a non~~-~~protected field~~.		==Examples==
			<ol><li>In the following example, a screenfield <code>%scrfmsg</code> set up to display an error message to the user is populated according to the user command input in screenfield <code>%scrfcmd</code>. The <var>[[$SirMsg]]</var> argument identifies the number of the line to be returned from a procedure designated by <var>[[$SirMsgP]]</var> (not shown).
			<p class="code"> ...
			%scr is object screen
			%scrfmsg is object screenfield
			%scrfcmd is object screenfield
			%scrfmsg = %sscr:<var>addField</var>(row=3, column=1, -
			width=%scr:columns - 1, -
			color=red)
			...
			%scr:read
			if %scrfcmd:value = 'x' then
			%msg = <var>$Sirmsg</var>(11)
			if %scrfcmd:value = 'y' then
			%msg = <var>$Sirmsg</var>(12)
			...
			%scrfmsg:<var>value</var> = %msg
			...
			</p>
			</li>

	~~For an example using Value to set field display data, see &#x201C;[[Screen class example]]&#x201D;. For an example using Value to get user-entered data, see the example below.~~

	~~See also the [[Screen class#AddField function\|AddField method]], whose Value parameter can set display data when the ScreenField is instantiated.~~
	==See also==		==See also==
			<ul><li>The <var>[[Screen class#AddField function\|AddField]]</var>, whose <var class="term">Value</var> parameter can set display data when the <var>ScreenField</var> is instantiated.
			</ul>
	{{Template:ScreenField:Value footer}}		{{Template:ScreenField:Value footer}}

TomWiccan: 1 revision

2011-03-18T20:32:05Z

1 revision

← Older revision		Revision as of 20:32, 18 March 2011
Line 5:		Line 5:
	{{Template:ScreenField:Value syntax}}		{{Template:ScreenField:Value syntax}}
	===Syntax terms===		===Syntax terms===
	<dl>		<table class="syntaxTable">
	<dt>%sfield		<tr><th>%sfield</th>
	<dd>A reference to an instance of a ScreenField object.		<td>A reference to an instance of a ScreenField object. </td></tr>
	<dt>newvalue		<tr><th>newvalue</th>
	<dd>The string value to assign to %sfield.		<td>The string value to assign to %sfield. </td></tr>
	<dt>%string		<tr><th>%string</th>
	<dd>A User Language string variable to contain the returned %sfield data.		<td>A User Language string variable to contain the returned %sfield data.</td></tr>
	</dl>		</table>

	==Usage notes==		==Usage notes==

	After a Read method (“Read function” on page 904) on the Screen object, you use the Value method to get any user-entered data for a non-protected field.		After a Read method (&#x201C;Read function&#x201D; on page 904) on the Screen object, you use the Value method to get any user-entered data for a non-protected field.

	For an example using Value to set field display data, see “[[Screen class example]]”. For an example using Value to get user-entered data, see the example below.		For an example using Value to set field display data, see &#x201C;[[Screen class example]]&#x201D;. For an example using Value to get user-entered data, see the example below.

	See also the [[Screen class#AddField function\|AddField method]], whose Value parameter can set display data when the ScreenField is instantiated.		See also the [[Screen class#AddField function\|AddField method]], whose Value parameter can set display data when the ScreenField is instantiated.
	==See also==		==See also==
	{{Template:ScreenField:Value footer}}		{{Template:ScreenField:Value footer}}

← Older revision		Revision as of 20:08, 20 November 2012
Line 41:		Line 41:

	==See also==		==See also==
	<ul><li>The <var>[[Screen class#AddField function\|AddField]]</var> method~~, whose~~ <var>Value</var> parameter can set display data when the <var>ScreenField</var> is instantiated.		<ul>
			<li>The <var>[[Screen class#AddField function\|AddField]]</var> method's <var>Value</var> parameter can set display data when the <var>ScreenField</var> is instantiated.
	</ul>		</ul>
	{{Template:ScreenField:Value footer}}		{{Template:ScreenField:Value footer}}

← Older revision		Revision as of 18:19, 19 March 2012
Line 41:		Line 41:

	==See also==		==See also==
	<ul><li>The <var>[[Screen class#AddField function\|AddField]]</var>, whose <var ~~class="term"~~>Value</var> parameter can set display data when the <var>ScreenField</var> is instantiated.		<ul><li>The <var>[[Screen class#AddField function\|AddField]]</var> method, whose <var>Value</var> parameter can set display data when the <var>ScreenField</var> is instantiated.
	</ul>		</ul>
	{{Template:ScreenField:Value footer}}		{{Template:ScreenField:Value footer}}