Returns the visible text from the specified location.


Namespace: ScreenUPG
Assembly: ScreenUPG (in ScreenUPG.dll)

Syntax

Visual Basic (Declaration)
Public Function getString( _ 
   ByVal inStartRow As Integer,  _ 
   ByVal inStartColumn As Integer,  _ 
   ByVal inLength As Integer _ 
) As String
C#
public string getString(
   int inStartRow,
   int inStartColumn,
   int inLength
)
C++
public:
 String getString(
   int inStartRow,
   int inStartColumn,
   int inLength
) sealed 
J#
public string getString(
   int inStartRow,
   int inStartColumn,
   int inLength
)
JScript
public  function getString(
   inStartRow : int,
   inStartColumn : int,
   inLength : int
) : String

Parameters

inStartRow
The first row from which to retrieve text.
inStartColumn
The first column from which to retrieve text.
inLength
The number of presentation space positions to return. Ignored when both inStartRow and inStartColumn are zero.

Return Value

The text string from the presentation space.

Remarks

If inStartRow and inStartColumn are zero, the entire presentation space is returned.

Example

[C#]

 Copy Code
            int row = 1;
            int column = 1;
            int length = 12;
            
            // Get the text string located at the home position.
            string visibleString = screen.getString(row, column, length);
            
[VB]
 Copy Code
            Dim row As Integer
            Dim column As Integer
            Dim length As Integer
            Dim visibleString As String
            
            row = 1
            column = 1
            length = 12
            
            'Get the text string located at the home position.
            visibleString = screen.getString(row, column, length)
            

See Also