SearchOptions | API Docs

Options that may be passed to a SearchAgent when starting a search to modify its behaviour.

Example: Find and select the previous occurrence of the selection

let agent = new micd.SearchAgent(editor, micd.Clip.from(editor));
agent.start({forward: false});
agent.find();

Hierarchy

SearchOptions

Index

Properties

forward

forward: boolean

If true, the search proceeds from the starting position toward the end of the document. If false, it proceeds from the starting position toward the start of the document. The default is true.

position

position: string

The caret position to begin searching from. The default is the current caret position.

selectMatches

selectMatches: boolean

If true, as each match is found it will also be selected in the editor. The default is true.

wildFields

wildFields: boolean

If true, empty fields in objects in the pattern will match any content in the corresponding fields in the document. For example, an empty parentheses object would match any parenetheses in the document without regard to what is inside. If false, empty fields in the pattern will only match when the corresponding field is empty in the document. The default is true.

wrap

wrap: boolean

If true, the search will continue until it wraps around from one end of the document to the other and returns to the start position. If false, the search ends when the end of the document is reached. The default is true.