FindAllCommand.execute(text, matchCase, highlightResults) Method

Executes the FindAllCommand command with the specified parameters.

Declaration

execute(
    text: string,
    matchCase: boolean,
    highlightResults: boolean,
    results?: Interval[]
): boolean

Parameters

Name Type Description
text string

A string value specifying text to find.

matchCase boolean

true, to perform a case-sensitive search; otherwise, false.

highlightResults boolean

true, to highlight the search results; otherwise, false.

results Interval[]

An array of Interval objects containing the search results.

Returns

Type Description
boolean

true if the command has been successfully executed; false if the command execution has failed.

Remarks

Usage example:

var results = [];
richEdit.commands.findAll.execute("matching text", true, true, results);

Use the RichEditCommands.hideFindResults command to hide the search results.

See Also