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 '8b4958afc3'
${ noResults }
vscode-api-cn.js/interfaces/OpenDialogOptions.html

308 lines
15 KiB
Raw Blame History

<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>OpenDialogOptions | 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="../modules.html">VS Code API</a>
</li>
<li>
<a href="OpenDialogOptions.html">OpenDialogOptions</a>
</li>
</ul>
<h1>Interface OpenDialogOptions</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>Options to configure the behaviour of a file open dialog.</p>
</div>
<ul>
<li>Note 1: On Windows and Linux, a file dialog cannot be both a file selector and a folder selector, so if you
set both <code>canSelectFiles</code> and <code>canSelectFolders</code> to <code>true</code> on these platforms, a folder selector will be shown.</li>
<li>Note 2: Explicitly setting <code>canSelectFiles</code> and <code>canSelectFolders</code> to <code>false</code> is futile
and the editor then silently adjusts the options to select files.</li>
</ul>
</div>
</section>
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<span class="target">OpenDialogOptions</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>Properties</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="OpenDialogOptions.html#defaultUri" class="tsd-kind-icon">default<wbr>Uri</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="OpenDialogOptions.html#openLabel" class="tsd-kind-icon">open<wbr>Label</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="OpenDialogOptions.html#canSelectFiles" class="tsd-kind-icon">can<wbr>Select<wbr>Files</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="OpenDialogOptions.html#canSelectFolders" class="tsd-kind-icon">can<wbr>Select<wbr>Folders</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="OpenDialogOptions.html#canSelectMany" class="tsd-kind-icon">can<wbr>Select<wbr>Many</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="OpenDialogOptions.html#filters" class="tsd-kind-icon">filters</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="OpenDialogOptions.html#title" class="tsd-kind-icon">title</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="defaultUri" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> default<wbr>Uri</h3>
<div class="tsd-signature tsd-kind-icon">default<wbr>Uri<span class="tsd-signature-symbol">:</span> <a href="../classes/Uri.html" class="tsd-signature-type" data-tsd-kind="Class">Uri</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/youngjuning/vscode-api/blob/c713f4c/vscode.d.ts#L1745">vscode.d.ts:1745</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The resource the dialog shows when opened.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="openLabel" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> open<wbr>Label</h3>
<div class="tsd-signature tsd-kind-icon">open<wbr>Label<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/youngjuning/vscode-api/blob/c713f4c/vscode.d.ts#L1750">vscode.d.ts:1750</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>A human-readable string for the open button.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="canSelectFiles" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> can<wbr>Select<wbr>Files</h3>
<div class="tsd-signature tsd-kind-icon">can<wbr>Select<wbr>Files<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/youngjuning/vscode-api/blob/c713f4c/vscode.d.ts#L1755">vscode.d.ts:1755</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Allow to select files, defaults to <code>true</code>.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="canSelectFolders" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> can<wbr>Select<wbr>Folders</h3>
<div class="tsd-signature tsd-kind-icon">can<wbr>Select<wbr>Folders<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/youngjuning/vscode-api/blob/c713f4c/vscode.d.ts#L1760">vscode.d.ts:1760</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Allow to select folders, defaults to <code>false</code>.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="canSelectMany" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> can<wbr>Select<wbr>Many</h3>
<div class="tsd-signature tsd-kind-icon">can<wbr>Select<wbr>Many<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/youngjuning/vscode-api/blob/c713f4c/vscode.d.ts#L1765">vscode.d.ts:1765</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Allow to select many files or folders.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="filters" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> filters</h3>
<div class="tsd-signature tsd-kind-icon">filters<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{}</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/youngjuning/vscode-api/blob/c713f4c/vscode.d.ts#L1777">vscode.d.ts:1777</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>A set of file filters that are used by the dialog. Each entry is a human-readable label,
like &quot;TypeScript&quot;, and an array of extensions, e.g.</p>
<pre><code class="language-ts"><span style="color: #000000">{</span>
<span style="color: #000000"> </span><span style="color: #A31515">&#039;Images&#039;</span><span style="color: #000000">: [</span><span style="color: #A31515">&#039;png&#039;</span><span style="color: #000000">, </span><span style="color: #A31515">&#039;jpg&#039;</span><span style="color: #000000">]</span>
<span style="color: #000000"> </span><span style="color: #A31515">&#039;TypeScript&#039;</span><span style="color: #000000">: [</span><span style="color: #A31515">&#039;ts&#039;</span><span style="color: #000000">, </span><span style="color: #A31515">&#039;tsx&#039;</span><span style="color: #000000">]</span>
<span style="color: #000000">}</span>
</code></pre>
</div>
</div>
<div class="tsd-type-declaration">
<h4>Type declaration</h4>
<ul class="tsd-parameters">
<li class="tsd-parameter-index-signature">
<h5><span class="tsd-signature-symbol">[</span>name: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h5>
</li>
</ul>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="title" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> title</h3>
<div class="tsd-signature tsd-kind-icon">title<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/youngjuning/vscode-api/blob/c713f4c/vscode.d.ts#L1785">vscode.d.ts:1785</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Dialog title.</p>
</div>
<p>This parameter might be ignored, as not all operating systems display a title on open dialogs
(for example, macOS).</p>
</div>
</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="OpenDialogOptions.html" class="tsd-kind-icon">Open<wbr>Dialog<wbr>Options</a>
<ul>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="OpenDialogOptions.html#defaultUri" class="tsd-kind-icon">default<wbr>Uri</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="OpenDialogOptions.html#openLabel" class="tsd-kind-icon">open<wbr>Label</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="OpenDialogOptions.html#canSelectFiles" class="tsd-kind-icon">can<wbr>Select<wbr>Files</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="OpenDialogOptions.html#canSelectFolders" class="tsd-kind-icon">can<wbr>Select<wbr>Folders</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="OpenDialogOptions.html#canSelectMany" class="tsd-kind-icon">can<wbr>Select<wbr>Many</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="OpenDialogOptions.html#filters" class="tsd-kind-icon">filters</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="OpenDialogOptions.html#title" class="tsd-kind-icon">title</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>
Reference in new issue View Git Blame Copy Permalink