GetText Method

Top  Previous  Next

GetText returns the text buffer of a portion of the current screen. You can receive the attribute or extended attribute of each field together to the character data.

 

VB.NET Syntax

 

[String =] Display.GetText (StartPos As Integer, [EndPos As Integer], [Attr As Boolean = False], [Eab As Boolean = False])

 

[String =] Display.GetText (Row As Integer, Col As Integer, Len as Integer,[Attr As Boolean = False], [Eab As Boolean = False])

 

C# Syntax

 

[string =] Display.GetText (int StartPos, [int StartPos], [bool Attr = False], [bool Eab = False]);

 

[string =] Display.GetText (int Row, in Col, int Len, [bool Attr = False], [bool Eab = False]);

 

Remarks

 

Start position and the end position of the text buffer to retrieve can be set using StartPos and EndPos parameters or Row,Col and Len parameters.

 

The Attr parameter will indicate to GetText that includes the field attribute information. The Attr describes the field properties and occupies the first character position of each field in the character buffer and on the screen. This character is in HLLAPI-Compliance format.

 

The Eab parameter will indicate to GetText that includes the extended attribute information. The Eab is associated with individual characters. Each character in the buffer (except for fields attributes) has a character attribute. In the returned String, each character will be preceded by his Eab value. This character is in HLLAPI-Compliance format.