Interface TextDocument

Represents a text document, such as a source file. Text documents have lines and knowledge about an underlying resource like a file.

interface TextDocument {
    eol: EndOfLine;
    fileName: string;
    isClosed: boolean;
    isDirty: boolean;
    isUntitled: boolean;
    languageId: string;
    lineCount: number;
    uri: Uri;
    version: number;
    getText(range?): string;
    getWordRangeAtPosition(position, regex?): undefined | Range;
    lineAt(line): TextLine;
    lineAt(position): TextLine;
    offsetAt(position): number;
    positionAt(offset): Position;
    save(): Thenable<boolean>;
    validatePosition(position): Position;
    validateRange(range): Range;
}

Properties

eol fileName isClosed isDirty isUntitled languageId lineCount uri version

Methods

getText getWordRangeAtPosition lineAt offsetAt positionAt save validatePosition validateRange

Properties

Readonly eol

eol: EndOfLine

The end of line sequence that is predominately used in this document.

Readonly fileName

fileName: string

The file system path of the associated resource. Shorthand notation for TextDocument.uri.fsPath. Independent of the uri scheme.

Readonly isClosed

isClosed: boolean

true if the document have been closed. A closed document isn't synchronized anymore and won't be re-used when the same resource is opened again.

Readonly isDirty

isDirty: boolean

true if there are unpersisted changes.

Readonly isUntitled

isUntitled: boolean

Is this document representing an untitled file which has never been saved yet. Note that this does not mean the document will be saved to disk, use uri.scheme to figure out where a document will be saved, e.g. file, ftp etc.

Readonly languageId

languageId: string

The identifier of the language associated with this document.

Readonly lineCount

lineCount: number

The number of lines in this document.

Readonly uri

uri: Uri

The associated uri for this document.

Note that most documents use the file-scheme, which means they are files on disk. However, not all documents are saved on disk and therefore the scheme must be checked before trying to access the underlying file or siblings on disk.

See

Readonly version

version: number

The version number of this document (it will strictly increase after each change, including undo/redo).

Methods

getText

  • getText(range?): string

  • Get the text of this document. A substring can be retrieved by providing a range. The range will be adjusted.

    Parameters

    • Optional range: Range

      Include only the text included by the range.

    Returns string

    The text inside the provided range or the entire text.

getWordRangeAtPosition

  • getWordRangeAtPosition(position, regex?): undefined | Range

  • Get a word-range at the given position. By default words are defined by common separators, like space, -, _, etc. In addition, per language custom word definitions can be defined. It is also possible to provide a custom regular expression.

    • Note 1: A custom regular expression must not match the empty string and if it does, it will be ignored.
    • Note 2: A custom regular expression will fail to match multiline strings and in the name of speed regular expressions should not match words with spaces. Use TextLine.text for more complex, non-wordy, scenarios.

    The position will be adjusted.

    Parameters

    • position: Position

      A position.

    • Optional regex: RegExp

      Optional regular expression that describes what a word is.

    Returns undefined | Range

    A range spanning a word, or undefined.

lineAt

offsetAt

positionAt

save

validatePosition

validateRange

Settings

Member Visibility

Theme

On This Page

eolfileNameisClosedisDirtyisUntitledlanguageIdlineCounturiversiongetTextgetWordRangeAtPositionlineAtoffsetAtpositionAtsavevalidatePositionvalidateRange