Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface CustomDocumentEditEvent<T>

Event triggered by extensions to signal to the editor that an edit has occurred on an CustomDocument.

see

CustomEditorProvider.onDidChangeCustomDocument.

Type parameters

Hierarchy

  • CustomDocumentEditEvent

Index

Properties

Methods

Properties

Readonly document

document: T

The document that the edit is for.

Optional Readonly label

label: string

Display name describing the edit.

This will be shown to users in the UI for undo/redo operations.

Methods

undo

  • Undo the edit operation.

    This is invoked by the editor when the user undoes this edit. To implement undo, your extension should restore the document and editor to the state they were in just before this edit was added to the editor's internal edit stack by onDidChangeCustomDocument.

    Returns void | Thenable<void>

redo

  • Redo the edit operation.

    This is invoked by the editor when the user redoes this edit. To implement redo, your extension should restore the document and editor to the state they were in just after this edit was added to the editor's internal edit stack by onDidChangeCustomDocument.

    Returns void | Thenable<void>

Generated using TypeDoc