<!doctype html>
< html class = "default no-js" lang = "zh-CN" >
< head >
< meta charset = "utf-8" >
< meta http-equiv = "X-UA-Compatible" content = "IE=edge" >
< title > TextEditor | VS Code API 中文文档< / title >
< meta name = "description" content = "VS Code API 是一系列你可以在 Visual Studio Code 扩展中调用的 JavaScript API， >
< meta name = "author" content = "洛竹" >
< meta name = "copyright" content = "洛竹" >
< meta property = "og:title" content = "Vscode Api 中文文档" / >
< meta property = "og:type" content = "docs" >
< meta property = "og:image" content = "https://code.visualstudio.com/favicon.ico" / >
< meta property = "og:url" content = "https://vscode-api-cn.js.org/index.html" >
< meta property = "og:site_name" content = "Vscode Api 中文文档" >
< meta property = "article:tag" content = "vscode api" >
< meta property = "article:tag" content = "vscode api 中文文档" >
< meta property = "article:tag" content = "vscode 插件" >
< meta property = "article:tag" content = "vscode 插件开发" >
< meta property = "article:tag" content = "vscode TextEditor" >
< meta property = "og:description" content = "VS Code API 是一系列你可以在 Visual Studio Code 扩展中调用的 JavaScript API， >
< meta name = "viewport" content = "width=device-width, initial-scale=1" >
< link rel = "shortcut icon" href = "https://code.visualstudio.com/favicon.ico" sizes = "128x128" >
< link rel = 'canonical' href = 'https://vscode-api-cn.js.org/' / >
< link rel = "stylesheet" href = "../assets/css/main.css" >
< script async src = "../assets/js/search.js" id = "search-script" > < / script >
< script async src = "https://pagead2.googlesyndication.com/pagead/js/adsbygoogle.js?client=ca-pub-7962287588031867" crossorigin = "anonymous" > < / script >
< script type = "text/javascript" >
(function (c, l, a, r, i, t, y) {
c[a] = c[a] || function () { (c[a].q = c[a].q || []).push(arguments) };
t = l.createElement(r); t.async = 1; t.src = "https://www.clarity.ms/tag/" + i;
y = l.getElementsByTagName(r)[0]; y.parentNode.insertBefore(t, y);
})(window, document, "clarity", "script", "g1cbw4nxoq");
< / script >
<!-- Google tag (gtag.js) -->
< script async src = "https://www.googletagmanager.com/gtag/js?id=G-T4TRRS1LB1" > < / script >
< script >
window.dataLayer = window.dataLayer || [];
function gtag(){dataLayer.push(arguments);}
gtag('js', new Date());
gtag('config', 'G-T4TRRS1LB1');
< / script >
< style >
.container-main {
padding-bottom: 50px;
}
< / style >
< / head >
< body >
< header >
< div class = "tsd-page-toolbar" >
< div class = "container" >
< div class = "table-wrap" >
< div class = "table-cell" id = "tsd-search" data-index = "../assets/js/search.json" data-base = ".." >
< div class = "field" >
< label for = "tsd-search-field" class = "tsd-widget search no-caption" > Search< / label >
< input id = "tsd-search-field" type = "text" / >
< / div >
< ul class = "results" >
< li class = "state loading" > Preparing search index...< / li >
< li class = "state failure" > The search index is not available< / li >
< / ul >
< a href = "../index.html" class = "title" > VS Code API 中文文档< / a >
< / div >
< div class = "table-cell" id = "tsd-widgets" >
< div id = "tsd-filter" >
< a href = "#" class = "tsd-widget options no-caption" data-toggle = "options" > Options< / a >
< div class = "tsd-filter-group" >
< div class = "tsd-select" id = "tsd-filter-visibility" >
< span class = "tsd-select-label" > All< / span >
< ul class = "tsd-select-list" >
< li data-value = "public" > Public< / li >
< li data-value = "protected" > Public/Protected< / li >
< li data-value = "private" class = "selected" > All< / li >
< / ul >
< / div >
< input type = "checkbox" id = "tsd-filter-inherited" checked / >
< label class = "tsd-widget" for = "tsd-filter-inherited" > Inherited< / label >
< input type = "checkbox" id = "tsd-filter-externals" checked / >
< label class = "tsd-widget" for = "tsd-filter-externals" > Externals< / label >
< / div >
< / div >
< a href = "#" class = "tsd-widget menu no-caption" data-toggle = "menu" > Menu< / a >
< / div >
< / div >
< / div >
< / div >
< div class = "tsd-page-title" >
< div class = "container" >
< ul class = "tsd-breadcrumb" >
< li >
< a href = "../modules.html" > VS Code API 中文文档< / a >
< / li >
< li >
< a href = "../modules/vscode.html" > vscode< / a >
< / li >
< li >
< a href = "vscode.TextEditor.html" > TextEditor< / a >
< / li >
< / ul >
< h1 > Interface TextEditor< / h1 >
< / div >
< / div >
< / header >
< div class = "container container-main" >
< div class = "row" >
< div class = "col-8 col-content" >
< div class = "tsd-panel tsd-typography" >
< script async = "async" data-cfasync = "false"
src="//harassinganticipation.com/c4d7e606982b8dd763aa6f5591967680/invoke.js">< / script >
< div id = "container-c4d7e606982b8dd763aa6f5591967680" > < / div >
< / div >
< section class = "tsd-panel tsd-comment" >
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
< p > Represents an editor that is attached to a < a href = "vscode.TextDocument.html" > document< / a > .< / p >
< / div >
< / div >
< / section >
< section class = "tsd-panel tsd-hierarchy" >
< h3 > 层级< / h3 >
< ul class = "tsd-hierarchy" >
< li >
< span class = "target" > TextEditor< / span >
< / li >
< / ul >
< / section >
< section class = "tsd-panel-group tsd-index-group" >
< h2 > 索引< / h2 >
< section class = "tsd-panel tsd-index-panel" >
< div class = "tsd-index-content" >
< section class = "tsd-index-section " >
< h3 > Properties（ ） < / h3 >
< ul class = "tsd-index-list" >
< li class = "tsd-kind-property tsd-parent-kind-interface" > < a href = "vscode.TextEditor.html#document" class = "tsd-kind-icon" > document< / a > < / li >
< li class = "tsd-kind-property tsd-parent-kind-interface" > < a href = "vscode.TextEditor.html#selection" class = "tsd-kind-icon" > selection< / a > < / li >
< li class = "tsd-kind-property tsd-parent-kind-interface" > < a href = "vscode.TextEditor.html#selections" class = "tsd-kind-icon" > selections< / a > < / li >
< li class = "tsd-kind-property tsd-parent-kind-interface" > < a href = "vscode.TextEditor.html#visibleRanges" class = "tsd-kind-icon" > visible< wbr > Ranges< / a > < / li >
< li class = "tsd-kind-property tsd-parent-kind-interface" > < a href = "vscode.TextEditor.html#options" class = "tsd-kind-icon" > options< / a > < / li >
< li class = "tsd-kind-property tsd-parent-kind-interface" > < a href = "vscode.TextEditor.html#viewColumn" class = "tsd-kind-icon" > view< wbr > Column< / a > < / li >
< / ul >
< / section >
< section class = "tsd-index-section " >
< h3 > Methods（ ） < / h3 >
< ul class = "tsd-index-list" >
< li class = "tsd-kind-method tsd-parent-kind-interface" > < a href = "vscode.TextEditor.html#edit" class = "tsd-kind-icon" > edit< / a > < / li >
< li class = "tsd-kind-method tsd-parent-kind-interface" > < a href = "vscode.TextEditor.html#insertSnippet" class = "tsd-kind-icon" > insert< wbr > Snippet< / a > < / li >
< li class = "tsd-kind-method tsd-parent-kind-interface" > < a href = "vscode.TextEditor.html#setDecorations" class = "tsd-kind-icon" > set< wbr > Decorations< / a > < / li >
< li class = "tsd-kind-method tsd-parent-kind-interface" > < a href = "vscode.TextEditor.html#revealRange" class = "tsd-kind-icon" > reveal< wbr > Range< / a > < / li >
< li class = "tsd-kind-method tsd-parent-kind-interface" > < a href = "vscode.TextEditor.html#show" class = "tsd-kind-icon" > show< / a > < / li >
< li class = "tsd-kind-method tsd-parent-kind-interface" > < a href = "vscode.TextEditor.html#hide" class = "tsd-kind-icon" > hide< / a > < / li >
< / ul >
< / section >
< / div >
< / section >
< / section >
< section class = "tsd-panel-group tsd-member-group " >
< h2 > Properties（ ） < / h2 >
< section class = "tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface" >
< a name = "document" class = "tsd-anchor" > < / a >
< h3 > < span class = "tsd-flag ts-flagReadonly" > Readonly< / span > document< / h3 >
< div class = "tsd-signature tsd-kind-icon" > document< span class = "tsd-signature-symbol" > :< / span > < a href = "vscode.TextDocument.html" class = "tsd-signature-type" data-tsd-kind = "Interface" > TextDocument< / a > < / div >
< aside class = "tsd-sources" >
< ul >
< li > Defined in < a href = "https://github.com/youngjuning/vscode-api-cn/blob/431f26f/vscode.d.ts#L1093" > vscode.d.ts:1093< / a > < / li >
< / ul >
< / aside >
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
< p > The document associated with this text editor. The document will be the same for the entire lifetime of this text editor.< / p >
< / div >
< / div >
< / section >
< section class = "tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface" >
< a name = "selection" class = "tsd-anchor" > < / a >
< h3 > selection< / h3 >
< div class = "tsd-signature tsd-kind-icon" > selection< span class = "tsd-signature-symbol" > :< / span > < a href = "../classes/vscode.Selection.html" class = "tsd-signature-type" data-tsd-kind = "Class" > Selection< / a > < / div >
< aside class = "tsd-sources" >
< ul >
< li > Defined in < a href = "https://github.com/youngjuning/vscode-api-cn/blob/431f26f/vscode.d.ts#L1098" > vscode.d.ts:1098< / a > < / li >
< / ul >
< / aside >
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
< p > The primary selection on this text editor. Shorthand for < code > TextEditor.selections[0]< / code > .< / p >
< / div >
< / div >
< / section >
< section class = "tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface" >
< a name = "selections" class = "tsd-anchor" > < / a >
< h3 > selections< / h3 >
< div class = "tsd-signature tsd-kind-icon" > selections< span class = "tsd-signature-symbol" > :< / span > < a href = "../classes/vscode.Selection.html" class = "tsd-signature-type" data-tsd-kind = "Class" > Selection< / a > < span class = "tsd-signature-symbol" > []< / span > < / div >
< aside class = "tsd-sources" >
< ul >
< li > Defined in < a href = "https://github.com/youngjuning/vscode-api-cn/blob/431f26f/vscode.d.ts#L1103" > vscode.d.ts:1103< / a > < / li >
< / ul >
< / aside >
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
< p > The selections in this text editor. The primary selection is always at index 0.< / p >
< / div >
< / div >
< / section >
< section class = "tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface" >
< a name = "visibleRanges" class = "tsd-anchor" > < / a >
< h3 > < span class = "tsd-flag ts-flagReadonly" > Readonly< / span > visible< wbr > Ranges< / h3 >
< div class = "tsd-signature tsd-kind-icon" > visible< wbr > Ranges< span class = "tsd-signature-symbol" > :< / span > < a href = "../classes/vscode.Range.html" class = "tsd-signature-type" data-tsd-kind = "Class" > Range< / a > < span class = "tsd-signature-symbol" > []< / span > < / div >
< aside class = "tsd-sources" >
< ul >
< li > Defined in < a href = "https://github.com/youngjuning/vscode-api-cn/blob/431f26f/vscode.d.ts#L1109" > vscode.d.ts:1109< / a > < / li >
< / ul >
< / aside >
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
< p > The current visible ranges in the editor (vertically).
This accounts only for vertical scrolling, and not for horizontal scrolling.< / p >
< / div >
< / div >
< / section >
< section class = "tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface" >
< a name = "options" class = "tsd-anchor" > < / a >
< h3 > options< / h3 >
< div class = "tsd-signature tsd-kind-icon" > options< span class = "tsd-signature-symbol" > :< / span > < a href = "vscode.TextEditorOptions.html" class = "tsd-signature-type" data-tsd-kind = "Interface" > TextEditorOptions< / a > < / div >
< aside class = "tsd-sources" >
< ul >
< li > Defined in < a href = "https://github.com/youngjuning/vscode-api-cn/blob/431f26f/vscode.d.ts#L1114" > vscode.d.ts:1114< / a > < / li >
< / ul >
< / aside >
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
< p > Text editor options.< / p >
< / div >
< / div >
< / section >
< section class = "tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface" >
< a name = "viewColumn" class = "tsd-anchor" > < / a >
< h3 > < span class = "tsd-flag ts-flagOptional" > Optional< / span > < span class = "tsd-flag ts-flagReadonly" > Readonly< / span > view< wbr > Column< / h3 >
< div class = "tsd-signature tsd-kind-icon" > view< wbr > Column< span class = "tsd-signature-symbol" > :< / span > < a href = "../enums/vscode.ViewColumn.html" class = "tsd-signature-type" data-tsd-kind = "Enumeration" > ViewColumn< / a > < / div >
< aside class = "tsd-sources" >
< ul >
< li > Defined in < a href = "https://github.com/youngjuning/vscode-api-cn/blob/431f26f/vscode.d.ts#L1121" > vscode.d.ts:1121< / a > < / li >
< / ul >
< / aside >
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
< p > The column in which this editor shows. Will be < code > undefined< / code > in case this
isn' t one of the main editors, e.g. an embedded editor, or when the editor
column is larger than three.< / p >
< / div >
< / div >
< / section >
< / section >
< section class = "tsd-panel-group tsd-member-group " >
< h2 > Methods（ ） < / h2 >
< section class = "tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface" >
< a name = "edit" class = "tsd-anchor" > < / a >
< h3 > edit< / h3 >
< ul class = "tsd-signatures tsd-kind-method tsd-parent-kind-interface" >
< li class = "tsd-signature tsd-kind-icon" > edit< span class = "tsd-signature-symbol" > (< / span > callback< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-symbol" > (< / span > editBuilder< span class = "tsd-signature-symbol" > : < / span > < a href = "vscode.TextEditorEdit.html" class = "tsd-signature-type" data-tsd-kind = "Interface" > TextEditorEdit< / a > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > => < / span > < span class = "tsd-signature-type" > void< / span > , options< span class = "tsd-signature-symbol" > ?: < / span > < span class = "tsd-signature-symbol" > { < / span > undoStopBefore< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > boolean< / span > < span class = "tsd-signature-symbol" > ; < / span > undoStopAfter< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > boolean< / span > < span class = "tsd-signature-symbol" > }< / span > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > : < / span > < a href = "Thenable.html" class = "tsd-signature-type" data-tsd-kind = "Interface" > Thenable< / a > < span class = "tsd-signature-symbol" > < < / span > < span class = "tsd-signature-type" > boolean< / span > < span class = "tsd-signature-symbol" > > < / span > < / li >
< / ul >
< ul class = "tsd-descriptions" >
< li class = "tsd-description" >
< aside class = "tsd-sources" >
< ul >
< li > Defined in < a href = "https://github.com/youngjuning/vscode-api-cn/blob/431f26f/vscode.d.ts#L1134" > vscode.d.ts:1134< / a > < / li >
< / ul >
< / aside >
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
< p > Perform an edit on the document associated with this text editor.< / p >
< / div >
< p > The given callback-function is invoked with an < a href = "vscode.TextEditorEdit.html" > edit-builder< / a > which must
be used to make edits. Note that the edit-builder is only valid while the
callback executes.< / p >
< / div >
< h4 class = "tsd-parameters-title" > Parameters< / h4 >
< ul class = "tsd-parameters" >
< li >
< h5 > callback: < span class = "tsd-signature-symbol" > (< / span > editBuilder< span class = "tsd-signature-symbol" > : < / span > < a href = "vscode.TextEditorEdit.html" class = "tsd-signature-type" data-tsd-kind = "Interface" > TextEditorEdit< / a > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > => < / span > < span class = "tsd-signature-type" > void< / span > < / h5 >
< div class = "tsd-comment tsd-typography" >
< p > A function which can create edits using an < a href = "vscode.TextEditorEdit.html" > edit-builder< / a > .< / p >
< / div >
< ul class = "tsd-parameters" >
< li class = "tsd-parameter-signature" >
< ul class = "tsd-signatures tsd-kind-type-literal" >
< li class = "tsd-signature tsd-kind-icon" > < span class = "tsd-signature-symbol" > (< / span > editBuilder< span class = "tsd-signature-symbol" > : < / span > < a href = "vscode.TextEditorEdit.html" class = "tsd-signature-type" data-tsd-kind = "Interface" > TextEditorEdit< / a > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > void< / span > < / li >
< / ul >
< ul class = "tsd-descriptions" >
< li class = "tsd-description" >
< h4 class = "tsd-parameters-title" > Parameters< / h4 >
< ul class = "tsd-parameters" >
< li >
< h5 > editBuilder: < a href = "vscode.TextEditorEdit.html" class = "tsd-signature-type" data-tsd-kind = "Interface" > TextEditorEdit< / a > < / h5 >
< / li >
< / ul >
< h4 class = "tsd-returns-title" > Returns < span class = "tsd-signature-type" > void< / span > < / h4 >
< / li >
< / ul >
< / li >
< / ul >
< / li >
< li >
< h5 > < span class = "tsd-flag ts-flagOptional" > Optional< / span > options: < span class = "tsd-signature-symbol" > { < / span > undoStopBefore< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > boolean< / span > < span class = "tsd-signature-symbol" > ; < / span > undoStopAfter< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > boolean< / span > < span class = "tsd-signature-symbol" > }< / span > < / h5 >
< div class = "tsd-comment tsd-typography" >
< p > The undo/redo behavior around this edit. By default, undo stops will be created before and after this edit.< / p >
< / div >
< ul class = "tsd-parameters" >
< li class = "tsd-parameter" >
< h5 > undo< wbr > Stop< wbr > Before< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > boolean< / span > < / h5 >
< / li >
< li class = "tsd-parameter" >
< h5 > undo< wbr > Stop< wbr > After< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > boolean< / span > < / h5 >
< / li >
< / ul >
< / li >
< / ul >
< h4 class = "tsd-returns-title" > Returns < a href = "Thenable.html" class = "tsd-signature-type" data-tsd-kind = "Interface" > Thenable< / a > < span class = "tsd-signature-symbol" > < < / span > < span class = "tsd-signature-type" > boolean< / span > < span class = "tsd-signature-symbol" > > < / span > < / h4 >
< p > A promise that resolves with a value indicating if the edits could be applied.< / p >
< / li >
< / ul >
< / section >
< section class = "tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface" >
< a name = "insertSnippet" class = "tsd-anchor" > < / a >
< h3 > insert< wbr > Snippet< / h3 >
< ul class = "tsd-signatures tsd-kind-method tsd-parent-kind-interface" >
< li class = "tsd-signature tsd-kind-icon" > insert< wbr > Snippet< span class = "tsd-signature-symbol" > (< / span > snippet< span class = "tsd-signature-symbol" > : < / span > < a href = "../classes/vscode.SnippetString.html" class = "tsd-signature-type" data-tsd-kind = "Class" > SnippetString< / a > , location< span class = "tsd-signature-symbol" > ?: < / span > < a href = "../classes/vscode.Range.html" class = "tsd-signature-type" data-tsd-kind = "Class" > Range< / a > < span class = "tsd-signature-symbol" > | < / span > < a href = "../classes/vscode.Position.html" class = "tsd-signature-type" data-tsd-kind = "Class" > Position< / a > < span class = "tsd-signature-symbol" > | < / span > < span class = "tsd-signature-symbol" > readonly < / span > < a href = "../classes/vscode.Range.html" class = "tsd-signature-type" data-tsd-kind = "Class" > Range< / a > < span class = "tsd-signature-symbol" > []< / span > < span class = "tsd-signature-symbol" > | < / span > < span class = "tsd-signature-symbol" > readonly < / span > < a href = "../classes/vscode.Position.html" class = "tsd-signature-type" data-tsd-kind = "Class" > Position< / a > < span class = "tsd-signature-symbol" > []< / span > , options< span class = "tsd-signature-symbol" > ?: < / span > < span class = "tsd-signature-symbol" > { < / span > undoStopBefore< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > boolean< / span > < span class = "tsd-signature-symbol" > ; < / span > undoStopAfter< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > boolean< / span > < span class = "tsd-signature-symbol" > }< / span > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > : < / span > < a href = "Thenable.html" class = "tsd-signature-type" data-tsd-kind = "Interface" > Thenable< / a > < span class = "tsd-signature-symbol" > < < / span > < span class = "tsd-signature-type" > boolean< / span > < span class = "tsd-signature-symbol" > > < / span > < / li >
< / ul >
< ul class = "tsd-descriptions" >
< li class = "tsd-description" >
< aside class = "tsd-sources" >
< ul >
< li > Defined in < a href = "https://github.com/youngjuning/vscode-api-cn/blob/431f26f/vscode.d.ts#L1147" > vscode.d.ts:1147< / a > < / li >
< / ul >
< / aside >
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
< p > Insert a < a href = "../classes/vscode.SnippetString.html" > snippet< / a > and put the editor into snippet mode. " Snippet mode"
means the editor adds placeholders and additional cursors so that the user can complete
or accept the snippet.< / p >
< / div >
< / div >
< h4 class = "tsd-parameters-title" > Parameters< / h4 >
< ul class = "tsd-parameters" >
< li >
< h5 > snippet: < a href = "../classes/vscode.SnippetString.html" class = "tsd-signature-type" data-tsd-kind = "Class" > SnippetString< / a > < / h5 >
< div class = "tsd-comment tsd-typography" >
< p > The snippet to insert in this edit.< / p >
< / div >
< / li >
< li >
< h5 > < span class = "tsd-flag ts-flagOptional" > Optional< / span > location: < a href = "../classes/vscode.Range.html" class = "tsd-signature-type" data-tsd-kind = "Class" > Range< / a > < span class = "tsd-signature-symbol" > | < / span > < a href = "../classes/vscode.Position.html" class = "tsd-signature-type" data-tsd-kind = "Class" > Position< / a > < span class = "tsd-signature-symbol" > | < / span > < span class = "tsd-signature-symbol" > readonly < / span > < a href = "../classes/vscode.Range.html" class = "tsd-signature-type" data-tsd-kind = "Class" > Range< / a > < span class = "tsd-signature-symbol" > []< / span > < span class = "tsd-signature-symbol" > | < / span > < span class = "tsd-signature-symbol" > readonly < / span > < a href = "../classes/vscode.Position.html" class = "tsd-signature-type" data-tsd-kind = "Class" > Position< / a > < span class = "tsd-signature-symbol" > []< / span > < / h5 >
< div class = "tsd-comment tsd-typography" >
< p > Position or range at which to insert the snippet, defaults to the current editor selection or selections.< / p >
< / div >
< / li >
< li >
< h5 > < span class = "tsd-flag ts-flagOptional" > Optional< / span > options: < span class = "tsd-signature-symbol" > { < / span > undoStopBefore< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > boolean< / span > < span class = "tsd-signature-symbol" > ; < / span > undoStopAfter< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > boolean< / span > < span class = "tsd-signature-symbol" > }< / span > < / h5 >
< div class = "tsd-comment tsd-typography" >
< p > The undo/redo behavior around this edit. By default, undo stops will be created before and after this edit.< / p >
< / div >
< ul class = "tsd-parameters" >
< li class = "tsd-parameter" >
< h5 > undo< wbr > Stop< wbr > Before< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > boolean< / span > < / h5 >
< / li >
< li class = "tsd-parameter" >
< h5 > undo< wbr > Stop< wbr > After< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > boolean< / span > < / h5 >
< / li >
< / ul >
< / li >
< / ul >
< h4 class = "tsd-returns-title" > Returns < a href = "Thenable.html" class = "tsd-signature-type" data-tsd-kind = "Interface" > Thenable< / a > < span class = "tsd-signature-symbol" > < < / span > < span class = "tsd-signature-type" > boolean< / span > < span class = "tsd-signature-symbol" > > < / span > < / h4 >
< p > 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.< / p >
< / li >
< / ul >
< / section >
< section class = "tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface" >
< a name = "setDecorations" class = "tsd-anchor" > < / a >
< h3 > set< wbr > Decorations< / h3 >
< ul class = "tsd-signatures tsd-kind-method tsd-parent-kind-interface" >
< li class = "tsd-signature tsd-kind-icon" > set< wbr > Decorations< span class = "tsd-signature-symbol" > (< / span > decorationType< span class = "tsd-signature-symbol" > : < / span > < a href = "vscode.TextEditorDecorationType.html" class = "tsd-signature-type" data-tsd-kind = "Interface" > TextEditorDecorationType< / a > , rangesOrOptions< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-symbol" > readonly < / span > < a href = "../classes/vscode.Range.html" class = "tsd-signature-type" data-tsd-kind = "Class" > Range< / a > < span class = "tsd-signature-symbol" > []< / span > < span class = "tsd-signature-symbol" > | < / span > < span class = "tsd-signature-symbol" > readonly < / span > < a href = "vscode.DecorationOptions.html" class = "tsd-signature-type" data-tsd-kind = "Interface" > DecorationOptions< / a > < span class = "tsd-signature-symbol" > []< / span > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > void< / span > < / li >
< / ul >
< ul class = "tsd-descriptions" >
< li class = "tsd-description" >
< aside class = "tsd-sources" >
< ul >
< li > Defined in < a href = "https://github.com/youngjuning/vscode-api-cn/blob/431f26f/vscode.d.ts#L1160" > vscode.d.ts:1160< / a > < / li >
< / ul >
< / aside >
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
< p > Adds a set of decorations to the text editor. If a set of decorations already exists with
the given < a href = "vscode.TextEditorDecorationType.html" > decoration type< / a > , they will be replaced. If
< code > rangesOrOptions< / code > is empty, the existing decorations with the given < a href = "vscode.TextEditorDecorationType.html" > decoration type< / a >
will be removed.< / p >
< / div >
< dl class = "tsd-comment-tags" >
< dt > see< / dt >
< dd > < p > < a href = "../modules/vscode.window.html#createTextEditorDecorationType" > createTextEditorDecorationType< / a > .< / p >
< / dd >
< / dl >
< / div >
< h4 class = "tsd-parameters-title" > Parameters< / h4 >
< ul class = "tsd-parameters" >
< li >
< h5 > decorationType: < a href = "vscode.TextEditorDecorationType.html" class = "tsd-signature-type" data-tsd-kind = "Interface" > TextEditorDecorationType< / a > < / h5 >
< div class = "tsd-comment tsd-typography" >
< p > A decoration type.< / p >
< / div >
< / li >
< li >
< h5 > rangesOrOptions: < span class = "tsd-signature-symbol" > readonly < / span > < a href = "../classes/vscode.Range.html" class = "tsd-signature-type" data-tsd-kind = "Class" > Range< / a > < span class = "tsd-signature-symbol" > []< / span > < span class = "tsd-signature-symbol" > | < / span > < span class = "tsd-signature-symbol" > readonly < / span > < a href = "vscode.DecorationOptions.html" class = "tsd-signature-type" data-tsd-kind = "Interface" > DecorationOptions< / a > < span class = "tsd-signature-symbol" > []< / span > < / h5 >
< div class = "tsd-comment tsd-typography" >
< p > Either < a href = "../classes/vscode.Range.html" > ranges< / a > or more detailed < a href = "vscode.DecorationOptions.html" > options< / a > .< / p >
< / div >
< / li >
< / ul >
< h4 class = "tsd-returns-title" > Returns < span class = "tsd-signature-type" > void< / span > < / h4 >
< / li >
< / ul >
< / section >
< section class = "tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface" >
< a name = "revealRange" class = "tsd-anchor" > < / a >
< h3 > reveal< wbr > Range< / h3 >
< ul class = "tsd-signatures tsd-kind-method tsd-parent-kind-interface" >
< li class = "tsd-signature tsd-kind-icon" > reveal< wbr > Range< span class = "tsd-signature-symbol" > (< / span > range< span class = "tsd-signature-symbol" > : < / span > < a href = "../classes/vscode.Range.html" class = "tsd-signature-type" data-tsd-kind = "Class" > Range< / a > , revealType< span class = "tsd-signature-symbol" > ?: < / span > < a href = "../enums/vscode.TextEditorRevealType.html" class = "tsd-signature-type" data-tsd-kind = "Enumeration" > TextEditorRevealType< / a > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > void< / span > < / li >
< / ul >
< ul class = "tsd-descriptions" >
< li class = "tsd-description" >
< aside class = "tsd-sources" >
< ul >
< li > Defined in < a href = "https://github.com/youngjuning/vscode-api-cn/blob/431f26f/vscode.d.ts#L1168" > vscode.d.ts:1168< / a > < / li >
< / ul >
< / aside >
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
< p > Scroll as indicated by < code > revealType< / code > in order to reveal the given range.< / p >
< / div >
< / div >
< h4 class = "tsd-parameters-title" > Parameters< / h4 >
< ul class = "tsd-parameters" >
< li >
< h5 > range: < a href = "../classes/vscode.Range.html" class = "tsd-signature-type" data-tsd-kind = "Class" > Range< / a > < / h5 >
< div class = "tsd-comment tsd-typography" >
< p > A range.< / p >
< / div >
< / li >
< li >
< h5 > < span class = "tsd-flag ts-flagOptional" > Optional< / span > revealType: < a href = "../enums/vscode.TextEditorRevealType.html" class = "tsd-signature-type" data-tsd-kind = "Enumeration" > TextEditorRevealType< / a > < / h5 >
< div class = "tsd-comment tsd-typography" >
< p > The scrolling strategy for revealing < code > range< / code > .< / p >
< / div >
< / li >
< / ul >
< h4 class = "tsd-returns-title" > Returns < span class = "tsd-signature-type" > void< / span > < / h4 >
< / li >
< / ul >
< / section >
< section class = "tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface" >
< a name = "show" class = "tsd-anchor" > < / a >
< h3 > show< / h3 >
< ul class = "tsd-signatures tsd-kind-method tsd-parent-kind-interface" >
< li class = "tsd-signature tsd-kind-icon" > show< span class = "tsd-signature-symbol" > (< / span > column< span class = "tsd-signature-symbol" > ?: < / span > < a href = "../enums/vscode.ViewColumn.html" class = "tsd-signature-type" data-tsd-kind = "Enumeration" > ViewColumn< / a > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > void< / span > < / li >
< / ul >
< ul class = "tsd-descriptions" >
< li class = "tsd-description" >
< aside class = "tsd-sources" >
< ul >
< li > Defined in < a href = "https://github.com/youngjuning/vscode-api-cn/blob/431f26f/vscode.d.ts#L1178" > vscode.d.ts:1178< / a > < / li >
< / ul >
< / aside >
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
< p > Show the text editor.< / p >
< / div >
< dl class = "tsd-comment-tags" >
< dt > deprecated< / dt >
< dd > < p > Use < a href = "../modules/vscode.window.html#showTextDocument" > window.showTextDocument< / a > instead.< / p >
< / dd >
< / dl >
< / div >
< h4 class = "tsd-parameters-title" > Parameters< / h4 >
< ul class = "tsd-parameters" >
< li >
< h5 > < span class = "tsd-flag ts-flagOptional" > Optional< / span > column: < a href = "../enums/vscode.ViewColumn.html" class = "tsd-signature-type" data-tsd-kind = "Enumeration" > ViewColumn< / a > < / h5 >
< div class = "tsd-comment tsd-typography" >
< p > The < a href = "../enums/vscode.ViewColumn.html" > column< / a > in which to show this editor.
This method shows unexpected behavior and will be removed in the next major update.< / p >
< / div >
< / li >
< / ul >
< h4 class = "tsd-returns-title" > Returns < span class = "tsd-signature-type" > void< / span > < / h4 >
< / li >
< / ul >
< / section >
< section class = "tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface" >
< a name = "hide" class = "tsd-anchor" > < / a >
< h3 > hide< / h3 >
< ul class = "tsd-signatures tsd-kind-method tsd-parent-kind-interface" >
< li class = "tsd-signature tsd-kind-icon" > hide< span class = "tsd-signature-symbol" > (< / span > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > void< / span > < / li >
< / ul >
< ul class = "tsd-descriptions" >
< li class = "tsd-description" >
< aside class = "tsd-sources" >
< ul >
< li > Defined in < a href = "https://github.com/youngjuning/vscode-api-cn/blob/431f26f/vscode.d.ts#L1186" > vscode.d.ts:1186< / a > < / li >
< / ul >
< / aside >
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
< p > Hide the text editor.< / p >
< / div >
< dl class = "tsd-comment-tags" >
< dt > deprecated< / dt >
< dd > < p > Use the command < code > workbench.action.closeActiveEditor< / code > instead.
This method shows unexpected behavior and will be removed in the next major update.< / p >
< / dd >
< / dl >
< / div >
< h4 class = "tsd-returns-title" > Returns < span class = "tsd-signature-type" > void< / span > < / h4 >
< / li >
< / ul >
< / section >
< / section >
< div class = "tsd-panel tsd-typography" >
< ins class = "adsbygoogle" style = "display:block" data-ad-format = "autorelaxed" data-ad-client = "ca-pub-7962287588031867"
data-ad-slot="3578139931">< / ins >
< script > ( adsbygoogle = window . adsbygoogle || [ ] ) . push ( { } ) ; < / script >
< / div >
< / div >
< div class = "col-4 col-menu menu-sticky-wrap menu-highlight" >
< nav class = "tsd-navigation primary" >
< ul >
< li class = " " >
< a href = "../modules.html" > Exports< / a >
< / li >
< li class = "current tsd-kind-namespace" >
< a href = "../modules/vscode.html" > vscode< / a >
< ul >
< li class = " tsd-kind-namespace tsd-parent-kind-namespace" >
< a href = "../modules/vscode.authentication.html" > authentication< / a >
< / li >
< li class = " tsd-kind-namespace tsd-parent-kind-namespace" >
< a href = "../modules/vscode.commands.html" > commands< / a >
< / li >
< li class = " tsd-kind-namespace tsd-parent-kind-namespace" >
< a href = "../modules/vscode.comments.html" > comments< / a >
< / li >
< li class = " tsd-kind-namespace tsd-parent-kind-namespace" >
< a href = "../modules/vscode.debug.html" > debug< / a >
< / li >
< li class = " tsd-kind-namespace tsd-parent-kind-namespace" >
< a href = "../modules/vscode.env.html" > env< / a >
< / li >
< li class = " tsd-kind-namespace tsd-parent-kind-namespace" >
< a href = "../modules/vscode.extensions.html" > extensions< / a >
< / li >
< li class = " tsd-kind-namespace tsd-parent-kind-namespace" >
< a href = "../modules/vscode.languages.html" > languages< / a >
< / li >
< li class = " tsd-kind-namespace tsd-parent-kind-namespace" >
< a href = "../modules/vscode.notebooks.html" > notebooks< / a >
< / li >
< li class = " tsd-kind-namespace tsd-parent-kind-namespace" >
< a href = "../modules/vscode.scm.html" > scm< / a >
< / li >
< li class = " tsd-kind-namespace tsd-parent-kind-namespace" >
< a href = "../modules/vscode.tasks.html" > tasks< / a >
< / li >
< li class = " tsd-kind-namespace tsd-parent-kind-namespace" >
< a href = "../modules/vscode.tests.html" > tests< / a >
< / li >
< li class = " tsd-kind-namespace tsd-parent-kind-namespace" >
< a href = "../modules/vscode.window.html" > window< / a >
< / li >
< li class = " tsd-kind-namespace tsd-parent-kind-namespace" >
< a href = "../modules/vscode.workspace.html" > workspace< / a >
< / li >
< / ul >
< / li >
< / ul >
< / nav >
< nav class = "tsd-navigation secondary menu-sticky" >
< div style = "width: 200px" >
< script type = "text/javascript" id = "clstr_globe" src = "//clustrmaps.com/globe.js?d=cMnk-gSDNcAzNMMm67U8rWRaHnjUc0Xb0giSGndepK4" > < / script >
< / div >
< ul class = "before-current" >
< / ul >
< ul class = "current" >
< li class = "current tsd-kind-interface tsd-parent-kind-namespace" >
< a href = "vscode.TextEditor.html" class = "tsd-kind-icon" > Text< wbr > Editor< / a >
< ul >
< li class = " tsd-kind-property tsd-parent-kind-interface" >
< a href = "vscode.TextEditor.html#document" class = "tsd-kind-icon" > document< / a >
< / li >
< li class = " tsd-kind-property tsd-parent-kind-interface" >
< a href = "vscode.TextEditor.html#selection" class = "tsd-kind-icon" > selection< / a >
< / li >
< li class = " tsd-kind-property tsd-parent-kind-interface" >
< a href = "vscode.TextEditor.html#selections" class = "tsd-kind-icon" > selections< / a >
< / li >
< li class = " tsd-kind-property tsd-parent-kind-interface" >
< a href = "vscode.TextEditor.html#visibleRanges" class = "tsd-kind-icon" > visible< wbr > Ranges< / a >
< / li >
< li class = " tsd-kind-property tsd-parent-kind-interface" >
< a href = "vscode.TextEditor.html#options" class = "tsd-kind-icon" > options< / a >
< / li >
< li class = " tsd-kind-property tsd-parent-kind-interface" >
< a href = "vscode.TextEditor.html#viewColumn" class = "tsd-kind-icon" > view< wbr > Column< / a >
< / li >
< li class = " tsd-kind-method tsd-parent-kind-interface" >
< a href = "vscode.TextEditor.html#edit" class = "tsd-kind-icon" > edit< / a >
< / li >
< li class = " tsd-kind-method tsd-parent-kind-interface" >
< a href = "vscode.TextEditor.html#insertSnippet" class = "tsd-kind-icon" > insert< wbr > Snippet< / a >
< / li >
< li class = " tsd-kind-method tsd-parent-kind-interface" >
< a href = "vscode.TextEditor.html#setDecorations" class = "tsd-kind-icon" > set< wbr > Decorations< / a >
< / li >
< li class = " tsd-kind-method tsd-parent-kind-interface" >
< a href = "vscode.TextEditor.html#revealRange" class = "tsd-kind-icon" > reveal< wbr > Range< / a >
< / li >
< li class = " tsd-kind-method tsd-parent-kind-interface" >
< a href = "vscode.TextEditor.html#show" class = "tsd-kind-icon" > show< / a >
< / li >
< li class = " tsd-kind-method tsd-parent-kind-interface" >
< a href = "vscode.TextEditor.html#hide" class = "tsd-kind-icon" > hide< / a >
< / li >
< / ul >
< / li >
< / ul >
< ul class = "after-current" >
< / ul >
< / nav >
< / div >
< / div >
< / div >
< footer class = "with-border-bottom" >
< div class = "container" >
< h2 > 图例< / h2 >
< div class = "tsd-legend-group" >
< ul class = "tsd-legend" >
< li class = "tsd-kind-property tsd-parent-kind-interface" > < span class = "tsd-kind-icon" > Property< / span > < / li >
< li class = "tsd-kind-method tsd-parent-kind-interface" > < span class = "tsd-kind-icon" > Method< / span > < / li >
< / ul >
< / div >
< / div >
< / footer >
< div class = "container tsd-generator" >
< p > 友链：< a href = "https://jeasonstudio.gitbooks.io/vscode-cn-doc/content/" target = "_blank" > VS Code 中文文档< / a > | < a href = "https://code.visualstudio.com/docs" target = "_blank" > VS Code 官网文档< / a > | < a href = "https://marketplace.visualstudio.com/" target = "_blank" > VS Code 扩展市场< / a > < / p >
< p > Generated by < a href = "https://typedoc.org/" target = "_blank" > TypeDoc< / a > . Maintained by < a href = "https://youngjuning.js.org" target = "_blank" > 洛竹< / a > < / p >
< / div >
< div class = "overlay" > < / div >
< script src = "../assets/js/main.js" > < / script >
< / body >
< / html >
