Applies To Objects
Description
Returns an Area object with the defined coordinates.
Syntax
Set rc = object.Area(StartRow,StartCol,EndRow,EndCol[,Page][,Type])
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. |
StartRow |
The row where the selection begins. |
StartCol |
The column where the selection begins. |
EndRow |
The row where the selection ends. |
EndCol |
The column where the selection ends. |
Page |
VT session only -- the screen page. |
Type |
Determines how the coordinates of the Area object (top, left, bottom, right) are interpreted when the object is selected. |
Comments
The Area method requires six parameters. The Page and Type parameters are optional in the sense that you do not have to specify values; however, if you don't specify values for these parameters, they must be represented by place holders, namely commas. In the following statement, the Area method includes six parameters, with the last two being the comma place holders for the Page and Type parameters.
Set MyArea = MyScreen.Area(1,1,80,24 , ,)
The Type parameter accepts the following values.
Constant |
Value |
Meaning |
xBLOCK |
3 |
The Area is selected as a rectangular range of characters. There is no line wrapping. This is the default. |
xSTREAM |
2 |
The Area is selected as a continuous stream of characters, from the top left coordinate to the bottom right coordinate. If the Area consists of more than one line, then the selection wraps to the right of each line. |
xPOINT |
1 |
The Area is selected as a single point. The bottom and right coordinates are ignored. Not supported by VT session. |
xNONE |
0 |
Invalidates selection of the Area. |