IRichEditSearchSettings Interface

Declares search settings.

Declaration

export interface IRichEditSearchSettings

Remarks

The search panel and the Find and Replace dialog allow users to locate and modify text in a document opened in the Rich Text Editor. You can filter search results to prevent users from modifying certain document intervals. The example below demonstrates how to exclude intervals that contain fields from search results:

JS

const options = DevExpress.RichEdit.createOptions();
options.search.filterInterval = (subDocument, interval) =>
    subDocument.fields.find(interval).length == 0;
// ...

Properties

filterInterval Property

Specifies a callback function that filters search results.

Declaration

filterInterval?: (subDocument: SubDocumentBase, interval: IInterval) => boolean

Property Value

Type	Description
(subDocument: SubDocumentBase, interval: IInterval) => boolean	A callback function that defines whether the current search result is visible. The function parameters are the sub-document and text interval that contain this result.