yetao
/
vscode-api-cn.js
mirror of https://github.com/youngjuning/vscode-api-cn.js.org.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from 'cccde04c08'
${ noResults }
vscode-api-cn.js/interfaces/TextEditor.html

601 lines
36 KiB
Raw Blame History Escape

This file contains ambiguous Unicode characters!

This file contains ambiguous Unicode characters that may be confused with others in your current locale. If your use case is intentional and legitimate, you can safely ignore this warning. Use the Escape button to highlight these characters.

<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>TextEditor | 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="shortcut icon" href="https://code.visualstudio.com/favicon.ico" sizes="128x128">
<link rel="stylesheet" href="../assets/css/main.css">
<script async src="../assets/js/search.js" id="search-script"></script>
<style>
a[title="站长统计"] {
display: none;
}
.github-corner svg {
z-index: 1;
}
.github-corner:hover .octo-arm {
animation:octocat-wave 560ms ease-in-out
}
@keyframes octocat-wave {
0%,100%{transform:rotate(0)}
20%,60%{transform:rotate(-25deg)}
40%,80%{transform:rotate(10deg)}
}
@media (max-width:500px) {
.github-corner:hover
.octo-arm{animation:none}
.github-corner .octo-arm{
animation:octocat-wave 560ms ease-in-out
}
}
.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="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">
<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="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（6）</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="TextEditor.html#document" class="tsd-kind-icon">document</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="TextEditor.html#selection" class="tsd-kind-icon">selection</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="TextEditor.html#selections" class="tsd-kind-icon">selections</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="TextEditor.html#visibleRanges" class="tsd-kind-icon">visible<wbr>Ranges</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="TextEditor.html#options" class="tsd-kind-icon">options</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="TextEditor.html#viewColumn" class="tsd-kind-icon">view<wbr>Column</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Methods（6）</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="TextEditor.html#edit" class="tsd-kind-icon">edit</a></li>
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="TextEditor.html#insertSnippet" class="tsd-kind-icon">insert<wbr>Snippet</a></li>
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="TextEditor.html#setDecorations" class="tsd-kind-icon">set<wbr>Decorations</a></li>
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="TextEditor.html#revealRange" class="tsd-kind-icon">reveal<wbr>Range</a></li>
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="TextEditor.html#show" class="tsd-kind-icon">show</a></li>
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="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（6）</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="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/vscode-cn/vscode-api-cn/blob/29a9fb5/vscode.d.ts#L1097">vscode.d.ts:1097</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/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/vscode-cn/vscode-api-cn/blob/29a9fb5/vscode.d.ts#L1102">vscode.d.ts:1102</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/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/vscode-cn/vscode-api-cn/blob/29a9fb5/vscode.d.ts#L1107">vscode.d.ts:1107</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/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/vscode-cn/vscode-api-cn/blob/29a9fb5/vscode.d.ts#L1113">vscode.d.ts:1113</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="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/vscode-cn/vscode-api-cn/blob/29a9fb5/vscode.d.ts#L1118">vscode.d.ts:1118</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/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/vscode-cn/vscode-api-cn/blob/29a9fb5/vscode.d.ts#L1125">vscode.d.ts:1125</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&#39;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（6）</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="TextEditorEdit.html" class="tsd-signature-type" data-tsd-kind="Interface">TextEditorEdit</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </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">&lt;</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vscode-cn/vscode-api-cn/blob/29a9fb5/vscode.d.ts#L1138">vscode.d.ts:1138</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="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="TextEditorEdit.html" class="tsd-signature-type" data-tsd-kind="Interface">TextEditorEdit</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </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="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="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="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">&lt;</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">&gt;</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/SnippetString.html" class="tsd-signature-type" data-tsd-kind="Class">SnippetString</a>, 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><span class="tsd-signature-symbol">readonly </span><a href="../classes/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/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">&lt;</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vscode-cn/vscode-api-cn/blob/29a9fb5/vscode.d.ts#L1151">vscode.d.ts:1151</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Insert a <a href="../classes/SnippetString.html">snippet</a> and put the editor into snippet mode. &quot;Snippet mode&quot;
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/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/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><span class="tsd-signature-symbol">readonly </span><a href="../classes/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/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">&lt;</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">&gt;</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="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/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="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/vscode-cn/vscode-api-cn/blob/29a9fb5/vscode.d.ts#L1164">vscode.d.ts:1164</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="TextEditorDecorationType.html">decoration type</a>, they will be replaced. If
<code>rangesOrOptions</code> is empty, the existing decorations with the given <a href="TextEditorDecorationType.html">decoration type</a>
will be removed.</p>
</div>
<dl class="tsd-comment-tags">
<dt>see</dt>
<dd><p><a href="../modules/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="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/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="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/Range.html">ranges</a> or more detailed <a href="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/Range.html" class="tsd-signature-type" data-tsd-kind="Class">Range</a>, revealType<span class="tsd-signature-symbol">?: </span><a href="../enums/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/vscode-cn/vscode-api-cn/blob/29a9fb5/vscode.d.ts#L1172">vscode.d.ts:1172</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/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/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/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/vscode-cn/vscode-api-cn/blob/29a9fb5/vscode.d.ts#L1182">vscode.d.ts:1182</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/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/ViewColumn.html" class="tsd-signature-type" data-tsd-kind="Enumeration">ViewColumn</a></h5>
<div class="tsd-comment tsd-typography">
<p>The <a href="../enums/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/vscode-cn/vscode-api-cn/blob/29a9fb5/vscode.d.ts#L1190">vscode.d.ts:1190</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>
<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>
</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="TextEditor.html" class="tsd-kind-icon">Text<wbr>Editor</a>
<ul>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="TextEditor.html#document" class="tsd-kind-icon">document</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="TextEditor.html#selection" class="tsd-kind-icon">selection</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="TextEditor.html#selections" class="tsd-kind-icon">selections</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="TextEditor.html#visibleRanges" class="tsd-kind-icon">visible<wbr>Ranges</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="TextEditor.html#options" class="tsd-kind-icon">options</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="TextEditor.html#viewColumn" class="tsd-kind-icon">view<wbr>Column</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-interface">
<a href="TextEditor.html#edit" class="tsd-kind-icon">edit</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-interface">
<a href="TextEditor.html#insertSnippet" class="tsd-kind-icon">insert<wbr>Snippet</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-interface">
<a href="TextEditor.html#setDecorations" class="tsd-kind-icon">set<wbr>Decorations</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-interface">
<a href="TextEditor.html#revealRange" class="tsd-kind-icon">reveal<wbr>Range</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-interface">
<a href="TextEditor.html#show" class="tsd-kind-icon">show</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-interface">
<a href="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-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><a href="https://liiked.github.io/VS-Code-Extension-Doc-ZH/" target="_blank">VS Code 插件开发中文文档</a> | <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> | <a href="https://www.cnzz.com/stat/website.php?web_id=1280241129" target="_blank" title="VS Code 官网文档站长统计">站长统计</a></p>
</div>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
<script type="text/javascript">document.write(unescape("%3Cspan id='cnzz_stat_icon_1280241129'%3E%3C/span%3E%3Cscript src='https://s9.cnzz.com/z_stat.php%3Fid%3D1280241129' type='text/javascript'%3E%3C/script%3E"));</script>
<a href="https://github.com/youngjuning/vscode-api-cn" target="_blank" class="github-corner" aria-label="View source on GitHub"><svg width="80" height="80" viewBox="0 0 250 250" style="fill:#151513; color:#fff; position: fixed; top: 0; border: 0; right: 0;" aria-hidden="true"><path d="M0,0 L115,115 L130,115 L142,142 L250,250 L250,0 Z"></path><path d="M128.3,109.0 C113.8,99.7 119.0,89.6 119.0,89.6 C122.0,82.7 120.5,78.6 120.5,78.6 C119.2,72.0 123.4,76.3 123.4,76.3 C127.3,80.9 125.5,87.3 125.5,87.3 C122.9,97.6 130.6,101.9 134.4,103.2" fill="currentColor" style="transform-origin: 130px 106px;" class="octo-arm"></path><path d="M115.0,115.0 C114.9,115.1 118.7,116.5 119.8,115.4 L133.7,101.6 C136.9,99.2 139.9,98.4 142.2,98.6 C133.8,88.0 127.5,74.4 143.8,58.0 C148.5,53.4 154.0,51.2 159.7,51.0 C160.3,49.4 163.2,43.6 171.4,40.1 C171.4,40.1 176.1,42.5 178.8,56.2 C183.1,58.6 187.2,61.8 190.9,65.4 C194.5,69.0 197.7,73.2 200.1,77.6 C213.8,80.2 216.3,84.9 216.3,84.9 C212.7,93.1 206.9,96.0 205.4,96.6 C205.1,102.4 203.0,107.8 198.3,112.5 C181.9,128.9 168.3,122.5 157.7,114.1 C157.9,116.9 156.7,120.9 152.7,124.9 L141.0,136.5 C139.8,137.7 141.6,141.9 141.8,141.8 Z" fill="currentColor" class="octo-body"></path></svg></a>
</body>
</html>
Reference in new issue View Git Blame Copy Permalink