Terminal.Gui.FileDialog.html 29 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735
  1. <!DOCTYPE html>
  2. <!--[if IE]><![endif]-->
  3. <html>
  4. <head>
  5. <meta charset="utf-8">
  6. <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
  7. <title>Class FileDialog
  8. </title>
  9. <meta name="viewport" content="width=device-width">
  10. <meta name="title" content="Class FileDialog
  11. ">
  12. <meta name="generator" content="docfx 2.54.0.0">
  13. <link rel="shortcut icon" href="../../favicon.ico">
  14. <link rel="stylesheet" href="../../styles/docfx.vendor.css">
  15. <link rel="stylesheet" href="../../styles/docfx.css">
  16. <link rel="stylesheet" href="../../styles/main.css">
  17. <link href="https://fonts.googleapis.com/css?family=Roboto" rel="stylesheet">
  18. <meta property="docfx:navrel" content="../../toc.html">
  19. <meta property="docfx:tocrel" content="toc.html">
  20. <meta property="docfx:rel" content="../../">
  21. </head> <body data-spy="scroll" data-target="#affix" data-offset="120">
  22. <div id="wrapper">
  23. <header>
  24. <nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation">
  25. <div class="container">
  26. <div class="navbar-header">
  27. <button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
  28. <span class="sr-only">Toggle navigation</span>
  29. <span class="icon-bar"></span>
  30. <span class="icon-bar"></span>
  31. <span class="icon-bar"></span>
  32. </button>
  33. <a class="navbar-brand" href="../../index.html">
  34. <img id="logo" class="svg" src="../../images/logo48.png" alt="">
  35. </a>
  36. </div>
  37. <div class="collapse navbar-collapse" id="navbar">
  38. <form class="navbar-form navbar-right" role="search" id="search">
  39. <div class="form-group">
  40. <input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">
  41. </div>
  42. </form>
  43. </div>
  44. </div>
  45. </nav>
  46. <div class="subnav navbar navbar-default">
  47. <div class="container hide-when-search" id="breadcrumb">
  48. <ul class="breadcrumb">
  49. <li></li>
  50. </ul>
  51. </div>
  52. </div>
  53. </header>
  54. <div class="container body-content">
  55. <div id="search-results">
  56. <div class="search-list"></div>
  57. <div class="sr-items">
  58. <p><i class="glyphicon glyphicon-refresh index-loading"></i></p>
  59. </div>
  60. <ul id="pagination"></ul>
  61. </div>
  62. </div>
  63. <div role="main" class="container body-content hide-when-search">
  64. <div class="sidenav hide-when-search">
  65. <a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
  66. <div class="sidetoggle collapse" id="sidetoggle">
  67. <div id="sidetoc"></div>
  68. </div>
  69. </div>
  70. <div class="article row grid-right">
  71. <div class="col-md-10">
  72. <article class="content wrap" id="_content" data-uid="Terminal.Gui.FileDialog">
  73. <h1 id="Terminal_Gui_FileDialog" data-uid="Terminal.Gui.FileDialog" class="text-break">Class FileDialog
  74. </h1>
  75. <div class="markdown level0 summary">
  76. Base class for the <a class="xref" href="Terminal.Gui.OpenDialog.html">OpenDialog</a> and the <a class="xref" href="Terminal.Gui.SaveDialog.html">SaveDialog</a>
  77. </div>
  78. <div class="markdown level0 conceptual"></div>
  79. <div class="inheritance">
  80. <h5>Inheritance</h5>
  81. <div class="level0"><span class="xref">System.Object</span></div>
  82. <div class="level1"><a class="xref" href="Terminal.Gui.Responder.html">Responder</a></div>
  83. <div class="level2"><a class="xref" href="Terminal.Gui.View.html">View</a></div>
  84. <div class="level3"><a class="xref" href="Terminal.Gui.Toplevel.html">Toplevel</a></div>
  85. <div class="level4"><a class="xref" href="Terminal.Gui.Window.html">Window</a></div>
  86. <div class="level5"><a class="xref" href="Terminal.Gui.Dialog.html">Dialog</a></div>
  87. <div class="level6"><span class="xref">FileDialog</span></div>
  88. <div class="level7"><a class="xref" href="Terminal.Gui.OpenDialog.html">OpenDialog</a></div>
  89. <div class="level7"><a class="xref" href="Terminal.Gui.SaveDialog.html">SaveDialog</a></div>
  90. </div>
  91. <div classs="implements">
  92. <h5>Implements</h5>
  93. <div><span class="xref">System.Collections.IEnumerable</span></div>
  94. </div>
  95. <div class="inheritedMembers">
  96. <h5>Inherited Members</h5>
  97. <div>
  98. <a class="xref" href="Terminal.Gui.Dialog.html#Terminal_Gui_Dialog_AddButton_Terminal_Gui_Button_">Dialog.AddButton(Button)</a>
  99. </div>
  100. <div>
  101. <a class="xref" href="Terminal.Gui.Dialog.html#Terminal_Gui_Dialog_LayoutSubviews">Dialog.LayoutSubviews()</a>
  102. </div>
  103. <div>
  104. <a class="xref" href="Terminal.Gui.Dialog.html#Terminal_Gui_Dialog_ProcessKey_Terminal_Gui_KeyEvent_">Dialog.ProcessKey(KeyEvent)</a>
  105. </div>
  106. <div>
  107. <a class="xref" href="Terminal.Gui.Window.html#Terminal_Gui_Window_Title">Window.Title</a>
  108. </div>
  109. <div>
  110. <a class="xref" href="Terminal.Gui.Window.html#Terminal_Gui_Window_GetEnumerator">Window.GetEnumerator()</a>
  111. </div>
  112. <div>
  113. <a class="xref" href="Terminal.Gui.Window.html#Terminal_Gui_Window_Add_Terminal_Gui_View_">Window.Add(View)</a>
  114. </div>
  115. <div>
  116. <a class="xref" href="Terminal.Gui.Window.html#Terminal_Gui_Window_Remove_Terminal_Gui_View_">Window.Remove(View)</a>
  117. </div>
  118. <div>
  119. <a class="xref" href="Terminal.Gui.Window.html#Terminal_Gui_Window_RemoveAll">Window.RemoveAll()</a>
  120. </div>
  121. <div>
  122. <a class="xref" href="Terminal.Gui.Window.html#Terminal_Gui_Window_Redraw_Terminal_Gui_Rect_">Window.Redraw(Rect)</a>
  123. </div>
  124. <div>
  125. <a class="xref" href="Terminal.Gui.Window.html#Terminal_Gui_Window_MouseEvent_Terminal_Gui_MouseEvent_">Window.MouseEvent(MouseEvent)</a>
  126. </div>
  127. <div>
  128. <a class="xref" href="Terminal.Gui.Toplevel.html#Terminal_Gui_Toplevel_Running">Toplevel.Running</a>
  129. </div>
  130. <div>
  131. <a class="xref" href="Terminal.Gui.Toplevel.html#Terminal_Gui_Toplevel_Ready">Toplevel.Ready</a>
  132. </div>
  133. <div>
  134. <a class="xref" href="Terminal.Gui.Toplevel.html#Terminal_Gui_Toplevel_Create">Toplevel.Create()</a>
  135. </div>
  136. <div>
  137. <a class="xref" href="Terminal.Gui.Toplevel.html#Terminal_Gui_Toplevel_CanFocus">Toplevel.CanFocus</a>
  138. </div>
  139. <div>
  140. <a class="xref" href="Terminal.Gui.Toplevel.html#Terminal_Gui_Toplevel_Modal">Toplevel.Modal</a>
  141. </div>
  142. <div>
  143. <a class="xref" href="Terminal.Gui.Toplevel.html#Terminal_Gui_Toplevel_MenuBar">Toplevel.MenuBar</a>
  144. </div>
  145. <div>
  146. <a class="xref" href="Terminal.Gui.Toplevel.html#Terminal_Gui_Toplevel_StatusBar">Toplevel.StatusBar</a>
  147. </div>
  148. <div>
  149. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Enter">View.Enter</a>
  150. </div>
  151. <div>
  152. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Leave">View.Leave</a>
  153. </div>
  154. <div>
  155. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_MouseEnter">View.MouseEnter</a>
  156. </div>
  157. <div>
  158. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_MouseLeave">View.MouseLeave</a>
  159. </div>
  160. <div>
  161. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Driver">View.Driver</a>
  162. </div>
  163. <div>
  164. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Subviews">View.Subviews</a>
  165. </div>
  166. <div>
  167. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Id">View.Id</a>
  168. </div>
  169. <div>
  170. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_IsCurrentTop">View.IsCurrentTop</a>
  171. </div>
  172. <div>
  173. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_WantMousePositionReports">View.WantMousePositionReports</a>
  174. </div>
  175. <div>
  176. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_WantContinuousButtonPressed">View.WantContinuousButtonPressed</a>
  177. </div>
  178. <div>
  179. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Frame">View.Frame</a>
  180. </div>
  181. <div>
  182. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_LayoutStyle">View.LayoutStyle</a>
  183. </div>
  184. <div>
  185. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Bounds">View.Bounds</a>
  186. </div>
  187. <div>
  188. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_X">View.X</a>
  189. </div>
  190. <div>
  191. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Y">View.Y</a>
  192. </div>
  193. <div>
  194. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Width">View.Width</a>
  195. </div>
  196. <div>
  197. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Height">View.Height</a>
  198. </div>
  199. <div>
  200. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SuperView">View.SuperView</a>
  201. </div>
  202. <div>
  203. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SetNeedsDisplay">View.SetNeedsDisplay()</a>
  204. </div>
  205. <div>
  206. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SetNeedsDisplay_Terminal_Gui_Rect_">View.SetNeedsDisplay(Rect)</a>
  207. </div>
  208. <div>
  209. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ChildNeedsDisplay">View.ChildNeedsDisplay()</a>
  210. </div>
  211. <div>
  212. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Add_Terminal_Gui_View___">View.Add(View[])</a>
  213. </div>
  214. <div>
  215. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_BringSubviewToFront_Terminal_Gui_View_">View.BringSubviewToFront(View)</a>
  216. </div>
  217. <div>
  218. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SendSubviewToBack_Terminal_Gui_View_">View.SendSubviewToBack(View)</a>
  219. </div>
  220. <div>
  221. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SendSubviewBackwards_Terminal_Gui_View_">View.SendSubviewBackwards(View)</a>
  222. </div>
  223. <div>
  224. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_BringSubviewForward_Terminal_Gui_View_">View.BringSubviewForward(View)</a>
  225. </div>
  226. <div>
  227. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Clear">View.Clear()</a>
  228. </div>
  229. <div>
  230. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Clear_Terminal_Gui_Rect_">View.Clear(Rect)</a>
  231. </div>
  232. <div>
  233. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ScreenToView_System_Int32_System_Int32_">View.ScreenToView(Int32, Int32)</a>
  234. </div>
  235. <div>
  236. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ClipToBounds">View.ClipToBounds()</a>
  237. </div>
  238. <div>
  239. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SetClip_Terminal_Gui_Rect_">View.SetClip(Rect)</a>
  240. </div>
  241. <div>
  242. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_DrawFrame_Terminal_Gui_Rect_System_Int32_System_Boolean_">View.DrawFrame(Rect, Int32, Boolean)</a>
  243. </div>
  244. <div>
  245. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_DrawHotString_NStack_ustring_Terminal_Gui_Attribute_Terminal_Gui_Attribute_">View.DrawHotString(ustring, Attribute, Attribute)</a>
  246. </div>
  247. <div>
  248. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_DrawHotString_NStack_ustring_System_Boolean_Terminal_Gui_ColorScheme_">View.DrawHotString(ustring, Boolean, ColorScheme)</a>
  249. </div>
  250. <div>
  251. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Move_System_Int32_System_Int32_">View.Move(Int32, Int32)</a>
  252. </div>
  253. <div>
  254. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_PositionCursor">View.PositionCursor()</a>
  255. </div>
  256. <div>
  257. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_HasFocus">View.HasFocus</a>
  258. </div>
  259. <div>
  260. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnEnter">View.OnEnter()</a>
  261. </div>
  262. <div>
  263. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnLeave">View.OnLeave()</a>
  264. </div>
  265. <div>
  266. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Focused">View.Focused</a>
  267. </div>
  268. <div>
  269. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_MostFocused">View.MostFocused</a>
  270. </div>
  271. <div>
  272. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ColorScheme">View.ColorScheme</a>
  273. </div>
  274. <div>
  275. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_AddRune_System_Int32_System_Int32_System_Rune_">View.AddRune(Int32, Int32, Rune)</a>
  276. </div>
  277. <div>
  278. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ClearNeedsDisplay">View.ClearNeedsDisplay()</a>
  279. </div>
  280. <div>
  281. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SetFocus_Terminal_Gui_View_">View.SetFocus(View)</a>
  282. </div>
  283. <div>
  284. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_KeyPress">View.KeyPress</a>
  285. </div>
  286. <div>
  287. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ProcessHotKey_Terminal_Gui_KeyEvent_">View.ProcessHotKey(KeyEvent)</a>
  288. </div>
  289. <div>
  290. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ProcessColdKey_Terminal_Gui_KeyEvent_">View.ProcessColdKey(KeyEvent)</a>
  291. </div>
  292. <div>
  293. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_KeyDown">View.KeyDown</a>
  294. </div>
  295. <div>
  296. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnKeyDown_Terminal_Gui_KeyEvent_">View.OnKeyDown(KeyEvent)</a>
  297. </div>
  298. <div>
  299. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_KeyUp">View.KeyUp</a>
  300. </div>
  301. <div>
  302. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnKeyUp_Terminal_Gui_KeyEvent_">View.OnKeyUp(KeyEvent)</a>
  303. </div>
  304. <div>
  305. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_EnsureFocus">View.EnsureFocus()</a>
  306. </div>
  307. <div>
  308. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_FocusFirst">View.FocusFirst()</a>
  309. </div>
  310. <div>
  311. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_FocusLast">View.FocusLast()</a>
  312. </div>
  313. <div>
  314. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_FocusPrev">View.FocusPrev()</a>
  315. </div>
  316. <div>
  317. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_FocusNext">View.FocusNext()</a>
  318. </div>
  319. <div>
  320. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ToString">View.ToString()</a>
  321. </div>
  322. <div>
  323. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnMouseEnter_Terminal_Gui_MouseEvent_">View.OnMouseEnter(MouseEvent)</a>
  324. </div>
  325. <div>
  326. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnMouseLeave_Terminal_Gui_MouseEvent_">View.OnMouseLeave(MouseEvent)</a>
  327. </div>
  328. <div>
  329. <span class="xref">System.Object.Equals(System.Object)</span>
  330. </div>
  331. <div>
  332. <span class="xref">System.Object.Equals(System.Object, System.Object)</span>
  333. </div>
  334. <div>
  335. <span class="xref">System.Object.GetHashCode()</span>
  336. </div>
  337. <div>
  338. <span class="xref">System.Object.GetType()</span>
  339. </div>
  340. <div>
  341. <span class="xref">System.Object.MemberwiseClone()</span>
  342. </div>
  343. <div>
  344. <span class="xref">System.Object.ReferenceEquals(System.Object, System.Object)</span>
  345. </div>
  346. </div>
  347. <h6><strong>Namespace</strong>: <a class="xref" href="Terminal.Gui.html">Terminal.Gui</a></h6>
  348. <h6><strong>Assembly</strong>: Terminal.Gui.dll</h6>
  349. <h5 id="Terminal_Gui_FileDialog_syntax">Syntax</h5>
  350. <div class="codewrapper">
  351. <pre><code class="lang-csharp hljs">public class FileDialog : Dialog, IEnumerable</code></pre>
  352. </div>
  353. <h3 id="constructors">Constructors
  354. </h3>
  355. <a id="Terminal_Gui_FileDialog__ctor_" data-uid="Terminal.Gui.FileDialog.#ctor*"></a>
  356. <h4 id="Terminal_Gui_FileDialog__ctor_NStack_ustring_NStack_ustring_NStack_ustring_NStack_ustring_" data-uid="Terminal.Gui.FileDialog.#ctor(NStack.ustring,NStack.ustring,NStack.ustring,NStack.ustring)">FileDialog(ustring, ustring, ustring, ustring)</h4>
  357. <div class="markdown level1 summary">
  358. Initializes a new instance of <a class="xref" href="Terminal.Gui.FileDialog.html">FileDialog</a>
  359. </div>
  360. <div class="markdown level1 conceptual"></div>
  361. <h5 class="decalaration">Declaration</h5>
  362. <div class="codewrapper">
  363. <pre><code class="lang-csharp hljs">public FileDialog(ustring title, ustring prompt, ustring nameFieldLabel, ustring message)</code></pre>
  364. </div>
  365. <h5 class="parameters">Parameters</h5>
  366. <table class="table table-bordered table-striped table-condensed">
  367. <thead>
  368. <tr>
  369. <th>Type</th>
  370. <th>Name</th>
  371. <th>Description</th>
  372. </tr>
  373. </thead>
  374. <tbody>
  375. <tr>
  376. <td><span class="xref">NStack.ustring</span></td>
  377. <td><span class="parametername">title</span></td>
  378. <td>The title.</td>
  379. </tr>
  380. <tr>
  381. <td><span class="xref">NStack.ustring</span></td>
  382. <td><span class="parametername">prompt</span></td>
  383. <td>The prompt.</td>
  384. </tr>
  385. <tr>
  386. <td><span class="xref">NStack.ustring</span></td>
  387. <td><span class="parametername">nameFieldLabel</span></td>
  388. <td>The name field label.</td>
  389. </tr>
  390. <tr>
  391. <td><span class="xref">NStack.ustring</span></td>
  392. <td><span class="parametername">message</span></td>
  393. <td>The message.</td>
  394. </tr>
  395. </tbody>
  396. </table>
  397. <h3 id="properties">Properties
  398. </h3>
  399. <a id="Terminal_Gui_FileDialog_AllowedFileTypes_" data-uid="Terminal.Gui.FileDialog.AllowedFileTypes*"></a>
  400. <h4 id="Terminal_Gui_FileDialog_AllowedFileTypes" data-uid="Terminal.Gui.FileDialog.AllowedFileTypes">AllowedFileTypes</h4>
  401. <div class="markdown level1 summary">
  402. The array of filename extensions allowed, or null if all file extensions are allowed.
  403. </div>
  404. <div class="markdown level1 conceptual"></div>
  405. <h5 class="decalaration">Declaration</h5>
  406. <div class="codewrapper">
  407. <pre><code class="lang-csharp hljs">public string[] AllowedFileTypes { get; set; }</code></pre>
  408. </div>
  409. <h5 class="propertyValue">Property Value</h5>
  410. <table class="table table-bordered table-striped table-condensed">
  411. <thead>
  412. <tr>
  413. <th>Type</th>
  414. <th>Description</th>
  415. </tr>
  416. </thead>
  417. <tbody>
  418. <tr>
  419. <td><span class="xref">System.String</span>[]</td>
  420. <td>The allowed file types.</td>
  421. </tr>
  422. </tbody>
  423. </table>
  424. <a id="Terminal_Gui_FileDialog_AllowsOtherFileTypes_" data-uid="Terminal.Gui.FileDialog.AllowsOtherFileTypes*"></a>
  425. <h4 id="Terminal_Gui_FileDialog_AllowsOtherFileTypes" data-uid="Terminal.Gui.FileDialog.AllowsOtherFileTypes">AllowsOtherFileTypes</h4>
  426. <div class="markdown level1 summary">
  427. Gets or sets a value indicating whether this <a class="xref" href="Terminal.Gui.FileDialog.html">FileDialog</a> allows the file to be saved with a different extension
  428. </div>
  429. <div class="markdown level1 conceptual"></div>
  430. <h5 class="decalaration">Declaration</h5>
  431. <div class="codewrapper">
  432. <pre><code class="lang-csharp hljs">public bool AllowsOtherFileTypes { get; set; }</code></pre>
  433. </div>
  434. <h5 class="propertyValue">Property Value</h5>
  435. <table class="table table-bordered table-striped table-condensed">
  436. <thead>
  437. <tr>
  438. <th>Type</th>
  439. <th>Description</th>
  440. </tr>
  441. </thead>
  442. <tbody>
  443. <tr>
  444. <td><span class="xref">System.Boolean</span></td>
  445. <td><code>true</code> if allows other file types; otherwise, <code>false</code>.</td>
  446. </tr>
  447. </tbody>
  448. </table>
  449. <a id="Terminal_Gui_FileDialog_Canceled_" data-uid="Terminal.Gui.FileDialog.Canceled*"></a>
  450. <h4 id="Terminal_Gui_FileDialog_Canceled" data-uid="Terminal.Gui.FileDialog.Canceled">Canceled</h4>
  451. <div class="markdown level1 summary">
  452. Check if the dialog was or not canceled.
  453. </div>
  454. <div class="markdown level1 conceptual"></div>
  455. <h5 class="decalaration">Declaration</h5>
  456. <div class="codewrapper">
  457. <pre><code class="lang-csharp hljs">public bool Canceled { get; }</code></pre>
  458. </div>
  459. <h5 class="propertyValue">Property Value</h5>
  460. <table class="table table-bordered table-striped table-condensed">
  461. <thead>
  462. <tr>
  463. <th>Type</th>
  464. <th>Description</th>
  465. </tr>
  466. </thead>
  467. <tbody>
  468. <tr>
  469. <td><span class="xref">System.Boolean</span></td>
  470. <td></td>
  471. </tr>
  472. </tbody>
  473. </table>
  474. <a id="Terminal_Gui_FileDialog_CanCreateDirectories_" data-uid="Terminal.Gui.FileDialog.CanCreateDirectories*"></a>
  475. <h4 id="Terminal_Gui_FileDialog_CanCreateDirectories" data-uid="Terminal.Gui.FileDialog.CanCreateDirectories">CanCreateDirectories</h4>
  476. <div class="markdown level1 summary">
  477. Gets or sets a value indicating whether this <a class="xref" href="Terminal.Gui.FileDialog.html">FileDialog</a> can create directories.
  478. </div>
  479. <div class="markdown level1 conceptual"></div>
  480. <h5 class="decalaration">Declaration</h5>
  481. <div class="codewrapper">
  482. <pre><code class="lang-csharp hljs">public bool CanCreateDirectories { get; set; }</code></pre>
  483. </div>
  484. <h5 class="propertyValue">Property Value</h5>
  485. <table class="table table-bordered table-striped table-condensed">
  486. <thead>
  487. <tr>
  488. <th>Type</th>
  489. <th>Description</th>
  490. </tr>
  491. </thead>
  492. <tbody>
  493. <tr>
  494. <td><span class="xref">System.Boolean</span></td>
  495. <td><code>true</code> if can create directories; otherwise, <code>false</code>.</td>
  496. </tr>
  497. </tbody>
  498. </table>
  499. <a id="Terminal_Gui_FileDialog_DirectoryPath_" data-uid="Terminal.Gui.FileDialog.DirectoryPath*"></a>
  500. <h4 id="Terminal_Gui_FileDialog_DirectoryPath" data-uid="Terminal.Gui.FileDialog.DirectoryPath">DirectoryPath</h4>
  501. <div class="markdown level1 summary">
  502. Gets or sets the directory path for this panel
  503. </div>
  504. <div class="markdown level1 conceptual"></div>
  505. <h5 class="decalaration">Declaration</h5>
  506. <div class="codewrapper">
  507. <pre><code class="lang-csharp hljs">public ustring DirectoryPath { get; set; }</code></pre>
  508. </div>
  509. <h5 class="propertyValue">Property Value</h5>
  510. <table class="table table-bordered table-striped table-condensed">
  511. <thead>
  512. <tr>
  513. <th>Type</th>
  514. <th>Description</th>
  515. </tr>
  516. </thead>
  517. <tbody>
  518. <tr>
  519. <td><span class="xref">NStack.ustring</span></td>
  520. <td>The directory path.</td>
  521. </tr>
  522. </tbody>
  523. </table>
  524. <a id="Terminal_Gui_FileDialog_FilePath_" data-uid="Terminal.Gui.FileDialog.FilePath*"></a>
  525. <h4 id="Terminal_Gui_FileDialog_FilePath" data-uid="Terminal.Gui.FileDialog.FilePath">FilePath</h4>
  526. <div class="markdown level1 summary">
  527. The File path that is currently shown on the panel
  528. </div>
  529. <div class="markdown level1 conceptual"></div>
  530. <h5 class="decalaration">Declaration</h5>
  531. <div class="codewrapper">
  532. <pre><code class="lang-csharp hljs">public ustring FilePath { get; set; }</code></pre>
  533. </div>
  534. <h5 class="propertyValue">Property Value</h5>
  535. <table class="table table-bordered table-striped table-condensed">
  536. <thead>
  537. <tr>
  538. <th>Type</th>
  539. <th>Description</th>
  540. </tr>
  541. </thead>
  542. <tbody>
  543. <tr>
  544. <td><span class="xref">NStack.ustring</span></td>
  545. <td>The absolute file path for the file path entered.</td>
  546. </tr>
  547. </tbody>
  548. </table>
  549. <a id="Terminal_Gui_FileDialog_IsExtensionHidden_" data-uid="Terminal.Gui.FileDialog.IsExtensionHidden*"></a>
  550. <h4 id="Terminal_Gui_FileDialog_IsExtensionHidden" data-uid="Terminal.Gui.FileDialog.IsExtensionHidden">IsExtensionHidden</h4>
  551. <div class="markdown level1 summary">
  552. Gets or sets a value indicating whether this <a class="xref" href="Terminal.Gui.FileDialog.html">FileDialog</a> is extension hidden.
  553. </div>
  554. <div class="markdown level1 conceptual"></div>
  555. <h5 class="decalaration">Declaration</h5>
  556. <div class="codewrapper">
  557. <pre><code class="lang-csharp hljs">public bool IsExtensionHidden { get; set; }</code></pre>
  558. </div>
  559. <h5 class="propertyValue">Property Value</h5>
  560. <table class="table table-bordered table-striped table-condensed">
  561. <thead>
  562. <tr>
  563. <th>Type</th>
  564. <th>Description</th>
  565. </tr>
  566. </thead>
  567. <tbody>
  568. <tr>
  569. <td><span class="xref">System.Boolean</span></td>
  570. <td><code>true</code> if is extension hidden; otherwise, <code>false</code>.</td>
  571. </tr>
  572. </tbody>
  573. </table>
  574. <a id="Terminal_Gui_FileDialog_Message_" data-uid="Terminal.Gui.FileDialog.Message*"></a>
  575. <h4 id="Terminal_Gui_FileDialog_Message" data-uid="Terminal.Gui.FileDialog.Message">Message</h4>
  576. <div class="markdown level1 summary">
  577. Gets or sets the message displayed to the user, defaults to nothing
  578. </div>
  579. <div class="markdown level1 conceptual"></div>
  580. <h5 class="decalaration">Declaration</h5>
  581. <div class="codewrapper">
  582. <pre><code class="lang-csharp hljs">public ustring Message { get; set; }</code></pre>
  583. </div>
  584. <h5 class="propertyValue">Property Value</h5>
  585. <table class="table table-bordered table-striped table-condensed">
  586. <thead>
  587. <tr>
  588. <th>Type</th>
  589. <th>Description</th>
  590. </tr>
  591. </thead>
  592. <tbody>
  593. <tr>
  594. <td><span class="xref">NStack.ustring</span></td>
  595. <td>The message.</td>
  596. </tr>
  597. </tbody>
  598. </table>
  599. <a id="Terminal_Gui_FileDialog_NameFieldLabel_" data-uid="Terminal.Gui.FileDialog.NameFieldLabel*"></a>
  600. <h4 id="Terminal_Gui_FileDialog_NameFieldLabel" data-uid="Terminal.Gui.FileDialog.NameFieldLabel">NameFieldLabel</h4>
  601. <div class="markdown level1 summary">
  602. Gets or sets the name field label.
  603. </div>
  604. <div class="markdown level1 conceptual"></div>
  605. <h5 class="decalaration">Declaration</h5>
  606. <div class="codewrapper">
  607. <pre><code class="lang-csharp hljs">public ustring NameFieldLabel { get; set; }</code></pre>
  608. </div>
  609. <h5 class="propertyValue">Property Value</h5>
  610. <table class="table table-bordered table-striped table-condensed">
  611. <thead>
  612. <tr>
  613. <th>Type</th>
  614. <th>Description</th>
  615. </tr>
  616. </thead>
  617. <tbody>
  618. <tr>
  619. <td><span class="xref">NStack.ustring</span></td>
  620. <td>The name field label.</td>
  621. </tr>
  622. </tbody>
  623. </table>
  624. <a id="Terminal_Gui_FileDialog_Prompt_" data-uid="Terminal.Gui.FileDialog.Prompt*"></a>
  625. <h4 id="Terminal_Gui_FileDialog_Prompt" data-uid="Terminal.Gui.FileDialog.Prompt">Prompt</h4>
  626. <div class="markdown level1 summary">
  627. Gets or sets the prompt label for the <a class="xref" href="Terminal.Gui.Button.html">Button</a> displayed to the user
  628. </div>
  629. <div class="markdown level1 conceptual"></div>
  630. <h5 class="decalaration">Declaration</h5>
  631. <div class="codewrapper">
  632. <pre><code class="lang-csharp hljs">public ustring Prompt { get; set; }</code></pre>
  633. </div>
  634. <h5 class="propertyValue">Property Value</h5>
  635. <table class="table table-bordered table-striped table-condensed">
  636. <thead>
  637. <tr>
  638. <th>Type</th>
  639. <th>Description</th>
  640. </tr>
  641. </thead>
  642. <tbody>
  643. <tr>
  644. <td><span class="xref">NStack.ustring</span></td>
  645. <td>The prompt.</td>
  646. </tr>
  647. </tbody>
  648. </table>
  649. <h3 id="methods">Methods
  650. </h3>
  651. <a id="Terminal_Gui_FileDialog_WillPresent_" data-uid="Terminal.Gui.FileDialog.WillPresent*"></a>
  652. <h4 id="Terminal_Gui_FileDialog_WillPresent" data-uid="Terminal.Gui.FileDialog.WillPresent">WillPresent()</h4>
  653. <div class="markdown level1 summary"></div>
  654. <div class="markdown level1 conceptual"></div>
  655. <h5 class="decalaration">Declaration</h5>
  656. <div class="codewrapper">
  657. <pre><code class="lang-csharp hljs">public override void WillPresent()</code></pre>
  658. </div>
  659. <h5 class="overrides">Overrides</h5>
  660. <div><a class="xref" href="Terminal.Gui.Toplevel.html#Terminal_Gui_Toplevel_WillPresent">Toplevel.WillPresent()</a></div>
  661. <h3 id="implements">Implements</h3>
  662. <div>
  663. <span class="xref">System.Collections.IEnumerable</span>
  664. </div>
  665. </article>
  666. </div>
  667. <div class="hidden-sm col-md-2" role="complementary">
  668. <div class="sideaffix">
  669. <div class="contribution">
  670. <ul class="nav">
  671. </ul>
  672. </div>
  673. <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
  674. <!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
  675. </nav>
  676. </div>
  677. </div>
  678. </div>
  679. </div>
  680. <footer>
  681. <div class="grad-bottom"></div>
  682. <div class="footer">
  683. <div class="container">
  684. <span class="pull-right">
  685. <a href="#top">Back to top</a>
  686. </span>
  687. <span>Generated by <strong>DocFX</strong></span>
  688. </div>
  689. </div>
  690. </footer>
  691. </div>
  692. <script type="text/javascript" src="../../styles/docfx.vendor.js"></script>
  693. <script type="text/javascript" src="../../styles/docfx.js"></script>
  694. <script type="text/javascript" src="../../styles/main.js"></script>
  695. </body>
  696. </html>