Interface TextDocumentContentProvider

A text document content provider allows to add readonly documents to the editor, such as source from a dll or generated html from md.

Content providers are workspace.registerTextDocumentContentProvider registered for a uri-scheme. When a uri with that scheme is to be workspace.openTextDocument loaded the content provider is asked.

interface TextDocumentContentProvider {
    onDidChange?: Event<Uri>;
    provideTextDocumentContent(uri, token): ProviderResult<string>;
}

Properties

onDidChange?

Methods

provideTextDocumentContent

Properties

Optional onDidChange

onDidChange?: Event<Uri>

An event to signal a resource has changed.

Methods

provideTextDocumentContent

  • provideTextDocumentContent(uri, token): ProviderResult<string>

  • Provide textual content for a given uri.

    The editor will use the returned string-content to create a readonly document. Resources allocated should be released when the corresponding document has been workspace.onDidCloseTextDocument closed.

    Parameters

    • uri: Uri

      An uri which scheme matches the scheme this provider was workspace.registerTextDocumentContentProvider registered for.

    • token: CancellationToken

      A cancellation token.

    Returns ProviderResult<string>

    A string or a thenable that resolves to such.

Settings

Member Visibility

Theme

On This Page

onDidChangeprovideTextDocumentContent