Applies To Objects
Description
Returns an Area object with the text specified in the search.
Syntax
Set rc = object.Search(Text [,Row][,Col][,Page])
Element |
Description |
Set |
The Set statement, required for assigning an object reference to a variable. |
rc |
The object variable for referencing the returned Area object. |
object |
The Screen object. |
Row |
The row where the search begins. |
Col |
The column where the search begins. |
Page |
VT session only -- the screen page where the search begins. Note: This parameter is ignored for release 6.0 of EXTRA!. |
Comments
If the optional parameters are used, Screen is searched from the specified starting position. Otherwise, the entire Screen object is searched.
If Search finds the specified text, the coordinate properties (Left, Top, Right, Bottom) of the returned Area object are set to the starting and ending row and column positions of the text. The Value property of the Area object is set to the text located at those coordinates. If the Screen changes at those coordinates, the Value property of the Area changes.
If Search does not find the specified text, the Area object's Value property is set to an empty string, its Type property is set to xNONE, and its coordinate properties are set to -1.