Parents: FieldMap
Children: none
Used By: MapField, getMapField, mappedGet, mappedSet, mappedRowGet, mappedRowSet
Description
The Field tag is used to describe individual fields inside a FieldMap tag. The Field tag has no children, so it should be terminated with a forward slash at the end of the tag.
The name attribute is the named used in the mappedGet, mappedSet, mappedRowGet and mappedRowSet methods of the HostScreen object. This is not fully qualified with the map name, but is instead controlled with the activeMapName property of HostScreen.
Attributes
Name |
Type |
Description |
name |
required |
Name of the field, used in the mappedGet, mappedSet, mappedRowGet and mappedRowSet methods of the HostScreen object |
row |
required |
Row where field exists on screen, starting with 1. Note-- for a FieldMap that is describing a multirow area of a screen, enter the topmost row of the multirow area. This becomes the base point for the mappedRowGet and mappedRowSet methods. If a multi-row area has more than one physical row per logical field set, if defining a field on the second or nth row, still define the topmost row for that field in the set. |
column |
required |
Column where the field exists on the screen |
length |
required |
Length that the field inhabits--try to set the maximum length of the field, not simply the size of the data viewed in a sample. |
adjust |
optional |
default="left"
Use adjust to define whether any padding characters (blank or defined PAD character) should be assumed to be to the right or left of the text. When adjust="left", pad characters are to the right and when adjust="right" pad characters are to the left. |
action |
optional |
default="read"
values: "read", "write", "readwrite"
action is provided as a reference for if a field is protected or not (unprotected=entry). And the assumed use of the field in the map. The functions mappedSet, mappedGet, mappedRowSet and mappedRowGet ignore this setting, but other methods that act on whole maps may use it in the future. |
