Description
Selects text beginning and ending at a line and character position in a RichText DataWindow.
Applies to
Syntax
PowerBuilder
long rtedwcontrol.SelectText ( long fromline, long fromchar, long toline, long tochar { band band } )
|
Argument |
Description |
|---|---|
|
rtedwcontrol |
A reference to the DataWindow control in which you want to select text. The DataWindow object in the DataWindow control must have the RichText presentation style. |
|
fromline |
A value specifying the line number where the selection starts. |
|
fromchar |
A value specifying the number in the line of the first character in the selection. |
|
toline |
A value specifying the line number where the selection ends. To specify an insertion point, set toline and tochar to 0. |
|
tochar |
A value specifying the number in the line of the character before which the selection ends. |
|
band (optional) |
A value of the Band enumerated datatype specifying the band in which to make the selection. Values are:
The default is the band that contains the insertion point. |
Return value
Returns the number of characters selected. A carriage return with a line feed counts as a single character. If an error occurs SelectText returns -1. If any argument's value is null, it returns null.
Usage
The insertion point is at the "to" end of the selection -- that is, the position specified by toline and tochar. If toline and tochar are before fromline and fromchar, then the insertion point is at the beginning of the selection.
You cannot specify 0 for a character position when making a selection.
You cannot always use the values returned by Position to make a selection. Position can return a character position of 0 when the insertion point is at the beginning of a line.
To select an entire line, set the insertion point and call SelectTextLine. To select the rest of a line, set the insertion point and call SelectText with a character position greater than the line length.
PowerBuilder environment
For use with other PowerBuilder controls, see the section called “SelectText” in PowerScript Reference.
Examples
SelectText is used in the same way for RichTextEdit controls and RichText DataWindow controls. For sample code, see the examples for the RichTextEdit control in the PowerScript Reference.
See also
