Back to product page

Text property


Returns line(s) of text from terminal screen.

Type

String

Syntax

  • Basic
object.Text ([Index])
The Text(object,Index) syntax has these parts:
objectAn expression evaluating to an object of type wodTelnetDLX
IndexOptional. A Variant value. Determines line number that should be set/retrieved.

Remarks

Text property will return (or set) one line from screen buffer to string variable. If Index argument is specified, then only specified line is returned. If Index is not specified, then full screen buffer is returned without backlog buffer.

If you wish to retrieve backlog buffer lines, you can specify Index argument less than zero, in which case -1 would be first line (just above topmost currently visible), -2 would be second etc.. If Index argument is positive integer, then you will retrieve line from currently visible screen.

Just as is with retrieving lines from screen, you can also set it by writing to this property. For example:
 
Debug.Print wodTelnetDLX.Text (2)
 

will get 3rd line of text from visible screen. If you do
 
Debug.Print wodTelnetDLX.Text (-1)
 

you will get first line from backlog buffer (just one above topmost line). If you do
 
Debug.Print wodTelnetDLX.Text
 

you will get full screen (no scroll buffer).

Platforms

Windows