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.
vscode-api-cn.js/interfaces/vscode.InputBox.html

661 lines
36 KiB

<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>InputBox | VS Code API 中文文档</title>
<meta name="description" content="VS Code API 是一系列你可以在 Visual Studio Code 扩展中调用的 JavaScript API。这个站点列出了扩展开发者可以使用的所有 vscode api 中文文档。">
<meta property="og:site_name" content="Vscode Api 中文文档">
<meta property="og:type" content="docs">
<meta property="og:url" content="https://vscode-api-cn.js.org/index.html">
<meta property="article:tag" content="vscode">
<meta property="article:tag" content="vscode api">
<meta property="article:tag" content="vscode api 中文文档">
<meta property="article:tag" content="vscode 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>
<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>
<style>
.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="../modules/vscode.html">vscode</a>
</li>
<li>
<a href="vscode.InputBox.html">InputBox</a>
</li>
</ul>
<h1>Interface InputBox</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 concrete <a href="vscode.QuickInput.html">QuickInput</a> to let the user input a text value.</p>
</div>
<p>Note that in many cases the more convenient <a href="../modules/vscode.window.html#showInputBox">window.showInputBox</a>
is easier to use. <a href="../modules/vscode.window.html#createInputBox">window.createInputBox</a> should be used
when <a href="../modules/vscode.window.html#showInputBox">window.showInputBox</a> does not offer the required flexibility.</p>
</div>
</section>
<section class="tsd-panel tsd-hierarchy">
<h3>层级</h3>
<ul class="tsd-hierarchy">
<li>
<a href="vscode.QuickInput.html" class="tsd-signature-type" data-tsd-kind="Interface">QuickInput</a>
<ul class="tsd-hierarchy">
<li>
<span class="target">InputBox</span>
</li>
</ul>
</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>Properties16</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="vscode.InputBox.html#title" class="tsd-kind-icon">title</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="vscode.InputBox.html#step" class="tsd-kind-icon">step</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="vscode.InputBox.html#totalSteps" class="tsd-kind-icon">total<wbr>Steps</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="vscode.InputBox.html#enabled" class="tsd-kind-icon">enabled</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="vscode.InputBox.html#busy" class="tsd-kind-icon">busy</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="vscode.InputBox.html#ignoreFocusOut" class="tsd-kind-icon">ignore<wbr>Focus<wbr>Out</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="vscode.InputBox.html#onDidHide" class="tsd-kind-icon">on<wbr>Did<wbr>Hide</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="vscode.InputBox.html#value" class="tsd-kind-icon">value</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="vscode.InputBox.html#placeholder" class="tsd-kind-icon">placeholder</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="vscode.InputBox.html#password" class="tsd-kind-icon">password</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="vscode.InputBox.html#onDidChangeValue" class="tsd-kind-icon">on<wbr>Did<wbr>Change<wbr>Value</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="vscode.InputBox.html#onDidAccept" class="tsd-kind-icon">on<wbr>Did<wbr>Accept</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="vscode.InputBox.html#buttons" class="tsd-kind-icon">buttons</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="vscode.InputBox.html#onDidTriggerButton" class="tsd-kind-icon">on<wbr>Did<wbr>Trigger<wbr>Button</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="vscode.InputBox.html#prompt" class="tsd-kind-icon">prompt</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="vscode.InputBox.html#validationMessage" class="tsd-kind-icon">validation<wbr>Message</a></li>
</ul>
</section>
<section class="tsd-index-section tsd-is-inherited">
<h3>Methods3</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-method tsd-parent-kind-interface tsd-is-inherited"><a href="vscode.InputBox.html#show" class="tsd-kind-icon">show</a></li>
<li class="tsd-kind-method tsd-parent-kind-interface tsd-is-inherited"><a href="vscode.InputBox.html#hide" class="tsd-kind-icon">hide</a></li>
<li class="tsd-kind-method tsd-parent-kind-interface tsd-is-inherited"><a href="vscode.InputBox.html#dispose" class="tsd-kind-icon">dispose</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Properties16</h2>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="title" class="tsd-anchor"></a>
<h3>title</h3>
<div class="tsd-signature tsd-kind-icon">title<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="vscode.QuickInput.html">QuickInput</a>.<a href="vscode.QuickInput.html#title">title</a></p>
<ul>
<li>Defined in <a href="https://github.com/vscode-cn/vscode-api-cn/blob/791ff1c/vscode.d.ts#L9900">vscode.d.ts:9900</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>An optional title.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="step" class="tsd-anchor"></a>
<h3>step</h3>
<div class="tsd-signature tsd-kind-icon">step<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="vscode.QuickInput.html">QuickInput</a>.<a href="vscode.QuickInput.html#step">step</a></p>
<ul>
<li>Defined in <a href="https://github.com/vscode-cn/vscode-api-cn/blob/791ff1c/vscode.d.ts#L9905">vscode.d.ts:9905</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>An optional current step count.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="totalSteps" class="tsd-anchor"></a>
<h3>total<wbr>Steps</h3>
<div class="tsd-signature tsd-kind-icon">total<wbr>Steps<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="vscode.QuickInput.html">QuickInput</a>.<a href="vscode.QuickInput.html#totalSteps">totalSteps</a></p>
<ul>
<li>Defined in <a href="https://github.com/vscode-cn/vscode-api-cn/blob/791ff1c/vscode.d.ts#L9910">vscode.d.ts:9910</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>An optional total step count.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="enabled" class="tsd-anchor"></a>
<h3>enabled</h3>
<div class="tsd-signature tsd-kind-icon">enabled<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="vscode.QuickInput.html">QuickInput</a>.<a href="vscode.QuickInput.html#enabled">enabled</a></p>
<ul>
<li>Defined in <a href="https://github.com/vscode-cn/vscode-api-cn/blob/791ff1c/vscode.d.ts#L9918">vscode.d.ts:9918</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>If the UI should allow for user input. Defaults to true.</p>
</div>
<p>Change this to false, e.g., while validating user input or
loading data for the next step in user input.</p>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="busy" class="tsd-anchor"></a>
<h3>busy</h3>
<div class="tsd-signature tsd-kind-icon">busy<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="vscode.QuickInput.html">QuickInput</a>.<a href="vscode.QuickInput.html#busy">busy</a></p>
<ul>
<li>Defined in <a href="https://github.com/vscode-cn/vscode-api-cn/blob/791ff1c/vscode.d.ts#L9926">vscode.d.ts:9926</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>If the UI should show a progress indicator. Defaults to false.</p>
</div>
<p>Change this to true, e.g., while loading more data or validating
user input.</p>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="ignoreFocusOut" class="tsd-anchor"></a>
<h3>ignore<wbr>Focus<wbr>Out</h3>
<div class="tsd-signature tsd-kind-icon">ignore<wbr>Focus<wbr>Out<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="vscode.QuickInput.html">QuickInput</a>.<a href="vscode.QuickInput.html#ignoreFocusOut">ignoreFocusOut</a></p>
<ul>
<li>Defined in <a href="https://github.com/vscode-cn/vscode-api-cn/blob/791ff1c/vscode.d.ts#L9932">vscode.d.ts:9932</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>If the UI should stay open even when loosing UI focus. Defaults to false.
This setting is ignored on iPad and is always false.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="onDidHide" class="tsd-anchor"></a>
<h3>on<wbr>Did<wbr>Hide</h3>
<div class="tsd-signature tsd-kind-icon">on<wbr>Did<wbr>Hide<span class="tsd-signature-symbol">:</span> <a href="vscode.Event.html" class="tsd-signature-type" data-tsd-kind="Interface">Event</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="vscode.QuickInput.html">QuickInput</a>.<a href="vscode.QuickInput.html#onDidHide">onDidHide</a></p>
<ul>
<li>Defined in <a href="https://github.com/vscode-cn/vscode-api-cn/blob/791ff1c/vscode.d.ts#L9954">vscode.d.ts:9954</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>An event signaling when this input UI is hidden.</p>
</div>
<p>There are several reasons why this UI might have to be hidden and
the extension will be notified through <a href="vscode.QuickInput.html#onDidHide">QuickInput.onDidHide</a>.
(Examples include: an explicit call to <a href="vscode.QuickInput.html#hide">QuickInput.hide</a>,
the user pressing Esc, some other input UI opening, etc.)</p>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="value" class="tsd-anchor"></a>
<h3>value</h3>
<div class="tsd-signature tsd-kind-icon">value<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vscode-cn/vscode-api-cn/blob/791ff1c/vscode.d.ts#L10060">vscode.d.ts:10060</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Current input value.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="placeholder" class="tsd-anchor"></a>
<h3>placeholder</h3>
<div class="tsd-signature tsd-kind-icon">placeholder<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vscode-cn/vscode-api-cn/blob/791ff1c/vscode.d.ts#L10065">vscode.d.ts:10065</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Optional placeholder in the filter text.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="password" class="tsd-anchor"></a>
<h3>password</h3>
<div class="tsd-signature tsd-kind-icon">password<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vscode-cn/vscode-api-cn/blob/791ff1c/vscode.d.ts#L10070">vscode.d.ts:10070</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>If the input value should be hidden. Defaults to false.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="onDidChangeValue" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagReadonly">Readonly</span> on<wbr>Did<wbr>Change<wbr>Value</h3>
<div class="tsd-signature tsd-kind-icon">on<wbr>Did<wbr>Change<wbr>Value<span class="tsd-signature-symbol">:</span> <a href="vscode.Event.html" class="tsd-signature-type" data-tsd-kind="Interface">Event</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vscode-cn/vscode-api-cn/blob/791ff1c/vscode.d.ts#L10075">vscode.d.ts:10075</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>An event signaling when the value has changed.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="onDidAccept" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagReadonly">Readonly</span> on<wbr>Did<wbr>Accept</h3>
<div class="tsd-signature tsd-kind-icon">on<wbr>Did<wbr>Accept<span class="tsd-signature-symbol">:</span> <a href="vscode.Event.html" class="tsd-signature-type" data-tsd-kind="Interface">Event</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vscode-cn/vscode-api-cn/blob/791ff1c/vscode.d.ts#L10080">vscode.d.ts:10080</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>An event signaling when the user indicated acceptance of the input value.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="buttons" class="tsd-anchor"></a>
<h3>buttons</h3>
<div class="tsd-signature tsd-kind-icon">buttons<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">readonly </span><a href="vscode.QuickInputButton.html" class="tsd-signature-type" data-tsd-kind="Interface">QuickInputButton</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/791ff1c/vscode.d.ts#L10085">vscode.d.ts:10085</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Buttons for actions in the UI.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="onDidTriggerButton" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagReadonly">Readonly</span> on<wbr>Did<wbr>Trigger<wbr>Button</h3>
<div class="tsd-signature tsd-kind-icon">on<wbr>Did<wbr>Trigger<wbr>Button<span class="tsd-signature-symbol">:</span> <a href="vscode.Event.html" class="tsd-signature-type" data-tsd-kind="Interface">Event</a><span class="tsd-signature-symbol">&lt;</span><a href="vscode.QuickInputButton.html" class="tsd-signature-type" data-tsd-kind="Interface">QuickInputButton</a><span class="tsd-signature-symbol">&gt;</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vscode-cn/vscode-api-cn/blob/791ff1c/vscode.d.ts#L10090">vscode.d.ts:10090</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>An event signaling when a button was triggered.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="prompt" class="tsd-anchor"></a>
<h3>prompt</h3>
<div class="tsd-signature tsd-kind-icon">prompt<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vscode-cn/vscode-api-cn/blob/791ff1c/vscode.d.ts#L10095">vscode.d.ts:10095</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>An optional prompt text providing some ask or explanation to the user.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="validationMessage" class="tsd-anchor"></a>
<h3>validation<wbr>Message</h3>
<div class="tsd-signature tsd-kind-icon">validation<wbr>Message<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vscode-cn/vscode-api-cn/blob/791ff1c/vscode.d.ts#L10100">vscode.d.ts:10100</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>An optional validation message indicating a problem with the current input value.</p>
</div>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group tsd-is-inherited">
<h2>Methods3</h2>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-inherited">
<a name="show" class="tsd-anchor"></a>
<h3>show</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">show<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">
<p>Inherited from <a href="vscode.QuickInput.html">QuickInput</a>.<a href="vscode.QuickInput.html#show">show</a></p>
<ul>
<li>Defined in <a href="https://github.com/vscode-cn/vscode-api-cn/blob/791ff1c/vscode.d.ts#L9938">vscode.d.ts:9938</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Makes the input UI visible in its current configuration. Any other input
UI will first fire an <a href="vscode.QuickInput.html#onDidHide">QuickInput.onDidHide</a> event.</p>
</div>
</div>
<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 tsd-is-inherited">
<a name="hide" class="tsd-anchor"></a>
<h3>hide</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-inherited">
<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">
<p>Inherited from <a href="vscode.QuickInput.html">QuickInput</a>.<a href="vscode.QuickInput.html#hide">hide</a></p>
<ul>
<li>Defined in <a href="https://github.com/vscode-cn/vscode-api-cn/blob/791ff1c/vscode.d.ts#L9944">vscode.d.ts:9944</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Hides this input UI. This will also fire an <a href="vscode.QuickInput.html#onDidHide">QuickInput.onDidHide</a>
event.</p>
</div>
</div>
<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 tsd-is-inherited">
<a name="dispose" class="tsd-anchor"></a>
<h3>dispose</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">dispose<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">
<p>Inherited from <a href="vscode.QuickInput.html">QuickInput</a>.<a href="vscode.QuickInput.html#dispose">dispose</a></p>
<ul>
<li>Defined in <a href="https://github.com/vscode-cn/vscode-api-cn/blob/791ff1c/vscode.d.ts#L9962">vscode.d.ts:9962</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Dispose of this input UI and any associated resources. If it is still
visible, it is first hidden. After this call the input UI is no longer
functional and no additional methods or properties on it should be
accessed. Instead a new input UI should be created.</p>
</div>
</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>
<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.InputBox.html" class="tsd-kind-icon">Input<wbr>Box</a>
<ul>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="vscode.InputBox.html#title" class="tsd-kind-icon">title</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="vscode.InputBox.html#step" class="tsd-kind-icon">step</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="vscode.InputBox.html#totalSteps" class="tsd-kind-icon">total<wbr>Steps</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="vscode.InputBox.html#enabled" class="tsd-kind-icon">enabled</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="vscode.InputBox.html#busy" class="tsd-kind-icon">busy</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="vscode.InputBox.html#ignoreFocusOut" class="tsd-kind-icon">ignore<wbr>Focus<wbr>Out</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-interface tsd-is-inherited">
<a href="vscode.InputBox.html#show" class="tsd-kind-icon">show</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-interface tsd-is-inherited">
<a href="vscode.InputBox.html#hide" class="tsd-kind-icon">hide</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="vscode.InputBox.html#onDidHide" class="tsd-kind-icon">on<wbr>Did<wbr>Hide</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-interface tsd-is-inherited">
<a href="vscode.InputBox.html#dispose" class="tsd-kind-icon">dispose</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="vscode.InputBox.html#value" class="tsd-kind-icon">value</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="vscode.InputBox.html#placeholder" class="tsd-kind-icon">placeholder</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="vscode.InputBox.html#password" class="tsd-kind-icon">password</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="vscode.InputBox.html#onDidChangeValue" class="tsd-kind-icon">on<wbr>Did<wbr>Change<wbr>Value</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="vscode.InputBox.html#onDidAccept" class="tsd-kind-icon">on<wbr>Did<wbr>Accept</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="vscode.InputBox.html#buttons" class="tsd-kind-icon">buttons</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="vscode.InputBox.html#onDidTriggerButton" class="tsd-kind-icon">on<wbr>Did<wbr>Trigger<wbr>Button</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="vscode.InputBox.html#prompt" class="tsd-kind-icon">prompt</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="vscode.InputBox.html#validationMessage" class="tsd-kind-icon">validation<wbr>Message</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>
</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></p>
</div>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
<script>
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
})(window,document,'script','//www.google-analytics.com/analytics.js','ga');
ga('create', 'G-T4TRRS1LB1', 'auto');
ga('send', 'pageview');
</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>