Interface CustomDocument

Represents a custom document used by a CustomEditorProvider.

Custom documents are only used within a given CustomEditorProvider. The lifecycle of a CustomDocument is managed by Theia. When no more references remain to a CustomDocument, it is disposed of.

interface CustomDocument {
    uri: Uri;
    dispose(): void;
}

Properties

uri

Methods

dispose

Properties

Readonly uri

uri: Uri

The associated uri for this document.

Methods

dispose

  • dispose(): void

  • Dispose of the custom document.

    This is invoked by Theia when there are no more references to a given CustomDocument (for example when all editors associated with the document have been closed.)

    Returns void

Settings

Member Visibility

Theme

On This Page

uridispose