Object Inquiry Built-in Function

Return the specified line of a list box, multiline entry field, or spin button, or the contents of a textual region.

For Textual Regions:

textual

{ line LINE_NO

| {segment|block} [column] COL_NO [line] LINE_NO

[ thru [column] COL_NO [line] LINE_NO] }

from TR_NAME

For List Boxes, Multiline Entry Fields, and Spin Buttons:

textual line LINE_NO from [LB_NAME|MEF_NAME|SB_NAME]

line LINE_NO

An integer value representing the line number in the textual region, list box, multiline entry field, or spin button. If the line does not exist, the null string is returned and an error message is generated.

segment

Return a text segment from a textual region.

block

Return a text block from a textual region.

column COL_NO

An integer value representing the column number in the textual region.

TR_NAME

The identifier for a textual region.

LB_NAME

The identifier for a list box.

MEF_NAME

The identifier for a multiline entry field.

SB_NAME

The identifier for a spin button.

Description

Use this function to return the contents of a specified line, segment, or block of a textual region, or of a specified line of a list box, multiline entry field, or spin button. For numeric spin buttons, the minimum value will be considered line 1.

If you do not specify thru and an ending column and line number, the segment or block will contain only one character.

Example

 

response to GetLine_GR

 copy textual line 1 from Manual_TR to CurrentList_SV

 

response to CopyBox_KEY

 copy textual block column 10 line 4

          thru column 50 line 8 from OldText_TR to NewString_SV

See Also

block Definition

copy Action Statement

segment Definition