TRichView Reference | TRichView

TCustomRichView.SearchText, SearchTextW

The methods search for the substring s in the document.

function SearchText(s: String; SrchOptions: TRVSearchOptions): Boolean;

function SearchTextW(s: WideString; SrchOptions: TRVSearchOptions): Boolean;

When found, these methods select substring and scroll to it.

if rvsroDown is not included in SrchOptions, the methods search upwards. if rvsroDown is included, the methods search downwards.

If rvsroFromStart is included in SrchOptions, the search is started from the beginning/end of the document. Otherwise, the methods start searching from the current selection, if it exists. If nothing is selected, the methods start from the first visible item (when searching down) or the last visible item (when searching up).

Limitation: The methods search the substring in all text items separately.

Unicode note: The methods allow searching both in ANSI and in Unicode text items. When SearchText compares Unicode text with s, the conversion is based on RVStyle.DefCodePage. When SearchTextW compares ANSI text with s, the conversion is based on the character set of the text style.

History and compatibility

Since version 1.2 SearchText can search upwards.

Since version 1.5 SearchText can search whole words (substring must be delimited with characters from Delimiters)

SearchTextW is introduced in version 10. rvsroFromStart is introduced in version 10 as well.

Note: There is incompatibility with programs written with the older version of RichView (1.0 – 1.1.4). Now if rvsroDown is not included in SrchOptions, the methods search upwards. In the older versions there was no rvsroDown option, and SearchText searched downwards only.

These methods must be called only when the document is formatted.

Return value: Is substring found?

See also methods of TRichViewEdit:

See also global functions:

See also: