Interface IBaseSearchProvider

Base search provider interface

Notes

It is implemented by subprovider like searching on a single cell.

Hierarchy

Implemented by

Properties

currentMatchIndex: number

The current index of the selected match.

isDisposed: boolean

Test whether the object has been disposed.

Notes

This property is always safe to access.

matchesCount: number

The number of matches.

stateChanged: ISignal<IBaseSearchProvider, void>

Signal indicating that something in the search has changed, so the UI should update

Methods

  • Clear currently highlighted match.

    Returns Promise<void>

  • Dispose of the resources held by the object.

    Notes

    If the object's dispose method is called more than once, all calls made after the first will be a no-op.

    Undefined Behavior

    It is undefined behavior to use any functionality of the object after it has been disposed unless otherwise explicitly noted.

    Returns void

  • Stop a search and clear any internal state of the provider

    Returns Promise<void>

  • Highlight the next match

    Parameters

    • Optional loop: boolean

      Whether to loop within the matches list.

    Returns Promise<ISearchMatch>

    The next match if it exists

  • Highlight the previous match

    Parameters

    • Optional loop: boolean

      Whether to loop within the matches list.

    Returns Promise<ISearchMatch>

    The previous match if it exists.

  • Replace all matches in the widget with the provided text

    Parameters

    Returns Promise<boolean>

    A promise that resolves with a boolean indicating whether a replace occurred.

  • Replace the currently selected match with the provided text and highlight the next match.

    Parameters

    • newText: string

      The replacement text

    • Optional loop: boolean

      Whether to loop within the matches list.

    • Optional options: IReplaceOptions

    Returns Promise<boolean>

    A promise that resolves with a boolean indicating whether a replace occurred.

  • Start a search

    Parameters

    • query: RegExp

      Regular expression to test for

    • filters: IFilters

      Filters to apply when searching

    Returns Promise<void>

Generated using TypeDoc