languages

Interface MultiDocumentHighlightProvider

Expand description

A provider that can provide document highlights across multiple documents.

interface MultiDocumentHighlightProvider {
    selector: LanguageSelector;
    provideMultiDocumentHighlights(
        primaryModel: ITextModel,
        position: Position,
        otherModels: ITextModel[],
        token: CancellationToken,
    ): ProviderResult<Map<Uri, DocumentHighlight[]>>;
}

Properties§

§readonly selector: LanguageSelector

Methods§

§

provideMultiDocumentHighlights(
    primaryModel: ITextModel,
    position: Position,
    otherModels: ITextModel[],
    token: CancellationToken,
): ProviderResult<Map<Uri, DocumentHighlight[]>>

Provide a Map of Uri --> document highlights, like all occurrences of a variable or all exit-points of a function.

Used in cases such as split view, notebooks, etc. where there can be multiple documents with shared symbols.