AddField (Screen function) - Revision history

Dme: /* Usage notes */

2014-07-24T21:37:53Z

Usage notes

← Older revision		Revision as of 21:37, 24 July 2014
Line 87:		Line 87:
	==Usage notes==		==Usage notes==
	<ul>		<ul>
	<li>Each of the ~~screenfield~~ attributes specified by the <var>AddField</var> optional parameters ~~can be updated by their~~ like-named [[List of ScreenField methods\|ScreenField ~~methods~~]]. The ~~"modified"~~ and ~~"value" attributes~~ are also set by a user screen-interaction.		<li>Each of the screen field attributes specified by the <var>AddField</var> optional parameters corresponds to a like-named <var>[[List of ScreenField methods\|ScreenField]]</var> property.
			<li>Some of those <var>ScreenField</var> properties, such as <var>[[Row (ScreenField property)\|Row]]</var>, may not be modified, but others, such as <var>[[Invisible (ScreenField property)\|Invisible]]</var>, may be modified.
			<li>The values of the <var>[[Modified (ScreenField property)\|Modified]]</var> and <var>[[Value (ScreenField property)\|Value]]</var> properties are also set by a user screen-interaction.
	</ul>		</ul>

JAL: /* Syntax terms */

2013-06-11T22:10:37Z

Syntax terms

Show changes

JAL: /* Usage notes */

2012-11-19T17:05:17Z

Usage notes

← Older revision		Revision as of 17:05, 19 November 2012
Line 67:		Line 67:
	<li>Each of the screenfield attributes specified by the <var>AddField</var> optional parameters can be updated by their like-named [[List of ScreenField methods\|ScreenField methods]]. The "modified" and "value" attributes are also set by a user screen-interaction.		<li>Each of the screenfield attributes specified by the <var>AddField</var> optional parameters can be updated by their like-named [[List of ScreenField methods\|ScreenField methods]]. The "modified" and "value" attributes are also set by a user screen-interaction.
	</ul>		</ul>

			==Examples==
			For an example using the <var>AddField</var> method, see [[Screen object sample code\|"Screen object sample code"]].

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

JAL at 22:30, 16 November 2012

2012-11-16T22:30:36Z

← Older revision		Revision as of 22:30, 16 November 2012
Line 10:		Line 10:
	<table class="syntaxTable">		<table class="syntaxTable">

	<tr><th>%~~field~~</th>		<tr><th>%sfield</th>
	<td>A declared <var>ScreenField</var> object that is set to a new <var>ScreenField</var> object reference. </td></tr>		<td>A declared <var>ScreenField</var> object that is set to a new <var>ScreenField</var> object reference. </td></tr>

Tom at 22:48, 1 November 2012

2012-11-01T22:48:20Z

← Older revision		Revision as of 22:48, 1 November 2012
Line 54:		Line 54:

	<tr><th><var>AutoSkip</var></th>		<tr><th><var>AutoSkip</var></th>
	<td><var>AutoSkip</var> is an optional, but name required, <var>Boolean</var> enumeration value that indicates whether the cursor should automatically skip to the next input field when a character is entered in the last position of the current <var>ScreenField</var>. <code>True</code> indicates the cursor will <var>AutoSkip</var>. This is the default. <code>False</code> indicates the cursor will not <var>AutoSkip</var>.~~</p>~~</td></tr>		<td><var>AutoSkip</var> is an optional, but name required, <var>Boolean</var> enumeration value that indicates whether the cursor should automatically skip to the next input field when a character is entered in the last position of the current <var>ScreenField</var>. <code>True</code> indicates the cursor will <var>AutoSkip</var>. This is the default. <code>False</code> indicates the cursor will not <var>AutoSkip</var>.</td></tr>

	<tr><th><var>Itemid</var></th>		<tr><th><var>Itemid</var></th>

Tom at 22:46, 1 November 2012

2012-11-01T22:46:55Z

