Programming with Reflection

image\rwnprg32.gif GetText method

 

Syntax Text = object.GetText(StartRow, StartColumn, EndRow, EndColumn, [Options])

 

Description

Returns a string corresponding to a selection from the terminal window.

Arguments

StartRow Argument Type: Integer
Required
Specifies the row in display memory where the string is to begin. Use host addressable coordinates.

 To begin the search at the top of the display memory, use the value of the DisplayMemoryTopRow property for this parameter. To begin the search at the top of the current screen, use the value of the ScreenTopRow property.

StartColumn Argument Type: Integer
Required
Specifies the column in display memory where the string is to begin. The first column is column 0.

EndRow Argument Type: Integer
Required
Specifies the row in display memory where the string is to end. You can use the DisplayRows property to specify the number of rows in the current display screen.

EndColumn Argument Type: Integer
Required
Specifies the column in display memory where the string is to end. You can use the DisplayColumns property to specify the number of columns in the current display screen.

Options Argument Type: Enumeration
Optional
Specifies additional, non-default behavior for the method. (To combine the more than multiple options, use the addition operator (+): rcRectRegion + rcNoTranslation.)

 rcRectRegion

 This option indicates that the text returned should be a "rectangular" region; for example:

 The bold text in this sentence will be
returned if rc
RectRegion is specified.

 The default is to return a wrapped region; for example:

 The bold text in this sentence will be
returned if rcRectRegion i
s not specified.

 rcNoTranslation

 Indicates that the returned string should not be translated from the host character set into the PC character set.

 rcAsXML

 Indicates that the screen information should be returned using XML format.

Return

Text Return type: String
The requested text. Spaces at the end of lines are removed. All lines except the last line end with a carriage return/linefeed.

 

image\jump.gif Example

image\jump.gif Keyword Index

image\popup.gif Related Topics

image\popup.gif Reflection products that use this command