| |
Selects a region of the virtual display and returns the selected
text.
Syntax
object.Select( [Column1], [Row1],
[Column2], [Row2], [Options )
Parameters
- Column1
- A optional integer which specifies the starting column for the
text selection. If this argument is omitted, the first column in
the display is used.
- Row1
- A optional integer which specifies the starting row for the
text selection. If this argument is omitted, the first row in the
display is used.
- Column2
- A optional integer which specifies the ending column for the
text selection. If this argument is omitted, the last column in the
display is used.
- Row2
- A optional integer which specifies the ending row for the text
selection. If this argument is omitted, the last row in the display
is used.
- Options
- An optional integer value which specifies one or more options.
More than one option can be combined using a bitwise operator. The
following values may be used:
| Value |
Constant |
Description |
| 0 |
nvtSelectDefault |
The default selection option. If there is a region of the
display already selected, it will be cleared and the new region
is selected. The selected text is buffered and can be accessed
using the SelText property. |
| 1 |
nvtSelectClipboard |
Copy the selected text to the clipboard. If this option is
not specified, the selected text is buffered and may be
accessed using the SelText property. |
| &H1000 |
nvtSelectNoRefresh |
The display is not refreshed when the region is selected.
This is useful if the application is going to be selecting
multiple regions of the display, or combining more than one
region, in order to minimize output to the window. |
| &H2000 |
nvtSelectNoBuffer |
Do not buffer the text in the selected region of the
display. The display will show any text as being selected, but
it will not be available to the application. This can be useful
if the application is going to select multiple regions and
combine them. |
| &H4000 |
nvtSelectCombine |
If there is already a region of the display that has been
selected, the new region is combined with the previous region,
selecting all of the text. |
Return Value
The method will return the selected text. If the method fails
because incorrect row or column values were used, or because an
invalid option was specified, it will return an empty string.
Remarks
The Select method selects a region of the virtual display.
This enables the application to select text in the same way that a
user would by clicking and dragging the mouse over the display
window. The SelText property can be used to return the text
that has been selected by this method.
See Also
AutoSelect Property,
SelText Property,
Deselect Method
|
|