Attributes

For more information on the use of all these attributes see Extract action (<extract> element).

name

Required string. A name to be assigned to the extracted data.

planetype

Required. The plane from which the data is to be extracted. Valid values are:

• TEXT_PLANE
• FIELD_PLANE
• COLOR_PLANE
• EXFIELD_PLANE
• DBCS_PLANE
• GRID_PLANE

srow

Required integer. The row of the first pair of row and column coordinates.

scol

Required integer. The column of the first pair of row and column coordinates.

erow

Required integer. The row of the second pair of row and column coordinates.

scol

Required integer. The column of the second pair of row and column coordinates.

unwrap

Optional boolean. Setting this attribute to true causes the macro runtime to capture the entire contents of any field that begins inside the specified rectangle. See Unwrap attribute.

continuous

Optional boolean. Setting this attribute to true causes the macro runtime to interpret the row-column coordinates as the beginning and ending locations of a continuous sequence of data that wraps from line to line if necessary. If this attribute is set to false then the macro runtime interprets the row-column coordinates as the upper left and lower right corners of a rectangular area of text. See Capturing a sequence of text from the host terminal.

assigntovar

Optional variable name. Setting this attribute to a variable name causes the macro runtime to store the text plane data as a string value into the variable. If the variable is of some standard type other than string (that is, boolean, integer, or double) then the data is converted to that standard type, if possible. If the data cannot be converted then the macro terminates with a runtime error.

screenorientation

Optional string. Use this attribute to define the host screen orientation to use for the extract during macro playback at runtime. Options are LTR and RTL.