Interface DocumentHighlightProvider

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

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

Index

Methods

provideDocumentHighlights

Methods

provideDocumentHighlights

provideDocumentHighlights(model, position, token): 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 editor.api.d.ts:7443