← Older revision		Revision as of 22:46, 1 November 2012
Line 54:		Line 54:

	<tr><th><var>AutoSkip</var></th>		<tr><th><var>AutoSkip</var></th>
	<td><var>AutoSkip</var> is an optional, but name required, <var>Boolean</var> enumeration value that indicates whether the cursor should automatically skip to the next input field when a character is entered in the last position of the current <var>ScreenField</var>. <code>True</code> indicates the cursor will <var>AutoSkip</var>. This is the default. <code>False</code> indicates the cursor will not <var>AutoSkip</var>.</p~~><td~~></td></tr>		<td><var>AutoSkip</var> is an optional, but name required, <var>Boolean</var> enumeration value that indicates whether the cursor should automatically skip to the next input field when a character is entered in the last position of the current <var>ScreenField</var>. <code>True</code> indicates the cursor will <var>AutoSkip</var>. This is the default. <code>False</code> indicates the cursor will not <var>AutoSkip</var>.</p></td></tr>

	<tr><th><var>Itemid</var></th>		<tr><th><var>Itemid</var></th>

Tom at 22:45, 1 November 2012

2012-11-01T22:45:47Z

← Older revision		Revision as of 22:45, 1 November 2012
Line 54:		Line 54:

	<tr><th><var>AutoSkip</var></th>		<tr><th><var>AutoSkip</var></th>
	<td></td></tr>		<td><var>AutoSkip</var> is an optional, but name required, <var>Boolean</var> enumeration value that indicates whether the cursor should automatically skip to the next input field when a character is entered in the last position of the current <var>ScreenField</var>. <code>True</code> indicates the cursor will <var>AutoSkip</var>. This is the default. <code>False</code> indicates the cursor will not <var>AutoSkip</var>.</p><td></td></tr>

	<tr><th><var>Itemid</var></th>		<tr><th><var>Itemid</var></th>

JAL at 00:24, 1 November 2012

2012-11-01T00:24:26Z

Show changes

JAL2: /* Syntax terms */

2012-08-07T19:32:54Z

Syntax terms

