m204wiki - User contributions [en]

Width (ScreenField property)

2011-03-18T20:33:47Z

TomWiccan: 1 revision

{{Template:ScreenField:Width subtitle}}

This read-only property returns the width of a screenfield. A Screenfield width is set by the [[Screen class#AddField function|AddField method]].
==Syntax==
{{Template:ScreenField:Width syntax}}
===Syntax terms===
<table class="syntaxTable">
<tr><th>%num</th>
<td>A User Language numeric variable to contain the returned field width. </td></tr>
<tr><th>%sfield</th>
<td>A reference to an instance of a ScreenField object.</td></tr>
</table>
==See also==
{{Template:ScreenField:Width footer}}

Width (ScreenField property)

2011-03-18T20:33:46Z

TomWiccan: 1 revision

Width (ScreenField property)

2011-03-18T20:33:43Z

TomWiccan: 1 revision

{{Template:ScreenField:Width subtitle}}

This read-only property returns the width of a screenfield. A Screenfield width is set by the [[Screen class#AddField function|AddField method]].
==Syntax==
{{Template:ScreenField:Width syntax}}
===Syntax terms===
<dl>
<dt>%num
<dd>A User Language numeric variable to contain the returned field width.
<dt>%sfield
<dd>A reference to an instance of a ScreenField object.
</dl>
==See also==
{{Template:ScreenField:Width footer}}

Value (ScreenField property)

2011-03-18T20:32:05Z

TomWiccan: 1 revision

{{Template:ScreenField:Value subtitle}}

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==
{{Template:ScreenField:Value syntax}}
===Syntax terms===
<table class="syntaxTable">
<tr><th>%sfield</th>
<td>A reference to an instance of a ScreenField object. </td></tr>
<tr><th>newvalue</th>
<td>The string value to assign to %sfield. </td></tr>
<tr><th>%string</th>
<td>A User Language string variable to contain the returned %sfield data.</td></tr>
</table>

==Usage notes==

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 &#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==
{{Template:ScreenField:Value footer}}

Value (ScreenField property)

2011-03-18T20:32:01Z

TomWiccan: 1 revision

{{Template:ScreenField:Value subtitle}}

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==
{{Template:ScreenField:Value syntax}}
===Syntax terms===
<dl>
<dt>%sfield
<dd>A reference to an instance of a ScreenField object.
<dt>newvalue
<dd>The string value to assign to %sfield.
<dt>%string
<dd>A User Language string variable to contain the returned %sfield data.
</dl>

==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.

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.

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

SetCursor (ScreenField subroutine)

2011-03-18T20:30:09Z

TomWiccan: 1 revision

{{Template:ScreenField:SetCursor subtitle}}

This method positions the cursor at the beginning of the referenced ScreenField object. An optional numeric argument positions the cursor within the field.

==Syntax==
{{Template:ScreenField:SetCursor syntax}}
===Syntax terms===
<table class="syntaxTable">
<tr><th>%sfield</th>
<td>A reference to an instance of a ScreenField object. position A positive integral value that specifies the relative position within the object screenfield %sfield, where position 1 is the first position in the field and where the maximum width is set by the [[Screen class#AddField function|AddField method]].</td></tr>
</table>

==Usage notes==

If the position exceeds the maximum width of the field, the request is canceled.

==Examples==

The following sequence sets the cursor on an unprotected screenfield immediately to the right of a field with a protected &#x201C;===>&#x201D; command prompt:

...
%scr is object Screen
%prompt is object ScreenField
%cmd is object ScreenField
%prompt = %scr:addField(row=2, color=white, -
value='===>')
==See also==
{{Template:ScreenField:SetCursor footer}}

SetCursor (ScreenField subroutine)

2011-03-18T20:29:36Z

TomWiccan: 1 revision

{{Template:ScreenField:SetCursor subtitle}}

This method positions the cursor at the beginning of the referenced ScreenField object. An optional numeric argument positions the cursor within the field.

==Syntax==
{{Template:ScreenField:SetCursor syntax}}
===Syntax terms===
<dl>%sfield
<dd>A reference to an instance of a ScreenField object. position A positive integral value that specifies the relative position within the object screenfield %sfield, where position 1 is the first position in the field and where the maximum width is set by the [[Screen class#AddField function|AddField method]].
</dl>

==Usage notes==

If the position exceeds the maximum width of the field, the request is canceled.

==Examples==

The following sequence sets the cursor on an unprotected screenfield immediately to the right of a field with a protected “===>” command prompt:

...
%scr is object Screen
%prompt is object ScreenField
%cmd is object ScreenField
%prompt = %scr:addField(row=2, color=white, -
value='===>')
==See also==
{{Template:ScreenField:SetCursor footer}}

Screen (ScreenField function)

2011-03-18T20:27:53Z

TomWiccan: 1 revision

{{Template:ScreenField:Screen subtitle}}

This method returns the Screen object that contains the method object.
==Syntax==
{{Template:ScreenField:Screen syntax}}
===Syntax terms===
<table class="syntaxTable">
<tr><th>%screen</th>
<td>A declared Screen object. </td></tr>
<tr><th>%sfield</th>
<td>A reference to an instance of a ScreenField object.</td></tr>
</table>
==See also==
{{Template:ScreenField:Screen footer}}

Screen (ScreenField function)

2011-03-18T20:27:52Z

TomWiccan: 1 revision

Screen (ScreenField function)

2011-03-18T20:27:50Z

TomWiccan: 1 revision

{{Template:ScreenField:Screen subtitle}}

This method returns the Screen object that contains the method object.
==Syntax==
{{Template:ScreenField:Screen syntax}}
===Syntax terms===
<dl>
<dt>%screen
<dd>A declared Screen object.
<dt>%sfield
<dd>A reference to an instance of a ScreenField object.
</dl>
==See also==
{{Template:ScreenField:Screen footer}}

Row (ScreenField property)

2011-03-18T20:26:39Z

TomWiccan: 1 revision

{{Template:ScreenField:Row subtitle}}

This read-only property returns the row number of a screenfield. The row number is initially set for a field by the [[Screen class#AddField function|AddField method]].
==Syntax==
{{Template:ScreenField:Row syntax}}
===Syntax terms===
<table class="syntaxTable">
<tr><th>num</th>
<td>A User Language numeric variable to contain the returned row number. </td></tr>
<tr><th>%sfield</th>
<td>A reference to an instance of a ScreenField object.</td></tr>
</table>

==Usage notes==

The first row in a screen is row 1.

If a screenfield occupies more than one row, the number of the first row is returned.
==See also==
{{Template:ScreenField:Row footer}}

Row (ScreenField property)

2011-03-18T20:26:38Z

TomWiccan: 1 revision

Row (ScreenField property)

2011-03-18T20:26:35Z

TomWiccan: 1 revision

{{Template:ScreenField:Row subtitle}}

This read-only property returns the row number of a screenfield. The row number is initially set for a field by the [[Screen class#AddField function|AddField method]].
==Syntax==
{{Template:ScreenField:Row syntax}}
===Syntax terms===
<dl>
<dt>num
<dd>A User Language numeric variable to contain the returned row number.
<dt>%sfield
<dd>A reference to an instance of a ScreenField object.
</dl>

==Usage notes==

The first row in a screen is row 1.

If a screenfield occupies more than one row, the number of the first row is returned.
==See also==
{{Template:ScreenField:Row footer}}

Protected (ScreenField property)

2011-03-18T20:25:27Z

TomWiccan: 1 revision

{{Template:ScreenField:Protected subtitle}}

This property sets or returns the Protected attribute for a ScreenField. A protected field does not allow user input, and is used for display only. Unprotected fields are used for user input. The Protected attribute is initially set for a field by the [[Screen class#AddField function|AddField method]].
==Syntax==
{{Template:ScreenField:Protected syntax}}
===Syntax terms===
<table class="syntaxTable">
<tr><th>%sfield</th>
<td>A reference to an instance of a ScreenField object. </td></tr>
<tr><th>bool</th>
<td>A Boolean enumeration that indicates whether the field is protected. Valid values are True (default) and False.</td></tr>
</table>
==See also==
{{Template:ScreenField:Protected footer}}

Protected (ScreenField property)

2011-03-18T20:25:26Z

TomWiccan: 1 revision

Protected (ScreenField property)

2011-03-18T20:25:23Z

TomWiccan: 1 revision

{{Template:ScreenField:Protected subtitle}}

This property sets or returns the Protected attribute for a ScreenField. A protected field does not allow user input, and is used for display only. Unprotected fields are used for user input. The Protected attribute is initially set for a field by the [[Screen class#AddField function|AddField method]].
==Syntax==
{{Template:ScreenField:Protected syntax}}
===Syntax terms===
<dl>
<dt>%sfield
<dd>A reference to an instance of a ScreenField object.
<dt>bool
<dd>A Boolean enumeration that indicates whether the field is protected. Valid values are True (default) and False.
</dl>
==See also==
{{Template:ScreenField:Protected footer}}

Numeric (ScreenField property)

2011-03-18T20:24:15Z

TomWiccan: 1 revision

{{Template:ScreenField:Numeric subtitle}}

This property sets or returns the Numeric attribute for a ScreenField. If a field is Numeric, only numeric values may be entered in the field. The Numeric attribute is
initially set for a field by the [[Screen class#AddField function|AddField method]].
==Syntax==
{{Template:ScreenField:Numeric syntax}}
===Syntax terms===
<table class="syntaxTable">
<tr><th>bool</th>
<td>A Boolean enumeration. Valid values are True (default) and False. A value is numeric only if it is composed of the characters 0 through 9, plus (+), minus (-), or period (.). </td></tr>
<tr><th>%sfield</th>
<td>A reference to an instance of a ScreenField object.</td></tr>
</table>

==Usage notes==

Regardless of the value of a field's Numeric attribute, the programmer can assign any type of value to the field. Enforcement of the Numeric attribute takes place only when a user enters data in the field. 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.
==See also==
{{Template:ScreenField:Numeric footer}}

Numeric (ScreenField property)

2011-03-18T20:24:14Z

TomWiccan: 1 revision

Numeric (ScreenField property)

2011-03-18T20:24:10Z

TomWiccan: 1 revision

{{Template:ScreenField:Numeric subtitle}}

This property sets or returns the Numeric attribute for a ScreenField. If a field is Numeric, only numeric values may be entered in the field. The Numeric attribute is
initially set for a field by the [[Screen class#AddField function|AddField method]].
==Syntax==
{{Template:ScreenField:Numeric syntax}}
===Syntax terms===
<dl>
<dt>bool
<dd>A Boolean enumeration. Valid values are True (default) and False. A value is numeric only if it is composed of the characters 0 through 9, plus (+), minus (-), or period (.).
<dt>%sfield
<dd>A reference to an instance of a ScreenField object.
</dl>

==Usage notes==

Regardless of the value of a field's Numeric attribute, the programmer can assign any type of value to the field. Enforcement of the Numeric attribute takes place only when a user enters data in the field. 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.
==See also==
{{Template:ScreenField:Numeric footer}}

Modified (ScreenField property)

2011-03-18T20:22:35Z

TomWiccan: 1 revision

{{Template:ScreenField:Modified subtitle}}

This property sets or returns the Modified attribute for a ScreenField. The Modified attribute is initially set for a field by the [[Screen class#AddField function|AddField method]], and is always reset by the [[Screen class#Read function|Read method]].
==Syntax==
{{Template:ScreenField:Modified syntax}}
===Syntax terms===
<table class="syntaxTable">
<tr><th>bool</th>
<td>A Boolean enumeration. Valid values are True and False (default). </td></tr>
<tr><th>%sfield</th>
<td>A reference to an instance of a ScreenField object.</td></tr>
</table>
==See also==
{{Template:ScreenField:Modified footer}}

Modified (ScreenField property)

2011-03-18T20:22:31Z

TomWiccan: 1 revision

{{Template:ScreenField:Modified subtitle}}

This property sets or returns the Modified attribute for a ScreenField. The Modified attribute is initially set for a field by the [[Screen class#AddField function|AddField method]], and is always reset by the [[Screen class#Read function|Read method]].
==Syntax==
{{Template:ScreenField:Modified syntax}}
===Syntax terms===
<dl>
<dt>bool
<dd>A Boolean enumeration. Valid values are True and False (default).
<dt>%sfield
<dd>A reference to an instance of a ScreenField object.
</dl>
==See also==
{{Template:ScreenField:Modified footer}}

Itemid (ScreenField property)

2011-03-18T20:21:26Z

TomWiccan: 1 revision

{{Template:ScreenField:Itemid subtitle}}

This property sets or returns a numeric item ID value for a ScreenField. This ID is initially set for a field by the [[Screen class#AddField function|AddField method]].
==Syntax==
{{Template:ScreenField:Itemid syntax}}
===Syntax terms===
<table class="syntaxTable">
<tr><th>num</th>
<td>An integral numeric variable or expression, which can range from 1 to 32767. </td></tr>
<tr><th>%sfield</th>
<td>A reference to an instance of a ScreenField object.</td></tr>
</table>

==Usage notes==

Any screenfield can be assigned an item ID.

An item ID is very practical when using arraylists of screenfields. ScreenField objects within an arraylist can be assigned item IDs corresponding to the element numbers of the arraylist. For example, the [[Screen class#CursorItemId|Screen method CursorItemId]] will return the item ID of the screenField object where the cursor is positioned. The item ID can then be used as the element number to reference a ScreenField object within an arraylist.

Any screenField not assigned an item ID value will return zero. No check is made to ensure any item Id is unique. This is the programmer's responsibility.
==See also==
{{Template:ScreenField:Itemid footer}}

Itemid (ScreenField property)

2011-03-18T20:21:20Z

TomWiccan: 1 revision

{{Template:ScreenField:Itemid subtitle}}

This property sets or returns a numeric item ID value for a ScreenField. This ID is initially set for a field by the [[Screen class#AddField function|AddField method]].
==Syntax==
{{Template:ScreenField:Itemid syntax}}
===Syntax terms===
<dl>
<dt>num
<dd>An integral numeric variable or expression, which can range from 1 to 32767.
<dt>%sfield
<dd>A reference to an instance of a ScreenField object.
</dl>

==Usage notes==

Any screenfield can be assigned an item ID.

An item ID is very practical when using arraylists of screenfields. ScreenField objects within an arraylist can be assigned item IDs corresponding to the element numbers of the arraylist. For example, the [[Screen class#CursorItemId|Screen method CursorItemId]] will return the item ID of the screenField object where the cursor is positioned. The item ID can then be used as the element number to reference a ScreenField object within an arraylist.

Any screenField not assigned an item ID value will return zero. No check is made to ensure any item Id is unique. This is the programmer's responsibility.
==See also==
{{Template:ScreenField:Itemid footer}}

Invisible (ScreenField property)

2011-03-18T20:20:10Z

TomWiccan: 1 revision

{{Template:ScreenField:Invisible subtitle}}

This property sets or gets the Invisible attribute for a ScreenField. If this value is True, any data in the field will not be displayed on the terminal. This is typically used for password prompts or other private data. This attribute is initially set for a field by the [[Screen class#AddField function|AddField method]]). If False, the screenfield data is displayed on the terminal.

==Syntax==
{{Template:ScreenField:Invisible syntax}}
===Syntax terms===
<table class="syntaxTable">
<tr><th>bool</th>
<td>A Boolean enumeration. Valid values are True and False (the default). </td></tr>
<tr><th>%sfield</th>
<td>A reference to an instance of a ScreenField object.</td></tr>
</table>

==Usage notes==

The Invisible attribute does not encrypt or suppress transmission of data over the
network. It is intended to minimize theft of private data at terminals situated in nonprivate
areas.

The Invisible attribute can be applied to protected or to non-protected fields.
==See also==
{{Template:ScreenField:Invisible footer}}

Invisible (ScreenField property)

2011-03-18T20:20:06Z

TomWiccan: 1 revision

{{Template:ScreenField:Invisible subtitle}}

This property sets or gets the Invisible attribute for a ScreenField. If this value is True, any data in the field will not be displayed on the terminal. This is typically used for password prompts or other private data. This attribute is initially set for a field by the [[Screen class#AddField function|AddField method]]). If False, the screenfield data is displayed on the terminal.

==Syntax==
{{Template:ScreenField:Invisible syntax}}
===Syntax terms===
<dl>
<dt>bool
<dd>A Boolean enumeration. Valid values are True and False (the default).
<dt>%sfield
<dd>A reference to an instance of a ScreenField object.
</dl>

==Usage notes==

The Invisible attribute does not encrypt or suppress transmission of data over the
network. It is intended to minimize theft of private data at terminals situated in nonprivate
areas.

The Invisible attribute can be applied to protected or to non-protected fields.
==See also==
{{Template:ScreenField:Invisible footer}}

Highlight (ScreenField property)

2011-03-18T20:18:41Z

TomWiccan: 1 revision

{{Template:ScreenField:Highlight subtitle}}

This property sets or returns the value of the highlight for a ScreenField. This value is a ScreenField class enumeration. This attribute is initially set for a field by the [[Screen class#AddField function|AddField method]].
==Syntax==
{{Template:ScreenField:Highlight syntax}}
===Syntax terms===
<table class="syntaxTable">
<tr><th>value</th>
<td>An enumeration of type Highlight. Valid values are none, underline, reverse, and blink. The default value is none. </td></tr>
<tr><th>%sfield</th>
<td>A reference to an instance of a ScreenField object.</td></tr>
</table>

==Usage notes==

The Highlight method lets you set highlights regardless of the actual terminal type, although some terminals may not display these attributes correctly. Also, many terminal emulator programs allow local customization of highlighting attributes. Under either of these conditions, which are not detectable by the Screen methods, the actual display may not show the intended highlighting.

For an example using Highlight method calls, see &#x201C;[[Screen class example]]&#x201D;.
==See also==
{{Template:ScreenField:Highlight footer}}

Highlight (ScreenField property)

2011-03-18T20:18:40Z

TomWiccan: 1 revision

Highlight (ScreenField property)

2011-03-18T20:18:36Z

TomWiccan: 1 revision

{{Template:ScreenField:Highlight subtitle}}

This property sets or returns the value of the highlight for a ScreenField. This value is a ScreenField class enumeration. This attribute is initially set for a field by the [[Screen class#AddField function|AddField method]].
==Syntax==
{{Template:ScreenField:Highlight syntax}}
===Syntax terms===
<dl>
<dt>value
<dd>An enumeration of type Highlight. Valid values are none, underline, reverse, and blink. The default value is none.
<dt>%sfield
<dd>A reference to an instance of a ScreenField object.
</dl>

==Usage notes==

The Highlight method lets you set highlights regardless of the actual terminal type, although some terminals may not display these attributes correctly. Also, many terminal emulator programs allow local customization of highlighting attributes. Under either of these conditions, which are not detectable by the Screen methods, the actual display may not show the intended highlighting.

For an example using Highlight method calls, see “[[Screen class example]]”.
==See also==
{{Template:ScreenField:Highlight footer}}

Delete (ScreenField subroutine)

2011-03-18T20:17:24Z

TomWiccan: 1 revision

{{Template:ScreenField:Delete subtitle}}

This method deletes a screenfield. Any space used by the screenfield is recovered and may be used again by a new screenfield.
==Syntax==
{{Template:ScreenField:Delete syntax}}
===Syntax terms===
<table class="syntaxTable">
<tr><th>%sfield</th>
<td>A reference to an instance of a ScreenField object.</td></tr>
</table>
==See also==
{{Template:ScreenField:Delete footer}}

Delete (ScreenField subroutine)

2011-03-18T20:17:19Z

TomWiccan: 1 revision

{{Template:ScreenField:Delete subtitle}}

This method deletes a screenfield. Any space used by the screenfield is recovered and may be used again by a new screenfield.
==Syntax==
{{Template:ScreenField:Delete syntax}}
===Syntax terms===
<dl>
<dt>%sfield
<dd>A reference to an instance of a ScreenField object.
</dl>
==See also==
{{Template:ScreenField:Delete footer}}

DeepCopy (ScreenField function)

2011-03-18T20:16:17Z

TomWiccan: 1 revision

{{Template:ScreenField:DeepCopy subtitle}}

This method returns a ScreenField object that is a deep copy of the method object. Since a ScreenField cannot exist without its underlying Screen, however, a ScreenField is deep copyable only, and no Copy method exists for a ScreenField. For more information about copyability, see &#x201C;[[Copying Objects]]&#x201D;.
==Syntax==
{{Template:ScreenField:DeepCopy syntax}}
===Syntax terms===
<table class="syntaxTable">
<tr><th>%outsfield</th>
<td>A declared ScreenField object. </td></tr>
<tr><th>%sfield</th>
<td>A reference to an instance of a ScreenField object.</td></tr>
</table>

==Usage notes==

The method object (%screen) may be null. The output of a copy of a null object is a null object.
==See also==
{{Template:ScreenField:DeepCopy footer}}

DeepCopy (ScreenField function)

2011-03-18T20:16:16Z

TomWiccan: 1 revision

DeepCopy (ScreenField function)

2011-03-18T20:16:11Z

TomWiccan: 1 revision

{{Template:ScreenField:DeepCopy subtitle}}

This method returns a ScreenField object that is a deep copy of the method object. Since a ScreenField cannot exist without its underlying Screen, however, a ScreenField is deep copyable only, and no Copy method exists for a ScreenField. For more information about copyability, see “[[Copying Objects]]”.
==Syntax==
{{Template:ScreenField:DeepCopy syntax}}
===Syntax terms===
<dl>
<dt>%outsfield
<dd>A declared ScreenField object.
<dt>%sfield
<dd>A reference to an instance of a ScreenField object.
</dl>

==Usage notes==

The method object (%screen) may be null. The output of a copy of a null object is a null object.
==See also==
{{Template:ScreenField:DeepCopy footer}}

Column (ScreenField property)

2011-03-18T20:14:45Z

TomWiccan: 1 revision

{{Template:ScreenField:Column subtitle}}

This read-only property returns the number of the first column of a screenfield. The first column, in any field, is reserved for an attribute byte and does not contain displayable data (it appears on a screen as a blank). The field's value (display data) begins by default in the column immediately following the reserved column.
==Syntax==
{{Template:ScreenField:Column syntax}}
===Syntax terms===
<table class="syntaxTable">
<tr><th>%num</th>
<td>A User Language numeric variable to contain the number of the field's first column. </td></tr>
<tr><th>%sfield</th>
<td>A reference to an instance of a ScreenField object.</td></tr>
</table>
==See also==
{{Template:ScreenField:Column footer}}

Column (ScreenField property)

2011-03-18T20:14:08Z

TomWiccan: 1 revision

{{Template:ScreenField:Column subtitle}}

This read-only property returns the number of the first column of a screenfield. The first column, in any field, is reserved for an attribute byte and does not contain displayable data (it appears on a screen as a blank). The field's value (display data) begins by default in the column immediately following the reserved column.
==Syntax==
{{Template:ScreenField:Column syntax}}
===Syntax terms===
<dl>
<dt>%num
<dd>A User Language numeric variable to contain the number of the field's first column.
<dt>%sfield
<dd>A reference to an instance of a ScreenField object.
</dl>
==See also==
{{Template:ScreenField:Column footer}}

Color (ScreenField property)

2011-03-18T20:12:52Z

TomWiccan: 1 revision

{{Template:ScreenField:Color subtitle}}

This property sets or returns the FieldColor for a ScreenField. FieldColor is a ScreenField class enumeration. This attribute is initially set for a field by the [[Screen class#AddField function|AddField method]].
==Syntax==
{{Template:ScreenField:Color syntax}}
===Syntax terms===
<table class="syntaxTable">
<tr><th>fieldcolor</th>
<td>A FieldColor enumeration. Valid values (case unimportant) are turquoise, green, blue, red, white, yellow, and pink. The default is blue </td></tr>
<tr><th>%sfield</th>
<td>A reference to an instance of a ScreenField object.</td></tr>
</table>

==Usage notes==

The Color property lets you set colors regardless of the actual terminal type, although some terminals may not display these attributes correctly. Also, many terminal emulator programs allow local customization of color attributes. Under either of these conditions, which are not detectable by the screen methods, the
display may not show the intended colors.

For an example using Color method calls, see &#x201C;[[Screen class example]]&#x201D;.
==See also==
{{Template:ScreenField:Color footer}}

Color (ScreenField property)

2011-03-18T20:12:51Z

TomWiccan: 1 revision

Color (ScreenField property)

2011-03-18T20:12:39Z

TomWiccan: 1 revision

{{Template:ScreenField:Color subtitle}}

This property sets or returns the FieldColor for a ScreenField. FieldColor is a ScreenField class enumeration. This attribute is initially set for a field by the [[Screen class#AddField function|AddField method]].
==Syntax==
{{Template:ScreenField:Color syntax}}
===Syntax terms===
<dl>
<dt>fieldcolor
<dd>A FieldColor enumeration. Valid values (case unimportant) are turquoise, green, blue, red, white, yellow, and pink. The default is blue
<dt>%sfield
<dd>A reference to an instance of a ScreenField object.
</dl>

==Usage notes==

The Color property lets you set colors regardless of the actual terminal type, although some terminals may not display these attributes correctly. Also, many terminal emulator programs allow local customization of color attributes. Under either of these conditions, which are not detectable by the screen methods, the
display may not show the intended colors.

For an example using Color method calls, see “[[Screen class example]]”.
==See also==
{{Template:ScreenField:Color footer}}

AddField (Screen function)

2011-03-18T20:03:49Z

TomWiccan: 1 revision

{{Template:Screen:AddField subtitle}}

This callable function adds a field (an instance of a ScreenField object) to the screen represented by the method object (an instance of a Screen object).

A ScreenField can only be defined within the limits of the current screen. The number of rows and columns in the current screen is determined by Screen class methods (&amp;#x201C;Rows property&amp;#x201D; and &amp;#x201C;Columns property&amp;#x201D;, below). An attempt to define a field outside these boundaries results in request cancellation. If any part of a new screen field would overlap an existing field, the request is cancelled.
==Syntax==
{{Template:Screen:AddField syntax}}
===Syntax terms===
<table class="syntaxTable">
<tr><th>%sfield</th>
<td>A declared ScreenField object that is set to a new ScreenField object reference. </td></tr>
<tr><th>%screen</th>
<td>A reference to an instance of a Screen object. </td></tr>
<tr><th>Color= fieldcolor</th>
<td>The optional Color argument (name required) is a Fieldcolor enumeration value. Valid values (case unimportant) are turquoise, green, blue, red, white, yellow, and pink. The default is blue.
This parameter explicitly sets the color for a screen field. The Color method (&amp;#x201C;Color property&amp;#x201D;, below) lets you reset it. You can use the ProtectedColor (&amp;#x201C;ProtectedColor property&amp;#x201D;) and UnprotectedColor (&amp;#x201C;UnprotectedColor property&amp;#x201D;) methods to set defaults for a screen's protected and unprotected fields, respectively. </td></tr>
<tr><th>Column= num</th>
<td>The optional Column argument (name required) is a numeric value indicating the first column position in the field. This first column, in any field, is reserved for an attribute byte and cannot contain displayable data (it appears on a screen as a blank). The field's value (display data) begins by default in the column immediately following the reserved column. The first column in a screen is column 1; the last column can be determined with the Columns method (&amp;#x201C;Columns property&amp;#x201D;, below). The default Column value is one greater than the ending column number of the preceding field, or it is 1.
</td></tr>
<tr><th>Highlight= highlight</th>
<td>The optional Highlight argument (name required) is a Highlight enumeration value. Valid values (case unimportant) are: Underline, Reverse, Blink, or None. A ScreenField may have only one Highlight attribute. The Highlight property (&amp;#x201C;Highlight&amp;#x201D; on page 909) lets you reset it. The default is None. </td></tr>
<tr><th>Invisible= bool</th>
<td>The optional Invisible argument (name required) is a Boolean enumeration value: if True, any data in the field will not displayed on the terminal. If False (the default), the screen field data is displayed on the terminal. The Invisible 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. </td></tr>
<tr><th>Itemid= num</th>
<td>The optional Itemid argument (name required) is a numeric value assigned to the the screenfield that allows the CursorItemID method to identify the screenfield that contains the cursor after a screen read. The default ID number is 0. The item ID should be a unique value for each screenfield, but this is not enforced by the AddField method. You can reset the ID using the ScreenField ItemID method (&amp;#x201C;Itemid property&amp;#x201D;, below). ItemIDs are most useful when using arraylists of ScreenFields. This is commonly done for scrolling applications. </td></tr>
<tr><th>Modified= bool</th>
<td>The optional Modified argument (name required) is a Boolean enumeration value that indicates whether a ScreenField value has been modified by the user: True indicates the ScreenField has been modified by the user. The default, False, indicates the ScreenField has not been modified.
Regardless of the initial setting of this argument, the value of the Modified property for a field is always set by the Read method. </td></tr>
<tr><th>Numeric= bool</th>
<td>The optional Numeric argument (name required) is a Boolean enumeration value: if True, and the field is not protected, only numeric values may be entered in the field. Numeric values must be composed of the characters 0 through 9, plus (+), minus (-), and period (.). If False (the default), field input is not restricted to numeric data. The Numeric property (&amp;#x201C;Numeric&amp;#x201D;, below) lets you reset the value.
Regardless of the value of the Numeric attribute, the programmer can assign any type of value to the field. Enforcement of the Numeric attribute takes place only when a user enters data in the field. 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.
</td></tr>
<tr><th>Protected= bool</th>
<td>The optional Protected argument (name required) is a Boolean enumeration value: if True, the field will be protected against modification by the user when the screen is displayed. If False, the screen field will be an input field. New fields are protected by default. The value of this attribute can be reset using the Protected method (&amp;#x201C;Protected property&amp;#x201D;, below). </td></tr>
<tr><th>Row= num</th>
<td>The optional Row argument (name required) is a numeric value 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 Rows method (&amp;#x201C;Rows property&amp;#x201D;, below). Any row number in the screen may be used for a field. No rows are reserved by Janus SOAP. A field may occupy more than one row.
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.
The Row default value is 1 or the value specified or implied by the previous AddField call.
</td></tr>
<tr><th>Value= string</th>
<td>The optional Value argument (name required) is a string that contains the screen data to be displayed. The Value parameter is simply a convenient way to set display data when the screenfield is instantiated.
The [[Screenfield class#Value property|Screenfield class Value method]] performs the same work, but can also get user-entered data for a screenField. For more information on setting and getting screenField values, see &amp;#x201C;Value property&amp;#x201D;.
</td></tr>
<tr><th>Width=width</th>
<td>The optional Width argument (name required) is a numeric value 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 1, and the maximum width is 255. If no width is specified, the width of the field is determined by the length of the string specified in the method's Value parameter. If neither a Width nor a Value parameter is specified, the request is cancelled. If both Width and Value parameters are specified, the Width parameter is used to set the field width, and the Value is silently padded or truncated accordingly.
The Width property lets you reset the width.</td></tr>
</table>

==Usage notes==

Each of the screenfield attributes specified by the AddField optional parameters can be updated by their like-named methods in the [[Screenfield class]]. The &amp;#x201C;modified&amp;#x201D; and &amp;#x201C;value&amp;#x201D; attributes are also set by a user screen-interaction.
==See also==
{{Template:Screen:AddField footer}}

AddField (Screen function)

2011-03-18T20:03:41Z

TomWiccan: 1 revision

{{Template:Screen:AddField subtitle}}

This callable function adds a field (an instance of a ScreenField object) to the screen represented by the method object (an instance of a Screen object).

A ScreenField can only be defined within the limits of the current screen. The number of rows and columns in the current screen is determined by Screen class methods (&#x201C;Rows property&#x201D; and &#x201C;Columns property&#x201D;, below). An attempt to define a field outside these boundaries results in request cancellation. If any part of a new screen field would overlap an existing field, the request is cancelled.
==Syntax==
{{Template:Screen:AddField syntax}}
===Syntax terms===
<dl>
<dt>%sfield
<dd>A declared ScreenField object that is set to a new ScreenField object reference.
<dt>%screen
<dd>A reference to an instance of a Screen object.
<dt>Color= fieldcolor
<dd>The optional Color argument (name required) is a Fieldcolor enumeration value. Valid values (case unimportant) are turquoise, green, blue, red, white, yellow, and pink. The default is blue.

This parameter explicitly sets the color for a screen field. The Color method (&#x201C;Color property&#x201D;, below) lets you reset it. You can use the ProtectedColor (&#x201C;ProtectedColor property&#x201D;) and UnprotectedColor (&#x201C;UnprotectedColor property&#x201D;) methods to set defaults for a screen's protected and unprotected fields, respectively.
<dt>Column= num
<dd>The optional Column argument (name required) is a numeric value indicating the first column position in the field. This first column, in any field, is reserved for an attribute byte and cannot contain displayable data (it appears on a screen as a blank). The field's value (display data) begins by default in the column immediately following the reserved column. The first column in a screen is column 1; the last column can be determined with the Columns method (&#x201C;Columns property&#x201D;, below).
The default Column value is one greater than the ending column number of the preceding field, or it is 1.

<dt>Highlight= highlight
<dd>The optional Highlight argument (name required) is a Highlight enumeration value. Valid values (case unimportant) are: Underline, Reverse, Blink, or None. A ScreenField may have only one Highlight attribute. The Highlight property (&#x201C;Highlight&#x201D; on page 909) lets you reset it. The default is None.
<dt>Invisible= bool
<dd>The optional Invisible argument (name required) is a Boolean enumeration value: if True, any data in the field will not displayed on the terminal. If False (the default), the screen field data is displayed on the terminal. The Invisible 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.
<dt>Itemid= num
<dd>The optional Itemid argument (name required) is a numeric value assigned to the the screenfield that allows the CursorItemID method to identify the screenfield that contains the cursor after a screen read.
The default ID number is 0. The item ID should be a unique value for each screenfield, but this is not enforced by the AddField method. You can reset the ID using the ScreenField ItemID method (&#x201C;Itemid property&#x201D;, below). ItemIDs are most useful when using arraylists of ScreenFields. This is commonly done for scrolling applications.
<dt>Modified= bool
<dd>The optional Modified argument (name required) is a Boolean enumeration value that indicates whether a ScreenField value has been modified by the user: True indicates the ScreenField has been modified by the user. The default, False, indicates the ScreenField has not been modified.

Regardless of the initial setting of this argument, the value of the Modified property for a field is always set by the Read method.
<dt>Numeric= bool
<dd>The optional Numeric argument (name required) is a Boolean enumeration value: if True, and the field is not protected, only numeric values may be entered in the field. Numeric values must be composed of the characters 0 through 9, plus (+), minus (-), and period (.). If False (the default), field input is not restricted to numeric data. The Numeric property (&#x201C;Numeric&#x201D;, below) lets you reset the value.

Regardless of the value of the Numeric attribute, the programmer can assign any type of value to the field. Enforcement of the Numeric attribute takes place only when a user enters data in the field. 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.

<dt>Protected= bool
<dd>The optional Protected argument (name required) is a Boolean enumeration value: if True, the field will be protected against modification by the user when the screen is displayed. If False, the screen field will be an input field. New fields are protected by default. The value of this attribute can be reset using the Protected method (&#x201C;Protected property&#x201D;, below).
<dt>Row= num
<dd>The optional Row argument (name required) is a numeric value 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 Rows method (&#x201C;Rows property&#x201D;, below). Any row number in the screen may be used for a field. No rows are reserved by Janus SOAP. A field may occupy more than one row.

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.

The Row default value is 1 or the value specified or implied by the previous AddField call.

<dt>Value= string
<dd>The optional Value argument (name required) is a string that contains the screen data to be displayed. The Value parameter is simply a convenient way to set display data when the screenfield is instantiated.

The [[Screenfield class#Value property|Screenfield class Value method]] performs the same work, but can also get user-entered data for a screenField. For more information on setting and getting screenField values, see &#x201C;Value property&#x201D;.

<dt>Width=width
<dd>The optional Width argument (name required) is a numeric value 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 1, and the maximum width is 255. If no width is specified, the width of the field is determined by the length of the string specified in the method's Value parameter. If neither a Width nor a Value parameter is specified, the request is cancelled. If both Width and Value parameters are specified, the Width parameter is used to set the field width, and the Value is silently padded or truncated accordingly.

The Width property lets you reset the width.
</dl>

==Usage notes==

Each of the screenfield attributes specified by the AddField optional parameters can be updated by their like-named methods in the [[Screenfield class]]. The &#x201C;modified&#x201D; and &#x201C;value&#x201D; attributes are also set by a user screen-interaction.
==See also==
{{Template:Screen:AddField footer}}

UnprotectedHighlight (Screen property)

2011-03-18T19:51:50Z

TomWiccan: 1 revision

{{Template:Screen:UnprotectedHighlight subtitle}}

This property sets or gets the current highlight default for unprotected fields in a Screen object. An unprotected field is assigned this highlight unless another highlight value is explicitly specified in the AddField statement that defines the field. A field's highlight can also be changed by the [[Screenfield class]] Highlight method.
==Syntax==
{{Template:Screen:UnprotectedHighlight syntax}}
===Syntax terms===
<table class="syntaxTable">
<tr><th>highlight</th>
<td>A Highlight enumeration. Valid values (case unimportant) are none, underline, reverse, and blink. The default value is none. </td></tr>
<tr><th>%screen</th>
<td>A reference to an instance of a Screen object.</td></tr>
</table>
==See also==
{{Template:Screen:UnprotectedHighlight footer}}

UnprotectedHighlight (Screen property)

2011-03-18T19:51:45Z

TomWiccan: 1 revision

{{Template:Screen:UnprotectedHighlight subtitle}}

This property sets or gets the current highlight default for unprotected fields in a Screen object. An unprotected field is assigned this highlight unless another highlight value is explicitly specified in the AddField statement that defines the field. A field's highlight can also be changed by the [[Screenfield class]] Highlight method.
==Syntax==
{{Template:Screen:UnprotectedHighlight syntax}}
===Syntax terms===
<dl>
<dt>highlight
<dd>A Highlight enumeration. Valid values (case unimportant) are none, underline, reverse, and blink. The default value is none.
<dt>%screen
<dd>A reference to an instance of a Screen object.
</dl>
==See also==
{{Template:Screen:UnprotectedHighlight footer}}

UnprotectedColor (Screen property)

2011-03-18T19:50:22Z

TomWiccan: 1 revision

{{Template:Screen:UnprotectedColor subtitle}}

This property sets or gets the current default for the color of unprotected fields in a Screen object. An unprotected field is assigned this color unless another color value is explicitly specified in the AddField statement that defines the field. A field's color can also be changed by the [[Screenfield class]] Color method.
==Syntax==
{{Template:Screen:UnprotectedColor syntax}}
===Syntax terms===
<table class="syntaxTable">
<tr><th>fieldcolor</th>
<td>A Fieldcolor enumeration. Valid values (case unimportant) are turquoise, green, blue, red, white, yellow, and pink. The default is green. </td></tr>
<tr><th>%screen</th>
<td>A reference to an instance of a Screen object.</td></tr>
</table>
==See also==
{{Template:Screen:UnprotectedColor footer}}

UnprotectedColor (Screen property)

2011-03-18T19:50:18Z

TomWiccan: 1 revision

{{Template:Screen:UnprotectedColor subtitle}}

This property sets or gets the current default for the color of unprotected fields in a Screen object. An unprotected field is assigned this color unless another color value is explicitly specified in the AddField statement that defines the field. A field's color can also be changed by the [[Screenfield class]] Color method.
==Syntax==
{{Template:Screen:UnprotectedColor syntax}}
===Syntax terms===
<dl>
<dt>fieldcolor
<dd>A Fieldcolor enumeration. Valid values (case unimportant) are turquoise, green, blue, red, white, yellow, and pink. The default is green.
<dt>%screen
<dd>A reference to an instance of a Screen object.
</dl>
==See also==
{{Template:Screen:UnprotectedColor footer}}

Rows (Screen function)

2011-03-18T19:48:39Z

TomWiccan: 1 revision

{{Template:Screen:Rows subtitle}}

This read-only property returns the number of rows in the current screen. This number corresponds to the row value returned by a Model 204 VIEW MODEL command.
==Syntax==
{{Template:Screen:Rows syntax}}
===Syntax terms===
<table class="syntaxTable">
<tr><th>%num</th>
<td>A numeric variable to contain the number of screen rows. </td></tr>
<tr><th>%screen</th>
<td>A reference to an instance of a Screen object.</td></tr>
</table>
==See also==
{{Template:Screen:Rows footer}}

Rows (Screen function)

2011-03-18T19:48:38Z

TomWiccan: 1 revision

Rows (Screen function)

2011-03-18T19:48:34Z

TomWiccan: 1 revision

{{Template:Screen:Rows subtitle}}

This read-only property returns the number of rows in the current screen. This number corresponds to the row value returned by a Model 204 VIEW MODEL command.
==Syntax==
{{Template:Screen:Rows syntax}}
===Syntax terms===
<dl>
<dt>%num
<dd>A numeric variable to contain the number of screen rows.
<dt>%screen
<dd>A reference to an instance of a Screen object.
</dl>
==See also==
{{Template:Screen:Rows footer}}

Read (Screen function)

2011-03-18T19:47:10Z

TomWiccan: 1 revision

{{Template:Screen:Read subtitle}}

This callable function does the actual write of the screen to the "terminal," and it invokes a Model 204 wait while the user responds to the displayed screen. It then reads from the terminal the subsequent user response and updates the values of any modified ScreenField objects.
==Syntax==
{{Template:Screen:Read syntax}}
===Syntax terms===
<table class="syntaxTable">
<tr><th>%key</th>
<td>A declared actionKey enumeration set to the identifier of the key that activated the reading of the screen. Valid values (case unimportant) are Enter and pf1, pf2, and so on through pf24. </td></tr>
<tr><th>%screen</th>
<td>A reference to an instance of a Screen object.</td></tr>
</table>
==Usage notes==

The Modified property is reset for all non-protected
ScreenFields after the Read method is invoked. If a particular ScreenField value
has been modified by the user, the Modified property for that field is set to True.
Otherwise, the Modified property is set to False.

For an example using the Read method, see [[Screen Object Sample Code]].
==See also==
{{Template:Screen:Read footer}}

Read (Screen function)

2011-03-18T19:47:09Z

TomWiccan: 1 revision

Read (Screen function)

2011-03-18T19:47:05Z

TomWiccan: 1 revision

{{Template:Screen:Read subtitle}}

This callable function does the actual write of the screen to the "terminal," and it invokes a Model 204 wait while the user responds to the displayed screen. It then reads from the terminal the subsequent user response and updates the values of any modified ScreenField objects.
==Syntax==
{{Template:Screen:Read syntax}}
===Syntax terms===
<dl>
<dt>%key
<dd>A declared actionKey enumeration set to the identifier of the key that activated the reading of the screen. Valid values (case unimportant) are Enter and pf1, pf2, and so on through pf24.
<dt>%screen
<dd>A reference to an instance of a Screen object.
</dl>
==Usage notes==

The Modified property is reset for all non-protected
ScreenFields after the Read method is invoked. If a particular ScreenField value
has been modified by the user, the Modified property for that field is set to True.
Otherwise, the Modified property is set to False.

For an example using the Read method, see [[Screen Object Sample Code]].
==See also==
{{Template:Screen:Read footer}}