<!doctype html>
< html class = "default no-js" >
< head >
< meta charset = "utf-8" >
< meta http-equiv = "X-UA-Compatible" content = "IE=edge" >
< title > TextEditorEdit | VS Code API 中文文档< / title >
< meta name = "description" content = "Documentation for VS Code API 中文文档" >
< meta name = "viewport" content = "width=device-width, initial-scale=1" >
< link rel = "stylesheet" href = "../assets/css/main.css" >
< script async src = "../assets/js/search.js" id = "search-script" > < / script >
< / 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 = "../index.html" > VS Code API 中文文档< / a >
< / li >
< li >
< a href = "TextEditorEdit.html" > TextEditorEdit< / a >
< / li >
< / ul >
< h1 > Interface TextEditorEdit< / h1 >
< / div >
< / div >
< / header >
< div class = "container container-main" >
< div class = "row" >
< div class = "col-8 col-content" >
< section class = "tsd-panel tsd-comment" >
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
< p > A complex edit that will be applied in one transaction on a TextEditor.
This holds a description of the edits and if the edits are valid (i.e. no overlapping regions, document was not changed in the meantime, etc.)
they can be applied on a < a href = "TextDocument.html" > document< / a > associated with a < a href = "TextEditor.html" > text editor< / a > .< / p >
< / div >
< / div >
< / section >
< section class = "tsd-panel tsd-hierarchy" >
< h3 > Hierarchy< / h3 >
< ul class = "tsd-hierarchy" >
< li >
< span class = "target" > TextEditorEdit< / span >
< / li >
< / ul >
< / section >
< section class = "tsd-panel-group tsd-index-group" >
< h2 > Index< / h2 >
< section class = "tsd-panel tsd-index-panel" >
< div class = "tsd-index-content" >
< section class = "tsd-index-section " >
< h3 > Methods< / h3 >
< ul class = "tsd-index-list" >
< li class = "tsd-kind-method tsd-parent-kind-interface" > < a href = "TextEditorEdit.html#replace" class = "tsd-kind-icon" > replace< / a > < / li >
< li class = "tsd-kind-method tsd-parent-kind-interface" > < a href = "TextEditorEdit.html#insert" class = "tsd-kind-icon" > insert< / a > < / li >
< li class = "tsd-kind-method tsd-parent-kind-interface" > < a href = "TextEditorEdit.html#delete" class = "tsd-kind-icon" > delete< / a > < / li >
< li class = "tsd-kind-method tsd-parent-kind-interface" > < a href = "TextEditorEdit.html#setEndOfLine" class = "tsd-kind-icon" > set< wbr > End< wbr > OfLine< / a > < / li >
< / ul >
< / section >
< / 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 = "replace" class = "tsd-anchor" > < / a >
< h3 > replace< / h3 >
< ul class = "tsd-signatures tsd-kind-method tsd-parent-kind-interface" >
< li class = "tsd-signature tsd-kind-icon" > replace< span class = "tsd-signature-symbol" > (< / span > location< span class = "tsd-signature-symbol" > : < / span > < a href = "../classes/Range.html" class = "tsd-signature-type" data-tsd-kind = "Class" > Range< / a > < span class = "tsd-signature-symbol" > | < / span > < a href = "../classes/Position.html" class = "tsd-signature-type" data-tsd-kind = "Class" > Position< / a > < span class = "tsd-signature-symbol" > | < / span > < a href = "../classes/Selection.html" class = "tsd-signature-type" data-tsd-kind = "Class" > Selection< / a > , value< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > string< / 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/blob/bc2a9f9/vscode.d.ts#L1220" > vscode.d.ts:1220< / a > < / li >
< / ul >
< / aside >
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
< p > Replace a certain text region with a new value.
You can use \r\n or \n in < code > value< / code > and they will be normalized to the current < a href = "TextDocument.html" > document< / a > .< / p >
< / div >
< / div >
< h4 class = "tsd-parameters-title" > Parameters< / h4 >
< ul class = "tsd-parameters" >
< li >
< h5 > location: < a href = "../classes/Range.html" class = "tsd-signature-type" data-tsd-kind = "Class" > Range< / a > < span class = "tsd-signature-symbol" > | < / span > < a href = "../classes/Position.html" class = "tsd-signature-type" data-tsd-kind = "Class" > Position< / a > < span class = "tsd-signature-symbol" > | < / span > < a href = "../classes/Selection.html" class = "tsd-signature-type" data-tsd-kind = "Class" > Selection< / a > < / h5 >
< div class = "tsd-comment tsd-typography" >
< p > The range this operation should remove.< / p >
< / div >
< / li >
< li >
< h5 > value: < span class = "tsd-signature-type" > string< / span > < / h5 >
< div class = "tsd-comment tsd-typography" >
< p > The new text this operation should insert after removing < code > location< / 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 = "insert" class = "tsd-anchor" > < / a >
< h3 > insert< / h3 >
< ul class = "tsd-signatures tsd-kind-method tsd-parent-kind-interface" >
< li class = "tsd-signature tsd-kind-icon" > insert< span class = "tsd-signature-symbol" > (< / span > location< span class = "tsd-signature-symbol" > : < / span > < a href = "../classes/Position.html" class = "tsd-signature-type" data-tsd-kind = "Class" > Position< / a > , value< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > string< / 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/blob/bc2a9f9/vscode.d.ts#L1230" > vscode.d.ts:1230< / a > < / li >
< / ul >
< / aside >
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
< p > Insert text at a location.
You can use \r\n or \n in < code > value< / code > and they will be normalized to the current < a href = "TextDocument.html" > document< / a > .
Although the equivalent text edit can be made with < a href = "TextEditorEdit.html#replace" > replace< / a > , < code > insert< / code > will produce a different resulting selection (it will get moved).< / p >
< / div >
< / div >
< h4 class = "tsd-parameters-title" > Parameters< / h4 >
< ul class = "tsd-parameters" >
< li >
< h5 > location: < a href = "../classes/Position.html" class = "tsd-signature-type" data-tsd-kind = "Class" > Position< / a > < / h5 >
< div class = "tsd-comment tsd-typography" >
< p > The position where the new text should be inserted.< / p >
< / div >
< / li >
< li >
< h5 > value: < span class = "tsd-signature-type" > string< / span > < / h5 >
< div class = "tsd-comment tsd-typography" >
< p > The new text this operation should insert.< / 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 = "delete" class = "tsd-anchor" > < / a >
< h3 > delete< / h3 >
< ul class = "tsd-signatures tsd-kind-method tsd-parent-kind-interface" >
< li class = "tsd-signature tsd-kind-icon" > delete< span class = "tsd-signature-symbol" > (< / span > location< span class = "tsd-signature-symbol" > : < / span > < a href = "../classes/Range.html" class = "tsd-signature-type" data-tsd-kind = "Class" > Range< / a > < span class = "tsd-signature-symbol" > | < / span > < a href = "../classes/Selection.html" class = "tsd-signature-type" data-tsd-kind = "Class" > Selection< / 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/blob/bc2a9f9/vscode.d.ts#L1237" > vscode.d.ts:1237< / a > < / li >
< / ul >
< / aside >
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
< p > Delete a certain text region.< / p >
< / div >
< / div >
< h4 class = "tsd-parameters-title" > Parameters< / h4 >
< ul class = "tsd-parameters" >
< li >
< h5 > location: < a href = "../classes/Range.html" class = "tsd-signature-type" data-tsd-kind = "Class" > Range< / a > < span class = "tsd-signature-symbol" > | < / span > < a href = "../classes/Selection.html" class = "tsd-signature-type" data-tsd-kind = "Class" > Selection< / a > < / h5 >
< div class = "tsd-comment tsd-typography" >
< p > The range this operation should remove.< / 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 = "setEndOfLine" class = "tsd-anchor" > < / a >
< h3 > set< wbr > End< wbr > OfLine< / h3 >
< ul class = "tsd-signatures tsd-kind-method tsd-parent-kind-interface" >
< li class = "tsd-signature tsd-kind-icon" > set< wbr > End< wbr > OfLine< span class = "tsd-signature-symbol" > (< / span > endOfLine< span class = "tsd-signature-symbol" > : < / span > < a href = "../enums/EndOfLine.html" class = "tsd-signature-type" data-tsd-kind = "Enumeration" > EndOfLine< / 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/blob/bc2a9f9/vscode.d.ts#L1244" > vscode.d.ts:1244< / a > < / li >
< / ul >
< / aside >
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
< p > Set the end of line sequence.< / p >
< / div >
< / div >
< h4 class = "tsd-parameters-title" > Parameters< / h4 >
< ul class = "tsd-parameters" >
< li >
< h5 > endOfLine: < a href = "../enums/EndOfLine.html" class = "tsd-signature-type" data-tsd-kind = "Enumeration" > EndOfLine< / a > < / h5 >
< div class = "tsd-comment tsd-typography" >
< p > The new end of line for the < a href = "TextDocument.html" > document< / a > .< / p >
< / div >
< / li >
< / ul >
< h4 class = "tsd-returns-title" > Returns < span class = "tsd-signature-type" > void< / span > < / h4 >
< / li >
< / ul >
< / section >
< / section >
< / div >
< div class = "col-4 col-menu menu-sticky-wrap menu-highlight" >
< nav class = "tsd-navigation primary" >
< ul >
< li class = " " >
< a href = "../index.html" > Exports< / a >
< / li >
< / ul >
< / nav >
< nav class = "tsd-navigation secondary menu-sticky" >
< ul class = "before-current" >
< / ul >
< ul class = "current" >
< li class = "current tsd-kind-interface" >
< a href = "TextEditorEdit.html" class = "tsd-kind-icon" > Text< wbr > Editor< wbr > Edit< / a >
< ul >
< li class = " tsd-kind-method tsd-parent-kind-interface" >
< a href = "TextEditorEdit.html#replace" class = "tsd-kind-icon" > replace< / a >
< / li >
< li class = " tsd-kind-method tsd-parent-kind-interface" >
< a href = "TextEditorEdit.html#insert" class = "tsd-kind-icon" > insert< / a >
< / li >
< li class = " tsd-kind-method tsd-parent-kind-interface" >
< a href = "TextEditorEdit.html#delete" class = "tsd-kind-icon" > delete< / a >
< / li >
< li class = " tsd-kind-method tsd-parent-kind-interface" >
< a href = "TextEditorEdit.html#setEndOfLine" class = "tsd-kind-icon" > set< wbr > End< wbr > OfLine< / a >
< / li >
< / ul >
< / li >
< / ul >
< ul class = "after-current" >
< / ul >
< / nav >
< / div >
< / div >
< / div >
< footer class = "with-border-bottom" >
< div class = "container" >
< h2 > Legend< / h2 >
< div class = "tsd-legend-group" >
< ul class = "tsd-legend" >
< li class = "tsd-kind-constructor tsd-parent-kind-class" > < span class = "tsd-kind-icon" > Constructor< / span > < / li >
< li class = "tsd-kind-property tsd-parent-kind-class" > < span class = "tsd-kind-icon" > Property< / span > < / li >
< li class = "tsd-kind-method tsd-parent-kind-class" > < span class = "tsd-kind-icon" > Method< / span > < / li >
< / ul >
< 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 >
< ul class = "tsd-legend" >
< li class = "tsd-kind-property tsd-parent-kind-class tsd-is-inherited" > < span class = "tsd-kind-icon" > Inherited property< / span > < / li >
< li class = "tsd-kind-method tsd-parent-kind-class tsd-is-inherited" > < span class = "tsd-kind-icon" > Inherited method< / span > < / li >
< / ul >
< ul class = "tsd-legend" >
< li class = "tsd-kind-property tsd-parent-kind-class tsd-is-static" > < span class = "tsd-kind-icon" > Static property< / span > < / li >
< li class = "tsd-kind-method tsd-parent-kind-class tsd-is-static" > < span class = "tsd-kind-icon" > Static method< / span > < / li >
< / ul >
< / div >
< / div >
< / footer >
< div class = "container tsd-generator" >
< p > Generated using < a href = "https://typedoc.org/" target = "_blank" > TypeDoc< / a > < / p >
< / div >
< div class = "overlay" > < / div >
< script src = "../assets/js/main.js" > < / script >
< / body >
< / html >