← Older revision		Revision as of 19:32, 7 August 2012
Line 16:		Line 16:
	<tr><th>Row</th>		<tr><th>Row</th>

	<td><var>Row</var> is an optional, but <var>[[Methods#Named parameters\|Name-Required]]</var>, <var class="term">number</var> indicating the starting row number for the field. The first row in a screen is row 1, and the last can be determined with the <var>Rows</var> method.<p>Any row number in the screen may be used for a field. No rows are reserved by <var class="product">[[Janus SOAP~~\|"Janus Soap"~~]]</var>. A field may occupy more than one row.</p><p>The first position in any field is reserved for an attribute byte, which cannot contain displayable data and appears on a screen as a blank. A field's display data begins by default in the column immediately following the reserved byte.</p><p>The <var>Row</var> default value is 1 or the value specified or implied by the previous <var>AddField</var> call.</p></td></tr>		<td><var>Row</var> is an optional, but <var>[[Methods#Named parameters\|Name-Required]]</var>, <var class="term">number</var> indicating the starting row number for the field. The first row in a screen is row 1, and the last can be determined with the <var>Rows</var> method.<p>Any row number in the screen may be used for a field. No rows are reserved by <var class="product">[[Janus SOAP]]</var>. A field may occupy more than one row.</p><p>The first position in any field is reserved for an attribute byte, which cannot contain displayable data and appears on a screen as a blank. A field's display data begins by default in the column immediately following the reserved byte.</p><p>The <var>Row</var> default value is 1 or the value specified or implied by the previous <var>AddField</var> call.</p></td></tr>

	<tr><th>Column</th>		<tr><th>Column</th>

JAL2 at 19:31, 7 August 2012

2012-08-07T19:31:38Z

← Older revision		Revision as of 19:31, 7 August 2012
Line 22:		Line 22:

	<tr><th>Width</th>		<tr><th>Width</th>
	<td><var>Width</var> is an optional, but <var>Name-Required</var>, <var class="term">number</var> indicating the length of the screen field, excluding the attribute byte. The first position in any field is occupied by an attribute byte, which cannot contain user data. The minimum width for a field is <code>1</code>, and the maximum width is <code>255</code>.<p>If no width is specified, the width of the field is determined by the length of the string specified in the method's <var ~~class="term"~~>Value</var> parameter. If neither a <var>Width</var> nor a <var ~~class="term"~~>Value</var> parameter is specified, the request is cancelled. If both <var>Width</var> and <var ~~class="term"~~>Value</var> parameters are specified, the <var>Width</var> parameter is used to set the field width, and the <var ~~class="term"~~>Value</var> is silently padded or truncated accordingly.</p></td></tr>		<td><var>Width</var> is an optional, but <var>Name-Required</var>, <var class="term">number</var> indicating the length of the screen field, excluding the attribute byte. The first position in any field is occupied by an attribute byte, which cannot contain user data. The minimum width for a field is <code>1</code>, and the maximum width is <code>255</code>.<p>If no width is specified, the width of the field is determined by the length of the string specified in the method's <var>Value</var> parameter. If neither a <var>Width</var> nor a <var>Value</var> parameter is specified, the request is cancelled. If both <var>Width</var> and <var>Value</var> parameters are specified, the <var>Width</var> parameter is used to set the field width, and the <var>Value</var> is silently padded or truncated accordingly.</p></td></tr>

	<tr><th>Color</th>		<tr><th>Color</th>
	<td><var>Color</var> is an optional, but <var>Name-Required</var>, <var ~~class="term"~~>[[Color_(ScreenField_property)#FieldColor_enumeration\|Fieldcolor ~~enumeration~~]]</var> value. Valid values (case unimportant) are <code>turquoise</code>, <code>green</code>, <code>blue</code>, <code>red</code>, <code>white</code>, <code>yellow</code>, and <code>pink</code>. The default is <code>blue</code>.<p>This parameter explicitly sets the color for a screen field. The <var>[[Color_(ScreenField_property)\|Color]]</var> method lets you reset it.</p><p>You can use the <var class="term">[[ProtectedColor_(Screen_property)\|ProtectedColor]]</var> and <var class="term">[[UnprotectedColor_(Screen_property)\|UnprotectedColor]]</var> methods to set defaults for a screen's protected and unprotected fields, respectively.</p></td></tr>		<td><var>Color</var> is an optional, but <var>Name-Required</var>, <var>[[Color_(ScreenField_property)#FieldColor_enumeration\|Fieldcolor]]</var> enumeration value. Valid values (case unimportant) are <code>turquoise</code>, <code>green</code>, <code>blue</code>, <code>red</code>, <code>white</code>, <code>yellow</code>, and <code>pink</code>. The default is <code>blue</code>.<p>This parameter explicitly sets the color for a screen field. The <var>[[Color_(ScreenField_property)\|Color]]</var> method lets you reset it.</p><p>You can use the <var class="term">[[ProtectedColor_(Screen_property)\|ProtectedColor]]</var> and <var class="term">[[UnprotectedColor_(Screen_property)\|UnprotectedColor]]</var> methods to set defaults for a screen's protected and unprotected fields, respectively.</p></td></tr>

	<tr><th>Protected</th>		<tr><th>Protected</th>
Line 34:		Line 34:

	<tr><th>Numeric</th>		<tr><th>Numeric</th>
	<td><var>Numeric</var> is an optional, but <var>Name-Required</var>, <var ~~class="term"~~>Boolean enumeration</var> value. If <code>True</code>, and the field is not protected, only numeric values may be entered in the field; numeric values must be composed of the characters <code>0</code> through <code>9</code>, plus (<code>+</code>), minus (<code>-</code>), and period (<code>.</code>).<p>If <code>False</code> (the default), field input is not restricted to numeric data. The <var>[[Numeric_(ScreenField_property)\|Numeric]]</var> property lets you reset the value.</p><p>Regardless of the value of the <var>Numeric</var> attribute, the programmer can assign any type of value to the field. Enforcement of the <var>Numeric</var> attribute takes place only when a user enters data in the field.</p><p>Some terminal emulators do not enforce numeric field restrictions, so the programmer should be aware that the value of a numeric field must still be checked for validity.</p></td></tr>		<td><var>Numeric</var> is an optional, but <var>Name-Required</var>, <var>[[Boolean enumeration]]</var> value. If <code>True</code>, and the field is not protected, only numeric values may be entered in the field; numeric values must be composed of the characters <code>0</code> through <code>9</code>, plus (<code>+</code>), minus (<code>-</code>), and period (<code>.</code>).<p>If <code>False</code> (the default), field input is not restricted to numeric data. The <var>[[Numeric_(ScreenField_property)\|Numeric]]</var> property lets you reset the value.</p><p>Regardless of the value of the <var>Numeric</var> attribute, the programmer can assign any type of value to the field. Enforcement of the <var>Numeric</var> attribute takes place only when a user enters data in the field.</p><p>Some terminal emulators do not enforce numeric field restrictions, so the programmer should be aware that the value of a numeric field must still be checked for validity.</p></td></tr>
	<tr><th>Modified</th>		<tr><th>Modified</th>

	<td><var>Modified</var> is an optional, but <var>Name-Required</var>, <var ~~class="term"~~>Boolean ~~enumeration~~</var> value that indicates whether a <var>ScreenField</var> value has been modified by the user. <code>True</code> indicates the <var>ScreenField</var> has been modified by the user. The default, <code>False</code>, indicates the <var>ScreenField</var> has not been modified.<p>Regardless of the initial setting of this argument, the value of the <var>Modified</var> property for a field is always set by the <var>[[Read_(Screen_function)\|Read]]</var> method.</p></td></tr>		<td><var>Modified</var> is an optional, but <var>Name-Required</var>, <var>Boolean</var> enumeration value that indicates whether a <var>ScreenField</var> value has been modified by the user. <code>True</code> indicates the <var>ScreenField</var> has been modified by the user. The default, <code>False</code>, indicates the <var>ScreenField</var> has not been modified.<p>Regardless of the initial setting of this argument, the value of the <var>Modified</var> property for a field is always set by the <var>[[Read_(Screen_function)\|Read]]</var> method.</p></td></tr>
	<tr><th>Invisible</th>		<tr><th>Invisible</th>

	<td><var>Invisible</var> is an optional, but <var>Name-Required</var>, <var ~~class="term"~~>Boolean ~~enumeration~~</var> value. If <code>True</code>, any data in the field will not displayed on the terminal. If <code>False</code> (the default), the screen field data is displayed on the terminal.<p>The <var>[[Invisible_(ScreenField_property)\|Invisible]]</var> property lets you reset the value. The invisible attribute can be applied to protected or nonprotected fields. It is typically used to hide password prompts or other private data, but it does not encrypt or suppress transmission of data over the network. It is intended to minimize theft of private data at terminals situated in non-private areas.</p></td></tr>		<td><var>Invisible</var> is an optional, but <var>Name-Required</var>, <var>Boolean</var> enumeration value. If <code>True</code>, any data in the field will not displayed on the terminal. If <code>False</code> (the default), the screen field data is displayed on the terminal.<p>The <var>[[Invisible_(ScreenField_property)\|Invisible]]</var> property lets you reset the value. The invisible attribute can be applied to protected or nonprotected fields. It is typically used to hide password prompts or other private data, but it does not encrypt or suppress transmission of data over the network. It is intended to minimize theft of private data at terminals situated in non-private areas.</p></td></tr>

	<tr><th>AutoSkip</th>		<tr><th>AutoSkip</th>