ToxicMushroom/Dalamud
1
0
Fork 0
mirror of https://github.com/goatcorp/Dalamud.git synced 2025-12-12 10:17:22 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions 3
Dalamud/docs/api/Dalamud.Interface.ImGuiFileDialog.FileDialog.html
goat 6fd636c26c
docs: regenerate
2022-10-29 15:34:04 +02:00

520 lines
26 KiB
HTML
Raw Blame History

<!DOCTYPE html>
<!--[if IE]><![endif]-->
<html>
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
<title>Class FileDialog
</title>
<meta name="viewport" content="width=device-width">
<meta name="title" content="Class FileDialog
">
<meta name="generator" content="docfx 2.59.4.0">
<link rel="shortcut icon" href="../favicon.ico">
<link rel="stylesheet" href="../styles/docfx.vendor.css">
<link rel="stylesheet" href="../styles/docfx.css">
<link rel="stylesheet" href="../styles/main.css">
<meta property="docfx:navrel" content="">
<meta property="docfx:tocrel" content="toc.html">
</head>
<body data-spy="scroll" data-target="#affix" data-offset="120">
<div id="wrapper">
<header>
<nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation">
<div class="container">
<div class="navbar-header">
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<a class="navbar-brand" href="../index.html">
<img id="logo" class="svg" src="../logo.svg" alt="">
</a>
</div>
<div class="collapse navbar-collapse" id="navbar">
<form class="navbar-form navbar-right" role="search" id="search">
<div class="form-group">
<input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">
</div>
</form>
</div>
</div>
</nav>
<div class="subnav navbar navbar-default">
<div class="container hide-when-search" id="breadcrumb">
<ul class="breadcrumb">
<li></li>
</ul>
</div>
</div>
</header>
<div role="main" class="container body-content hide-when-search">
<div class="sidenav hide-when-search">
<a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
<div class="sidetoggle collapse" id="sidetoggle">
<div id="sidetoc"></div>
</div>
</div>
<div class="article row grid-right">
<div class="col-md-10">
<article class="content wrap" id="_content" data-uid="Dalamud.Interface.ImGuiFileDialog.FileDialog">
<h1 id="Dalamud_Interface_ImGuiFileDialog_FileDialog" data-uid="Dalamud.Interface.ImGuiFileDialog.FileDialog" class="text-break">Class FileDialog
</h1>
<div class="markdown level0 summary"><p>A file or folder picker.</p>
</div>
<div class="markdown level0 conceptual"></div>
<div class="inheritance">
<h5>Inheritance</h5>
<div class="level0"><span class="xref">System.Object</span></div>
<div class="level1"><span class="xref">FileDialog</span></div>
</div>
<div class="inheritedMembers">
<h5>Inherited Members</h5>
<div>
<span class="xref">System.Object.Equals(System.Object)</span>
</div>
<div>
<span class="xref">System.Object.Equals(System.Object, System.Object)</span>
</div>
<div>
<span class="xref">System.Object.GetHashCode()</span>
</div>
<div>
<span class="xref">System.Object.GetType()</span>
</div>
<div>
<span class="xref">System.Object.MemberwiseClone()</span>
</div>
<div>
<span class="xref">System.Object.ReferenceEquals(System.Object, System.Object)</span>
</div>
<div>
<span class="xref">System.Object.ToString()</span>
</div>
</div>
<h6><strong>Namespace</strong>: <a class="xref" href="Dalamud.Interface.ImGuiFileDialog.html">Dalamud.Interface.ImGuiFileDialog</a></h6>
<h6><strong>Assembly</strong>: Dalamud.dll</h6>
<h5 id="Dalamud_Interface_ImGuiFileDialog_FileDialog_syntax">Syntax</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public class FileDialog</code></pre>
</div>
<h3 id="constructors">Constructors
</h3>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Interface_ImGuiFileDialog_FileDialog__ctor_System_String_System_String_System_String_System_String_System_String_System_String_System_Int32_System_Boolean_Dalamud_Interface_ImGuiFileDialog_ImGuiFileDialogFlags_.md&amp;value=---%0Auid%3A%20Dalamud.Interface.ImGuiFileDialog.FileDialog.%23ctor(System.String%2CSystem.String%2CSystem.String%2CSystem.String%2CSystem.String%2CSystem.String%2CSystem.Int32%2CSystem.Boolean%2CDalamud.Interface.ImGuiFileDialog.ImGuiFileDialogFlags)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/goatcorp/Dalamud/blob/master/Dalamud/Interface/ImGuiFileDialog/FileDialog.cs/#L70">View Source</a>
</span>
<a id="Dalamud_Interface_ImGuiFileDialog_FileDialog__ctor_" data-uid="Dalamud.Interface.ImGuiFileDialog.FileDialog.#ctor*"></a>
<h4 id="Dalamud_Interface_ImGuiFileDialog_FileDialog__ctor_System_String_System_String_System_String_System_String_System_String_System_String_System_Int32_System_Boolean_Dalamud_Interface_ImGuiFileDialog_ImGuiFileDialogFlags_" data-uid="Dalamud.Interface.ImGuiFileDialog.FileDialog.#ctor(System.String,System.String,System.String,System.String,System.String,System.String,System.Int32,System.Boolean,Dalamud.Interface.ImGuiFileDialog.ImGuiFileDialogFlags)">FileDialog(String, String, String, String, String, String, Int32, Boolean, ImGuiFileDialogFlags)</h4>
<div class="markdown level1 summary"><p>Initializes a new instance of the <a class="xref" href="Dalamud.Interface.ImGuiFileDialog.FileDialog.html">FileDialog</a> class.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public FileDialog(string id, string title, string filters, string path, string defaultFileName, string defaultExtension, int selectionCountMax, bool isModal, ImGuiFileDialogFlags flags)</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.String</span></td>
<td><span class="parametername">id</span></td>
<td><p>A unique id for the dialog.</p>
</td>
</tr>
<tr>
<td><span class="xref">System.String</span></td>
<td><span class="parametername">title</span></td>
<td><p>The text which is shown at the top of the dialog.</p>
</td>
</tr>
<tr>
<td><span class="xref">System.String</span></td>
<td><span class="parametername">filters</span></td>
<td><p>Which file extension filters to apply. This should be left blank to select directories.</p>
</td>
</tr>
<tr>
<td><span class="xref">System.String</span></td>
<td><span class="parametername">path</span></td>
<td><p>The directory which the dialog should start inside of.</p>
</td>
</tr>
<tr>
<td><span class="xref">System.String</span></td>
<td><span class="parametername">defaultFileName</span></td>
<td><p>The default file or directory name.</p>
</td>
</tr>
<tr>
<td><span class="xref">System.String</span></td>
<td><span class="parametername">defaultExtension</span></td>
<td><p>The default extension when creating new files.</p>
</td>
</tr>
<tr>
<td><span class="xref">System.Int32</span></td>
<td><span class="parametername">selectionCountMax</span></td>
<td><p>The maximum amount of files or directories which can be selected. Set to 0 for an infinite number.</p>
</td>
</tr>
<tr>
<td><span class="xref">System.Boolean</span></td>
<td><span class="parametername">isModal</span></td>
<td><p>Whether the dialog should be a modal popup.</p>
</td>
</tr>
<tr>
<td><a class="xref" href="Dalamud.Interface.ImGuiFileDialog.ImGuiFileDialogFlags.html">ImGuiFileDialogFlags</a></td>
<td><span class="parametername">flags</span></td>
<td><p>Settings flags for the dialog, see <a class="xref" href="Dalamud.Interface.ImGuiFileDialog.ImGuiFileDialogFlags.html">ImGuiFileDialogFlags</a>.</p>
</td>
</tr>
</tbody>
</table>
<h3 id="fields">Fields
</h3>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Interface_ImGuiFileDialog_FileDialog_WindowFlags.md&amp;value=---%0Auid%3A%20Dalamud.Interface.ImGuiFileDialog.FileDialog.WindowFlags%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/goatcorp/Dalamud/blob/master/Dalamud/Interface/ImGuiFileDialog/FileDialog.cs/#L19">View Source</a>
</span>
<h4 id="Dalamud_Interface_ImGuiFileDialog_FileDialog_WindowFlags" data-uid="Dalamud.Interface.ImGuiFileDialog.FileDialog.WindowFlags">WindowFlags</h4>
<div class="markdown level1 summary"><p>The flags used to draw the file picker window.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public ImGuiWindowFlags WindowFlags</code></pre>
</div>
<h5 class="fieldValue">Field Value</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="ImGuiNET.ImGuiWindowFlags.html">ImGuiWindowFlags</a></td>
<td></td>
</tr>
</tbody>
</table>
<h3 id="methods">Methods
</h3>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Interface_ImGuiFileDialog_FileDialog_Draw.md&amp;value=---%0Auid%3A%20Dalamud.Interface.ImGuiFileDialog.FileDialog.Draw%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/goatcorp/Dalamud/blob/master/Dalamud/Interface/ImGuiFileDialog/FileDialog.UI.cs/#L29">View Source</a>
</span>
<a id="Dalamud_Interface_ImGuiFileDialog_FileDialog_Draw_" data-uid="Dalamud.Interface.ImGuiFileDialog.FileDialog.Draw*"></a>
<h4 id="Dalamud_Interface_ImGuiFileDialog_FileDialog_Draw" data-uid="Dalamud.Interface.ImGuiFileDialog.FileDialog.Draw">Draw()</h4>
<div class="markdown level1 summary"><p>Draws the dialog.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public bool Draw()</code></pre>
</div>
<h5 class="returns">Returns</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Boolean</span></td>
<td><p>Whether a selection or cancel action was performed.</p>
</td>
</tr>
</tbody>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Interface_ImGuiFileDialog_FileDialog_GetCurrentPath.md&amp;value=---%0Auid%3A%20Dalamud.Interface.ImGuiFileDialog.FileDialog.GetCurrentPath%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/goatcorp/Dalamud/blob/master/Dalamud/Interface/ImGuiFileDialog/FileDialog.cs/#L161">View Source</a>
</span>
<a id="Dalamud_Interface_ImGuiFileDialog_FileDialog_GetCurrentPath_" data-uid="Dalamud.Interface.ImGuiFileDialog.FileDialog.GetCurrentPath*"></a>
<h4 id="Dalamud_Interface_ImGuiFileDialog_FileDialog_GetCurrentPath" data-uid="Dalamud.Interface.ImGuiFileDialog.FileDialog.GetCurrentPath">GetCurrentPath()</h4>
<div class="markdown level1 summary"><p>Gets the current path of the dialog.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public string GetCurrentPath()</code></pre>
</div>
<h5 class="returns">Returns</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.String</span></td>
<td><p>The path of the directory which the dialog is current viewing.</p>
</td>
</tr>
</tbody>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Interface_ImGuiFileDialog_FileDialog_GetIsOk.md&amp;value=---%0Auid%3A%20Dalamud.Interface.ImGuiFileDialog.FileDialog.GetIsOk%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/goatcorp/Dalamud/blob/master/Dalamud/Interface/ImGuiFileDialog/FileDialog.cs/#L122">View Source</a>
</span>
<a id="Dalamud_Interface_ImGuiFileDialog_FileDialog_GetIsOk_" data-uid="Dalamud.Interface.ImGuiFileDialog.FileDialog.GetIsOk*"></a>
<h4 id="Dalamud_Interface_ImGuiFileDialog_FileDialog_GetIsOk" data-uid="Dalamud.Interface.ImGuiFileDialog.FileDialog.GetIsOk">GetIsOk()</h4>
<div class="markdown level1 summary"><p>Gets whether a file or folder was successfully selected.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public bool GetIsOk()</code></pre>
</div>
<h5 class="returns">Returns</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Boolean</span></td>
<td><p>The success state. Will be false if the selection was canceled or was otherwise unsuccessful.</p>
</td>
</tr>
</tbody>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Interface_ImGuiFileDialog_FileDialog_GetResult.md&amp;value=---%0Auid%3A%20Dalamud.Interface.ImGuiFileDialog.FileDialog.GetResult%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/goatcorp/Dalamud/blob/master/Dalamud/Interface/ImGuiFileDialog/FileDialog.cs/#L131">View Source</a>
</span>
<a id="Dalamud_Interface_ImGuiFileDialog_FileDialog_GetResult_" data-uid="Dalamud.Interface.ImGuiFileDialog.FileDialog.GetResult*"></a>
<h4 id="Dalamud_Interface_ImGuiFileDialog_FileDialog_GetResult" data-uid="Dalamud.Interface.ImGuiFileDialog.FileDialog.GetResult">GetResult()</h4>
<div class="markdown level1 summary"><p>Gets the result of the selection.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">[Obsolete(&quot;Use GetResults() instead.&quot;, true)]
public string GetResult()</code></pre>
</div>
<h5 class="returns">Returns</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.String</span></td>
<td><p>The result of the selection (file or folder path). If multiple entries were selected, they are separated with commas.</p>
</td>
</tr>
</tbody>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Interface_ImGuiFileDialog_FileDialog_GetResults.md&amp;value=---%0Auid%3A%20Dalamud.Interface.ImGuiFileDialog.FileDialog.GetResults%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/goatcorp/Dalamud/blob/master/Dalamud/Interface/ImGuiFileDialog/FileDialog.cs/#L141">View Source</a>
</span>
<a id="Dalamud_Interface_ImGuiFileDialog_FileDialog_GetResults_" data-uid="Dalamud.Interface.ImGuiFileDialog.FileDialog.GetResults*"></a>
<h4 id="Dalamud_Interface_ImGuiFileDialog_FileDialog_GetResults" data-uid="Dalamud.Interface.ImGuiFileDialog.FileDialog.GetResults">GetResults()</h4>
<div class="markdown level1 summary"><p>Gets the result of the selection.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public List&lt;string&gt; GetResults()</code></pre>
</div>
<h5 class="returns">Returns</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Collections.Generic.List</span>&lt;<span class="xref">System.String</span>&gt;</td>
<td><p>The list of selected paths.</p>
</td>
</tr>
</tbody>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Interface_ImGuiFileDialog_FileDialog_Hide.md&amp;value=---%0Auid%3A%20Dalamud.Interface.ImGuiFileDialog.FileDialog.Hide%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/goatcorp/Dalamud/blob/master/Dalamud/Interface/ImGuiFileDialog/FileDialog.cs/#L113">View Source</a>
</span>
<a id="Dalamud_Interface_ImGuiFileDialog_FileDialog_Hide_" data-uid="Dalamud.Interface.ImGuiFileDialog.FileDialog.Hide*"></a>
<h4 id="Dalamud_Interface_ImGuiFileDialog_FileDialog_Hide" data-uid="Dalamud.Interface.ImGuiFileDialog.FileDialog.Hide">Hide()</h4>
<div class="markdown level1 summary"><p>Hides the dialog.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public void Hide()</code></pre>
</div>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Interface_ImGuiFileDialog_FileDialog_SetQuickAccess_System_String_System_String_Dalamud_Interface_FontAwesomeIcon_System_Int32_.md&amp;value=---%0Auid%3A%20Dalamud.Interface.ImGuiFileDialog.FileDialog.SetQuickAccess(System.String%2CSystem.String%2CDalamud.Interface.FontAwesomeIcon%2CSystem.Int32)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/goatcorp/Dalamud/blob/master/Dalamud/Interface/ImGuiFileDialog/FileDialog.cs/#L184">View Source</a>
</span>
<a id="Dalamud_Interface_ImGuiFileDialog_FileDialog_SetQuickAccess_" data-uid="Dalamud.Interface.ImGuiFileDialog.FileDialog.SetQuickAccess*"></a>
<h4 id="Dalamud_Interface_ImGuiFileDialog_FileDialog_SetQuickAccess_System_String_System_String_Dalamud_Interface_FontAwesomeIcon_System_Int32_" data-uid="Dalamud.Interface.ImGuiFileDialog.FileDialog.SetQuickAccess(System.String,System.String,Dalamud.Interface.FontAwesomeIcon,System.Int32)">SetQuickAccess(String, String, FontAwesomeIcon, Int32)</h4>
<div class="markdown level1 summary"><p>Set or remove a quick access folder for the navigation panel.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public void SetQuickAccess(string name, string path, FontAwesomeIcon icon, int position = -1)</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.String</span></td>
<td><span class="parametername">name</span></td>
<td><p>The displayed name of the folder. If this name already exists, it will be overwritten.</p>
</td>
</tr>
<tr>
<td><span class="xref">System.String</span></td>
<td><span class="parametername">path</span></td>
<td><p>The new linked path. If this is empty, no link will be added and existing links will be removed.</p>
</td>
</tr>
<tr>
<td><a class="xref" href="Dalamud.Interface.FontAwesomeIcon.html">FontAwesomeIcon</a></td>
<td><span class="parametername">icon</span></td>
<td><p>The FontAwesomeIcon-ID of the icon displayed before the name.</p>
</td>
</tr>
<tr>
<td><span class="xref">System.Int32</span></td>
<td><span class="parametername">position</span></td>
<td><p>An optional position at which to insert the new link. If the link is updated, having this less than zero will keep its position.
Otherwise, invalid indices will insert it at the end.</p>
</td>
</tr>
</tbody>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Interface_ImGuiFileDialog_FileDialog_Show.md&amp;value=---%0Auid%3A%20Dalamud.Interface.ImGuiFileDialog.FileDialog.Show%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/goatcorp/Dalamud/blob/master/Dalamud/Interface/ImGuiFileDialog/FileDialog.cs/#L105">View Source</a>
</span>
<a id="Dalamud_Interface_ImGuiFileDialog_FileDialog_Show_" data-uid="Dalamud.Interface.ImGuiFileDialog.FileDialog.Show*"></a>
<h4 id="Dalamud_Interface_ImGuiFileDialog_FileDialog_Show" data-uid="Dalamud.Interface.ImGuiFileDialog.FileDialog.Show">Show()</h4>
<div class="markdown level1 summary"><p>Shows the dialog.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public void Show()</code></pre>
</div>
</article>
</div>
<div class="hidden-sm col-md-2" role="complementary">
<div class="sideaffix">
<div class="contribution">
<ul class="nav">
<li>
<a href="https://github.com/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Interface_ImGuiFileDialog_FileDialog.md&amp;value=---%0Auid%3A%20Dalamud.Interface.ImGuiFileDialog.FileDialog%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A" class="contribution-link">Improve this Doc</a>
</li>
<li>
<a href="https://github.com/goatcorp/Dalamud/blob/master/Dalamud/Interface/ImGuiFileDialog/FileDialog.UI.cs/#L13" class="contribution-link">View Source</a>
</li>
</ul>
</div>
<nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
<h5>In This Article</h5>
<div></div>
</nav>
</div>
</div>
</div>
</div>
<footer>
<div class="grad-bottom"></div>
<div class="footer">
<div class="container">
<span class="pull-right">
<a href="#top">Back to top</a>
</span>
<span>Generated by <strong>DocFX</strong></span>
</div>
</div>
</footer>
</div>
<script type="text/javascript" src="../styles/docfx.vendor.js"></script>
<script type="text/javascript" src="../styles/docfx.js"></script>
<script type="text/javascript" src="../styles/main.js"></script>
</body>
</html>
Reference in a new issue View git blame Copy permalink