Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface TextEditor

Represents a text editor. To close editor use 'workbench.action.closeActiveEditor' command.

Hierarchy

  • TextEditor

Index

Properties

document

document: TextDocument

The document associated with this text editor. The document will be the same for the entire lifetime of this text editor.

options

Text editor options.

selection

selection: Selection

The primary selection on this text editor. Shorthand for TextEditor.selections[0].

selections

selections: Selection[]

The selections in this text editor. The primary selection is always at index 0.

Optional viewColumn

viewColumn: ViewColumn

The column in which this editor shows. Will be undefined in case this isn't one of the three main editors, e.g an embedded editor.

visibleRanges

visibleRanges: Range[]

The current visible ranges in the editor (vertically). This accounts only for vertical scrolling, and not for horizontal scrolling.

Methods

edit

  • edit(callback: function, options?: object): Promise<boolean>
  • Perform an edit on the document associated with this text editor.

    The given callback-function is invoked with an edit-builder which must be used to make edits. Note that the edit-builder is only valid while the callback executes.

    Parameters

    • callback: function

      A function which can create edits using an edit-builder.

    • Optional options: object

      The undo/redo behavior around this edit. By default, undo stops will be created before and after this edit.

      • undoStopAfter: boolean
      • undoStopBefore: boolean

    Returns Promise<boolean>

    A promise that resolves with a value indicating if the edits could be applied.

insertSnippet

  • Insert a snippet and put the editor into snippet mode. "Snippet mode" means the editor adds placeholders and additionals cursors so that the user can complete or accept the snippet.

    Parameters

    • snippet: SnippetString

      The snippet to insert in this edit.

    • Optional location: Position | Range | Position[] | Range[]

      Position or range at which to insert the snippet, defaults to the current editor selection or selections.

    • Optional options: object

      The undo/redo behavior around this edit. By default, undo stops will be created before and after this edit.

      • undoStopAfter: boolean
      • undoStopBefore: boolean

    Returns Promise<boolean>

    A promise that resolves with a value indicating if the snippet could be inserted. Note that the promise does not signal that the snippet is completely filled-in or accepted.

revealRange

  • Scroll as indicated by revealType in order to reveal the given range.

    Parameters

    Returns void

setDecorations