Interface IBaseSearchProvider

Base search provider interface

Notes

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

interface IBaseSearchProvider {
    currentMatchIndex: null | number;
    isDisposed: boolean;
    matchesCount: null | number;
    stateChanged: ISignal<IBaseSearchProvider, void>;
    clearHighlight(): Promise<void>;
    dispose(): void;
    endQuery(): Promise<void>;
    highlightNext(loop?): Promise<undefined | ISearchMatch>;
    highlightPrevious(loop?): Promise<undefined | ISearchMatch>;
    replaceAllMatches(newText, options?): Promise<boolean>;
    replaceCurrentMatch(newText, loop?, options?): Promise<boolean>;
    startQuery(query, filters): Promise<void>;
}

Hierarchy (view full)

Implemented by

    Properties

    currentMatchIndex isDisposed matchesCount stateChanged

    Methods

    clearHighlight dispose endQuery highlightNext highlightPrevious replaceAllMatches replaceCurrentMatch startQuery

    Properties

    Readonly currentMatchIndex

    currentMatchIndex: null | number

    The current index of the selected match.

    Readonly isDisposed

    isDisposed: boolean

    Test whether the object has been disposed.

    Notes

    This property is always safe to access.

    Readonly matchesCount

    matchesCount: null | number

    The number of matches.

    Readonly stateChanged

    stateChanged: ISignal<IBaseSearchProvider, void>

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

    Methods

    clearHighlight

    dispose

    • dispose(): 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

    endQuery

    highlightNext

    highlightPrevious

    replaceAllMatches

    replaceCurrentMatch

    • replaceCurrentMatch(newText, loop?, options?): Promise<boolean>

    • 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.

    startQuery

    Settings

    Member Visibility

    Theme

    On This Page

    currentMatchIndexisDisposedmatchesCountstateChangedclearHighlightdisposeendQueryhighlightNexthighlightPreviousreplaceAllMatchesreplaceCurrentMatchstartQuery