Interface DocumentHighlightProvider

The document highlight provider interface defines the contract between extensions and the word-highlight-feature.

interface DocumentHighlightProvider {
    provideDocumentHighlights(
        model: ITextModel,
        position: Position,
        token: CancellationToken,
    ): ProviderResult<DocumentHighlight[]>;
}

Index

Methods

provideDocumentHighlights

Methods

provideDocumentHighlights

provideDocumentHighlights(
    model: ITextModel,
    position: Position,
    token: CancellationToken,
): ProviderResult<DocumentHighlight[]>
Provide a set of document highlights, like all occurrences of a variable or all exit-points of a function.
Parameters
- model: ITextModel
- position: Position
- token: CancellationToken
Returns ProviderResult<DocumentHighlight[]>
- Defined in src/components/monaco/bin/monaco.d.ts:7865