Terminal.Gui.Wizard.html 63 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414
  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 Wizard
  8. </title>
  9. <meta name="viewport" content="width=device-width">
  10. <meta name="title" content="Class Wizard
  11. ">
  12. <meta name="generator" content="docfx 2.59.3.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=Source Sans Pro" rel="stylesheet">
  18. <link href="https://fonts.googleapis.com/css?family=Source Code Pro" rel="stylesheet">
  19. <meta property="docfx:navrel" content="../../toc.html">
  20. <meta property="docfx:tocrel" content="toc.html">
  21. <meta property="docfx:rel" content="../../">
  22. </head> <body data-spy="scroll" data-target="#affix" data-offset="120">
  23. <div id="wrapper">
  24. <header>
  25. <nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation">
  26. <div class="container">
  27. <div class="navbar-header">
  28. <button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
  29. <span class="sr-only">Toggle navigation</span>
  30. <span class="icon-bar"></span>
  31. <span class="icon-bar"></span>
  32. <span class="icon-bar"></span>
  33. </button>
  34. <a class="navbar-brand" href="../../index.html">
  35. <img id="logo" class="svg" src="../../images/logo48.png" alt="">
  36. </a>
  37. </div>
  38. <div class="collapse navbar-collapse" id="navbar">
  39. <form class="navbar-form navbar-right" role="search" id="search">
  40. <div class="form-group">
  41. <input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">
  42. </div>
  43. </form>
  44. </div>
  45. </div>
  46. </nav>
  47. <div class="subnav navbar navbar-default">
  48. <div class="container hide-when-search" id="breadcrumb">
  49. <ul class="breadcrumb">
  50. <li></li>
  51. </ul>
  52. </div>
  53. </div>
  54. </header>
  55. <div class="container body-content">
  56. <div id="search-results">
  57. <div class="search-list">Search Results for <span></span></div>
  58. <div class="sr-items">
  59. <p><i class="glyphicon glyphicon-refresh index-loading"></i></p>
  60. </div>
  61. <ul id="pagination" data-first="First" data-prev="Previous" data-next="Next" data-last="Last"></ul>
  62. </div>
  63. </div>
  64. <div role="main" class="container body-content hide-when-search">
  65. <div class="sidenav hide-when-search">
  66. <a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
  67. <div class="sidetoggle collapse" id="sidetoggle">
  68. <div id="sidetoc"></div>
  69. </div>
  70. </div>
  71. <div class="article row grid-right">
  72. <div class="col-md-10">
  73. <article class="content wrap" id="_content" data-uid="Terminal.Gui.Wizard">
  74. <h1 id="Terminal_Gui_Wizard" data-uid="Terminal.Gui.Wizard" class="text-break">Class Wizard
  75. </h1>
  76. <div class="markdown level0 summary">
  77. Provides navigation and a user interface (UI) to collect related data across multiple steps. Each step (<a class="xref" href="Terminal.Gui.Wizard.WizardStep.html">Wizard.WizardStep</a>) can host
  78. arbitrary <a class="xref" href="Terminal.Gui.View.html">View</a>s, much like a <a class="xref" href="Terminal.Gui.Dialog.html">Dialog</a>. Each step also has a pane for help text. Along the
  79. bottom of the Wizard view are customizable buttons enabling the user to navigate forward and backward through the Wizard.
  80. </div>
  81. <div class="markdown level0 conceptual"></div>
  82. <div class="inheritance">
  83. <h5>Inheritance</h5>
  84. <div class="level0"><span class="xref">System.Object</span></div>
  85. <div class="level1"><a class="xref" href="Terminal.Gui.Responder.html">Responder</a></div>
  86. <div class="level2"><a class="xref" href="Terminal.Gui.View.html">View</a></div>
  87. <div class="level3"><a class="xref" href="Terminal.Gui.Toplevel.html">Toplevel</a></div>
  88. <div class="level4"><a class="xref" href="Terminal.Gui.Window.html">Window</a></div>
  89. <div class="level5"><a class="xref" href="Terminal.Gui.Dialog.html">Dialog</a></div>
  90. <div class="level6"><span class="xref">Wizard</span></div>
  91. </div>
  92. <div class="implements">
  93. <h5>Implements</h5>
  94. <div><span class="xref">System.IDisposable</span></div>
  95. <div><span class="xref">System.ComponentModel.ISupportInitializeNotification</span></div>
  96. <div><span class="xref">System.ComponentModel.ISupportInitialize</span></div>
  97. </div>
  98. <h5 id="Terminal_Gui_Wizard_remarks"><strong>Remarks</strong></h5>
  99. <div class="markdown level0 remarks">
  100. The Wizard can be displayed either as a modal (pop-up) <a class="xref" href="Terminal.Gui.Window.html">Window</a> (like <a class="xref" href="Terminal.Gui.Dialog.html">Dialog</a>) or as an embedded <a class="xref" href="Terminal.Gui.View.html">View</a>.
  101. By default, <a class="xref" href="Terminal.Gui.Wizard.html#Terminal_Gui_Wizard_Modal">Modal</a> is <code>true</code>. In this case launch the Wizard with <code>Application.Run(wizard)</code>.
  102. See <a class="xref" href="Terminal.Gui.Wizard.html#Terminal_Gui_Wizard_Modal">Modal</a> for more details.
  103. </div>
  104. <h5 id="Terminal_Gui_Wizard_examples"><strong>Examples</strong></h5>
  105. <pre><code>using Terminal.Gui;
  106. using NStack;
  107. Application.Init();
  108. var wizard = new Wizard ($&quot;Setup Wizard&quot;);
  109. // Add 1st step
  110. var firstStep = new Wizard.WizardStep (&quot;End User License Agreement&quot;);
  111. wizard.AddStep(firstStep);
  112. firstStep.NextButtonText = &quot;Accept!&quot;;
  113. firstStep.HelpText = &quot;This is the End User License Agreement.&quot;;
  114. // Add 2nd step
  115. var secondStep = new Wizard.WizardStep (&quot;Second Step&quot;);
  116. wizard.AddStep(secondStep);
  117. secondStep.HelpText = &quot;This is the help text for the Second Step.&quot;;
  118. var lbl = new Label (&quot;Name:&quot;) { AutoSize = true };
  119. secondStep.Add(lbl);
  120. var name = new TextField () { X = Pos.Right (lbl) + 1, Width = Dim.Fill () - 1 };
  121. secondStep.Add(name);
  122. wizard.Finished += (args) =>
  123. {
  124. MessageBox.Query(&quot;Wizard&quot;, $&quot;Finished. The Name entered is &apos;{name.Text}&apos;&quot;, &quot;Ok&quot;);
  125. Application.RequestStop();
  126. };
  127. Application.Top.Add (wizard);
  128. Application.Run ();
  129. Application.Shutdown ();</code></pre>
  130. <div class="inheritedMembers">
  131. <h5>Inherited Members</h5>
  132. <div>
  133. <a class="xref" href="Terminal.Gui.Dialog.html#Terminal_Gui_Dialog_AddButton_Terminal_Gui_Button_">Dialog.AddButton(Button)</a>
  134. </div>
  135. <div>
  136. <a class="xref" href="Terminal.Gui.Dialog.html#Terminal_Gui_Dialog_ButtonAlignment">Dialog.ButtonAlignment</a>
  137. </div>
  138. <div>
  139. <a class="xref" href="Terminal.Gui.Window.html#Terminal_Gui_Window_Add_Terminal_Gui_View_">Window.Add(View)</a>
  140. </div>
  141. <div>
  142. <a class="xref" href="Terminal.Gui.Window.html#Terminal_Gui_Window_Remove_Terminal_Gui_View_">Window.Remove(View)</a>
  143. </div>
  144. <div>
  145. <a class="xref" href="Terminal.Gui.Window.html#Terminal_Gui_Window_RemoveAll">Window.RemoveAll()</a>
  146. </div>
  147. <div>
  148. <a class="xref" href="Terminal.Gui.Window.html#Terminal_Gui_Window_Redraw_Terminal_Gui_Rect_">Window.Redraw(Rect)</a>
  149. </div>
  150. <div>
  151. <a class="xref" href="Terminal.Gui.Window.html#Terminal_Gui_Window_OnCanFocusChanged">Window.OnCanFocusChanged()</a>
  152. </div>
  153. <div>
  154. <a class="xref" href="Terminal.Gui.Window.html#Terminal_Gui_Window_OnTitleChanging_NStack_ustring_NStack_ustring_">Window.OnTitleChanging(ustring, ustring)</a>
  155. </div>
  156. <div>
  157. <a class="xref" href="Terminal.Gui.Window.html#Terminal_Gui_Window_OnTitleChanged_NStack_ustring_NStack_ustring_">Window.OnTitleChanged(ustring, ustring)</a>
  158. </div>
  159. <div>
  160. <a class="xref" href="Terminal.Gui.Window.html#Terminal_Gui_Window_Border">Window.Border</a>
  161. </div>
  162. <div>
  163. <a class="xref" href="Terminal.Gui.Window.html#Terminal_Gui_Window_Text">Window.Text</a>
  164. </div>
  165. <div>
  166. <a class="xref" href="Terminal.Gui.Window.html#Terminal_Gui_Window_TextAlignment">Window.TextAlignment</a>
  167. </div>
  168. <div>
  169. <a class="xref" href="Terminal.Gui.Window.html#Terminal_Gui_Window_TitleChanging">Window.TitleChanging</a>
  170. </div>
  171. <div>
  172. <a class="xref" href="Terminal.Gui.Window.html#Terminal_Gui_Window_TitleChanged">Window.TitleChanged</a>
  173. </div>
  174. <div>
  175. <a class="xref" href="Terminal.Gui.Toplevel.html#Terminal_Gui_Toplevel_OnLoaded">Toplevel.OnLoaded()</a>
  176. </div>
  177. <div>
  178. <a class="xref" href="Terminal.Gui.Toplevel.html#Terminal_Gui_Toplevel_OnAlternateForwardKeyChanged_Terminal_Gui_Key_">Toplevel.OnAlternateForwardKeyChanged(Key)</a>
  179. </div>
  180. <div>
  181. <a class="xref" href="Terminal.Gui.Toplevel.html#Terminal_Gui_Toplevel_OnAlternateBackwardKeyChanged_Terminal_Gui_Key_">Toplevel.OnAlternateBackwardKeyChanged(Key)</a>
  182. </div>
  183. <div>
  184. <a class="xref" href="Terminal.Gui.Toplevel.html#Terminal_Gui_Toplevel_OnQuitKeyChanged_Terminal_Gui_Key_">Toplevel.OnQuitKeyChanged(Key)</a>
  185. </div>
  186. <div>
  187. <a class="xref" href="Terminal.Gui.Toplevel.html#Terminal_Gui_Toplevel_Create">Toplevel.Create()</a>
  188. </div>
  189. <div>
  190. <a class="xref" href="Terminal.Gui.Toplevel.html#Terminal_Gui_Toplevel_OnKeyDown_Terminal_Gui_KeyEvent_">Toplevel.OnKeyDown(KeyEvent)</a>
  191. </div>
  192. <div>
  193. <a class="xref" href="Terminal.Gui.Toplevel.html#Terminal_Gui_Toplevel_OnKeyUp_Terminal_Gui_KeyEvent_">Toplevel.OnKeyUp(KeyEvent)</a>
  194. </div>
  195. <div>
  196. <a class="xref" href="Terminal.Gui.Toplevel.html#Terminal_Gui_Toplevel_ProcessColdKey_Terminal_Gui_KeyEvent_">Toplevel.ProcessColdKey(KeyEvent)</a>
  197. </div>
  198. <div>
  199. <a class="xref" href="Terminal.Gui.Toplevel.html#Terminal_Gui_Toplevel_PositionToplevel_Terminal_Gui_Toplevel_">Toplevel.PositionToplevel(Toplevel)</a>
  200. </div>
  201. <div>
  202. <a class="xref" href="Terminal.Gui.Toplevel.html#Terminal_Gui_Toplevel_MouseEvent_Terminal_Gui_MouseEvent_">Toplevel.MouseEvent(MouseEvent)</a>
  203. </div>
  204. <div>
  205. <a class="xref" href="Terminal.Gui.Toplevel.html#Terminal_Gui_Toplevel_WillPresent">Toplevel.WillPresent()</a>
  206. </div>
  207. <div>
  208. <a class="xref" href="Terminal.Gui.Toplevel.html#Terminal_Gui_Toplevel_MoveNext">Toplevel.MoveNext()</a>
  209. </div>
  210. <div>
  211. <a class="xref" href="Terminal.Gui.Toplevel.html#Terminal_Gui_Toplevel_MovePrevious">Toplevel.MovePrevious()</a>
  212. </div>
  213. <div>
  214. <a class="xref" href="Terminal.Gui.Toplevel.html#Terminal_Gui_Toplevel_RequestStop">Toplevel.RequestStop()</a>
  215. </div>
  216. <div>
  217. <a class="xref" href="Terminal.Gui.Toplevel.html#Terminal_Gui_Toplevel_RequestStop_Terminal_Gui_Toplevel_">Toplevel.RequestStop(Toplevel)</a>
  218. </div>
  219. <div>
  220. <a class="xref" href="Terminal.Gui.Toplevel.html#Terminal_Gui_Toplevel_PositionCursor">Toplevel.PositionCursor()</a>
  221. </div>
  222. <div>
  223. <a class="xref" href="Terminal.Gui.Toplevel.html#Terminal_Gui_Toplevel_GetTopMdiChild_System_Type_System_String___">Toplevel.GetTopMdiChild(Type, String[])</a>
  224. </div>
  225. <div>
  226. <a class="xref" href="Terminal.Gui.Toplevel.html#Terminal_Gui_Toplevel_ShowChild_Terminal_Gui_Toplevel_">Toplevel.ShowChild(Toplevel)</a>
  227. </div>
  228. <div>
  229. <a class="xref" href="Terminal.Gui.Toplevel.html#Terminal_Gui_Toplevel_Running">Toplevel.Running</a>
  230. </div>
  231. <div>
  232. <a class="xref" href="Terminal.Gui.Toplevel.html#Terminal_Gui_Toplevel_CanFocus">Toplevel.CanFocus</a>
  233. </div>
  234. <div>
  235. <a class="xref" href="Terminal.Gui.Toplevel.html#Terminal_Gui_Toplevel_MenuBar">Toplevel.MenuBar</a>
  236. </div>
  237. <div>
  238. <a class="xref" href="Terminal.Gui.Toplevel.html#Terminal_Gui_Toplevel_StatusBar">Toplevel.StatusBar</a>
  239. </div>
  240. <div>
  241. <a class="xref" href="Terminal.Gui.Toplevel.html#Terminal_Gui_Toplevel_IsMdiContainer">Toplevel.IsMdiContainer</a>
  242. </div>
  243. <div>
  244. <a class="xref" href="Terminal.Gui.Toplevel.html#Terminal_Gui_Toplevel_IsMdiChild">Toplevel.IsMdiChild</a>
  245. </div>
  246. <div>
  247. <a class="xref" href="Terminal.Gui.Toplevel.html#Terminal_Gui_Toplevel_Loaded">Toplevel.Loaded</a>
  248. </div>
  249. <div>
  250. <a class="xref" href="Terminal.Gui.Toplevel.html#Terminal_Gui_Toplevel_Ready">Toplevel.Ready</a>
  251. </div>
  252. <div>
  253. <a class="xref" href="Terminal.Gui.Toplevel.html#Terminal_Gui_Toplevel_Unloaded">Toplevel.Unloaded</a>
  254. </div>
  255. <div>
  256. <a class="xref" href="Terminal.Gui.Toplevel.html#Terminal_Gui_Toplevel_Activate">Toplevel.Activate</a>
  257. </div>
  258. <div>
  259. <a class="xref" href="Terminal.Gui.Toplevel.html#Terminal_Gui_Toplevel_Deactivate">Toplevel.Deactivate</a>
  260. </div>
  261. <div>
  262. <a class="xref" href="Terminal.Gui.Toplevel.html#Terminal_Gui_Toplevel_ChildClosed">Toplevel.ChildClosed</a>
  263. </div>
  264. <div>
  265. <a class="xref" href="Terminal.Gui.Toplevel.html#Terminal_Gui_Toplevel_AllChildClosed">Toplevel.AllChildClosed</a>
  266. </div>
  267. <div>
  268. <a class="xref" href="Terminal.Gui.Toplevel.html#Terminal_Gui_Toplevel_Closing">Toplevel.Closing</a>
  269. </div>
  270. <div>
  271. <a class="xref" href="Terminal.Gui.Toplevel.html#Terminal_Gui_Toplevel_Closed">Toplevel.Closed</a>
  272. </div>
  273. <div>
  274. <a class="xref" href="Terminal.Gui.Toplevel.html#Terminal_Gui_Toplevel_ChildLoaded">Toplevel.ChildLoaded</a>
  275. </div>
  276. <div>
  277. <a class="xref" href="Terminal.Gui.Toplevel.html#Terminal_Gui_Toplevel_ChildUnloaded">Toplevel.ChildUnloaded</a>
  278. </div>
  279. <div>
  280. <a class="xref" href="Terminal.Gui.Toplevel.html#Terminal_Gui_Toplevel_Resized">Toplevel.Resized</a>
  281. </div>
  282. <div>
  283. <a class="xref" href="Terminal.Gui.Toplevel.html#Terminal_Gui_Toplevel_AlternateForwardKeyChanged">Toplevel.AlternateForwardKeyChanged</a>
  284. </div>
  285. <div>
  286. <a class="xref" href="Terminal.Gui.Toplevel.html#Terminal_Gui_Toplevel_AlternateBackwardKeyChanged">Toplevel.AlternateBackwardKeyChanged</a>
  287. </div>
  288. <div>
  289. <a class="xref" href="Terminal.Gui.Toplevel.html#Terminal_Gui_Toplevel_QuitKeyChanged">Toplevel.QuitKeyChanged</a>
  290. </div>
  291. <div>
  292. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_GetMinWidthHeight_Terminal_Gui_Size__">View.GetMinWidthHeight(Size)</a>
  293. </div>
  294. <div>
  295. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SetMinWidthHeight">View.SetMinWidthHeight()</a>
  296. </div>
  297. <div>
  298. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_UpdateTextFormatterText">View.UpdateTextFormatterText()</a>
  299. </div>
  300. <div>
  301. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ProcessResizeView">View.ProcessResizeView()</a>
  302. </div>
  303. <div>
  304. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SetNeedsDisplay">View.SetNeedsDisplay()</a>
  305. </div>
  306. <div>
  307. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ClearLayoutNeeded">View.ClearLayoutNeeded()</a>
  308. </div>
  309. <div>
  310. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SetNeedsDisplay_Terminal_Gui_Rect_">View.SetNeedsDisplay(Rect)</a>
  311. </div>
  312. <div>
  313. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SetChildNeedsDisplay">View.SetChildNeedsDisplay()</a>
  314. </div>
  315. <div>
  316. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Add_Terminal_Gui_View___">View.Add(View[])</a>
  317. </div>
  318. <div>
  319. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_BringSubviewToFront_Terminal_Gui_View_">View.BringSubviewToFront(View)</a>
  320. </div>
  321. <div>
  322. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SendSubviewToBack_Terminal_Gui_View_">View.SendSubviewToBack(View)</a>
  323. </div>
  324. <div>
  325. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SendSubviewBackwards_Terminal_Gui_View_">View.SendSubviewBackwards(View)</a>
  326. </div>
  327. <div>
  328. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_BringSubviewForward_Terminal_Gui_View_">View.BringSubviewForward(View)</a>
  329. </div>
  330. <div>
  331. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Clear">View.Clear()</a>
  332. </div>
  333. <div>
  334. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Clear_Terminal_Gui_Rect_">View.Clear(Rect)</a>
  335. </div>
  336. <div>
  337. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ScreenToView_System_Int32_System_Int32_">View.ScreenToView(Int32, Int32)</a>
  338. </div>
  339. <div>
  340. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ClipToBounds">View.ClipToBounds()</a>
  341. </div>
  342. <div>
  343. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SetClip_Terminal_Gui_Rect_">View.SetClip(Rect)</a>
  344. </div>
  345. <div>
  346. <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>
  347. </div>
  348. <div>
  349. <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>
  350. </div>
  351. <div>
  352. <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>
  353. </div>
  354. <div>
  355. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Move_System_Int32_System_Int32_System_Boolean_">View.Move(Int32, Int32, Boolean)</a>
  356. </div>
  357. <div>
  358. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnAdded_Terminal_Gui_View_">View.OnAdded(View)</a>
  359. </div>
  360. <div>
  361. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnRemoved_Terminal_Gui_View_">View.OnRemoved(View)</a>
  362. </div>
  363. <div>
  364. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnEnter_Terminal_Gui_View_">View.OnEnter(View)</a>
  365. </div>
  366. <div>
  367. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnLeave_Terminal_Gui_View_">View.OnLeave(View)</a>
  368. </div>
  369. <div>
  370. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_AddRune_System_Int32_System_Int32_System_Rune_">View.AddRune(Int32, Int32, Rune)</a>
  371. </div>
  372. <div>
  373. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ClearNeedsDisplay">View.ClearNeedsDisplay()</a>
  374. </div>
  375. <div>
  376. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnDrawContent_Terminal_Gui_Rect_">View.OnDrawContent(Rect)</a>
  377. </div>
  378. <div>
  379. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnDrawContentComplete_Terminal_Gui_Rect_">View.OnDrawContentComplete(Rect)</a>
  380. </div>
  381. <div>
  382. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SetFocus">View.SetFocus()</a>
  383. </div>
  384. <div>
  385. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_InvokeKeybindings_Terminal_Gui_KeyEvent_">View.InvokeKeybindings(KeyEvent)</a>
  386. </div>
  387. <div>
  388. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_AddKeyBinding_Terminal_Gui_Key_Terminal_Gui_Command_">View.AddKeyBinding(Key, Command)</a>
  389. </div>
  390. <div>
  391. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ReplaceKeyBinding_Terminal_Gui_Key_Terminal_Gui_Key_">View.ReplaceKeyBinding(Key, Key)</a>
  392. </div>
  393. <div>
  394. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ContainsKeyBinding_Terminal_Gui_Key_">View.ContainsKeyBinding(Key)</a>
  395. </div>
  396. <div>
  397. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ClearKeybindings">View.ClearKeybindings()</a>
  398. </div>
  399. <div>
  400. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ClearKeybinding_Terminal_Gui_Key_">View.ClearKeybinding(Key)</a>
  401. </div>
  402. <div>
  403. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ClearKeybinding_Terminal_Gui_Command_">View.ClearKeybinding(Command)</a>
  404. </div>
  405. <div>
  406. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_AddCommand_Terminal_Gui_Command_System_Func_System_Nullable_System_Boolean___">View.AddCommand(Command, Func&lt;Nullable&lt;Boolean&gt;&gt;)</a>
  407. </div>
  408. <div>
  409. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_GetSupportedCommands">View.GetSupportedCommands()</a>
  410. </div>
  411. <div>
  412. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_GetKeyFromCommand_Terminal_Gui_Command_">View.GetKeyFromCommand(Command)</a>
  413. </div>
  414. <div>
  415. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ProcessHotKey_Terminal_Gui_KeyEvent_">View.ProcessHotKey(KeyEvent)</a>
  416. </div>
  417. <div>
  418. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_EnsureFocus">View.EnsureFocus()</a>
  419. </div>
  420. <div>
  421. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_FocusFirst">View.FocusFirst()</a>
  422. </div>
  423. <div>
  424. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_FocusLast">View.FocusLast()</a>
  425. </div>
  426. <div>
  427. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_FocusPrev">View.FocusPrev()</a>
  428. </div>
  429. <div>
  430. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_FocusNext">View.FocusNext()</a>
  431. </div>
  432. <div>
  433. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_LayoutSubviews">View.LayoutSubviews()</a>
  434. </div>
  435. <div>
  436. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ToString">View.ToString()</a>
  437. </div>
  438. <div>
  439. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_GetAutoSize">View.GetAutoSize()</a>
  440. </div>
  441. <div>
  442. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_GetHotKeySpecifierLength_System_Boolean_">View.GetHotKeySpecifierLength(Boolean)</a>
  443. </div>
  444. <div>
  445. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_GetTextFormatterBoundsSize">View.GetTextFormatterBoundsSize()</a>
  446. </div>
  447. <div>
  448. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_GetBoundsTextFormatterSize">View.GetBoundsTextFormatterSize()</a>
  449. </div>
  450. <div>
  451. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnMouseEnter_Terminal_Gui_MouseEvent_">View.OnMouseEnter(MouseEvent)</a>
  452. </div>
  453. <div>
  454. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnMouseLeave_Terminal_Gui_MouseEvent_">View.OnMouseLeave(MouseEvent)</a>
  455. </div>
  456. <div>
  457. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnMouseEvent_Terminal_Gui_MouseEvent_">View.OnMouseEvent(MouseEvent)</a>
  458. </div>
  459. <div>
  460. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnMouseClick_Terminal_Gui_View_MouseEventArgs_">View.OnMouseClick(View.MouseEventArgs)</a>
  461. </div>
  462. <div>
  463. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnEnabledChanged">View.OnEnabledChanged()</a>
  464. </div>
  465. <div>
  466. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnVisibleChanged">View.OnVisibleChanged()</a>
  467. </div>
  468. <div>
  469. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Dispose_System_Boolean_">View.Dispose(Boolean)</a>
  470. </div>
  471. <div>
  472. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_BeginInit">View.BeginInit()</a>
  473. </div>
  474. <div>
  475. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_EndInit">View.EndInit()</a>
  476. </div>
  477. <div>
  478. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SetWidth_System_Int32_System_Int32__">View.SetWidth(Int32, Int32)</a>
  479. </div>
  480. <div>
  481. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SetHeight_System_Int32_System_Int32__">View.SetHeight(Int32, Int32)</a>
  482. </div>
  483. <div>
  484. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_GetCurrentWidth_System_Int32__">View.GetCurrentWidth(Int32)</a>
  485. </div>
  486. <div>
  487. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_GetCurrentHeight_System_Int32__">View.GetCurrentHeight(Int32)</a>
  488. </div>
  489. <div>
  490. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_GetNormalColor">View.GetNormalColor()</a>
  491. </div>
  492. <div>
  493. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_GetTopSuperView">View.GetTopSuperView()</a>
  494. </div>
  495. <div>
  496. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_HotKey">View.HotKey</a>
  497. </div>
  498. <div>
  499. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_HotKeySpecifier">View.HotKeySpecifier</a>
  500. </div>
  501. <div>
  502. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Shortcut">View.Shortcut</a>
  503. </div>
  504. <div>
  505. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ShortcutTag">View.ShortcutTag</a>
  506. </div>
  507. <div>
  508. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ShortcutAction">View.ShortcutAction</a>
  509. </div>
  510. <div>
  511. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Data">View.Data</a>
  512. </div>
  513. <div>
  514. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Driver">View.Driver</a>
  515. </div>
  516. <div>
  517. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Subviews">View.Subviews</a>
  518. </div>
  519. <div>
  520. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_TabIndexes">View.TabIndexes</a>
  521. </div>
  522. <div>
  523. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_TabIndex">View.TabIndex</a>
  524. </div>
  525. <div>
  526. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_TabStop">View.TabStop</a>
  527. </div>
  528. <div>
  529. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Id">View.Id</a>
  530. </div>
  531. <div>
  532. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_IsCurrentTop">View.IsCurrentTop</a>
  533. </div>
  534. <div>
  535. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_WantMousePositionReports">View.WantMousePositionReports</a>
  536. </div>
  537. <div>
  538. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_WantContinuousButtonPressed">View.WantContinuousButtonPressed</a>
  539. </div>
  540. <div>
  541. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Frame">View.Frame</a>
  542. </div>
  543. <div>
  544. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_LayoutStyle">View.LayoutStyle</a>
  545. </div>
  546. <div>
  547. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Bounds">View.Bounds</a>
  548. </div>
  549. <div>
  550. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_X">View.X</a>
  551. </div>
  552. <div>
  553. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Y">View.Y</a>
  554. </div>
  555. <div>
  556. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Width">View.Width</a>
  557. </div>
  558. <div>
  559. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Height">View.Height</a>
  560. </div>
  561. <div>
  562. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ForceValidatePosDim">View.ForceValidatePosDim</a>
  563. </div>
  564. <div>
  565. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_TextFormatter">View.TextFormatter</a>
  566. </div>
  567. <div>
  568. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SuperView">View.SuperView</a>
  569. </div>
  570. <div>
  571. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_HasFocus">View.HasFocus</a>
  572. </div>
  573. <div>
  574. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Focused">View.Focused</a>
  575. </div>
  576. <div>
  577. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_MostFocused">View.MostFocused</a>
  578. </div>
  579. <div>
  580. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ColorScheme">View.ColorScheme</a>
  581. </div>
  582. <div>
  583. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_AutoSize">View.AutoSize</a>
  584. </div>
  585. <div>
  586. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_PreserveTrailingSpaces">View.PreserveTrailingSpaces</a>
  587. </div>
  588. <div>
  589. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_VerticalTextAlignment">View.VerticalTextAlignment</a>
  590. </div>
  591. <div>
  592. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_TextDirection">View.TextDirection</a>
  593. </div>
  594. <div>
  595. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_IsInitialized">View.IsInitialized</a>
  596. </div>
  597. <div>
  598. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_IsAdded">View.IsAdded</a>
  599. </div>
  600. <div>
  601. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Enabled">View.Enabled</a>
  602. </div>
  603. <div>
  604. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Visible">View.Visible</a>
  605. </div>
  606. <div>
  607. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Added">View.Added</a>
  608. </div>
  609. <div>
  610. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Removed">View.Removed</a>
  611. </div>
  612. <div>
  613. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Enter">View.Enter</a>
  614. </div>
  615. <div>
  616. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Leave">View.Leave</a>
  617. </div>
  618. <div>
  619. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_MouseEnter">View.MouseEnter</a>
  620. </div>
  621. <div>
  622. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_MouseLeave">View.MouseLeave</a>
  623. </div>
  624. <div>
  625. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_MouseClick">View.MouseClick</a>
  626. </div>
  627. <div>
  628. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_CanFocusChanged">View.CanFocusChanged</a>
  629. </div>
  630. <div>
  631. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_EnabledChanged">View.EnabledChanged</a>
  632. </div>
  633. <div>
  634. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_VisibleChanged">View.VisibleChanged</a>
  635. </div>
  636. <div>
  637. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_HotKeyChanged">View.HotKeyChanged</a>
  638. </div>
  639. <div>
  640. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_DrawContent">View.DrawContent</a>
  641. </div>
  642. <div>
  643. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_DrawContentComplete">View.DrawContentComplete</a>
  644. </div>
  645. <div>
  646. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_KeyPress">View.KeyPress</a>
  647. </div>
  648. <div>
  649. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_KeyDown">View.KeyDown</a>
  650. </div>
  651. <div>
  652. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_KeyUp">View.KeyUp</a>
  653. </div>
  654. <div>
  655. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_LayoutStarted">View.LayoutStarted</a>
  656. </div>
  657. <div>
  658. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_LayoutComplete">View.LayoutComplete</a>
  659. </div>
  660. <div>
  661. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Initialized">View.Initialized</a>
  662. </div>
  663. <div>
  664. <a class="xref" href="Terminal.Gui.Responder.html#Terminal_Gui_Responder_Dispose">Responder.Dispose()</a>
  665. </div>
  666. </div>
  667. <h6><strong>Namespace</strong>: <a class="xref" href="Terminal.Gui.html">Terminal.Gui</a></h6>
  668. <h6><strong>Assembly</strong>: Terminal.Gui.dll</h6>
  669. <h5 id="Terminal_Gui_Wizard_syntax">Syntax</h5>
  670. <div class="codewrapper">
  671. <pre><code class="lang-csharp hljs">public class Wizard : Dialog</code></pre>
  672. </div>
  673. <h3 id="constructors">Constructors
  674. </h3>
  675. <a id="Terminal_Gui_Wizard__ctor_" data-uid="Terminal.Gui.Wizard.#ctor*"></a>
  676. <h4 id="Terminal_Gui_Wizard__ctor" data-uid="Terminal.Gui.Wizard.#ctor">Wizard()</h4>
  677. <div class="markdown level1 summary">
  678. Initializes a new instance of the <a class="xref" href="Terminal.Gui.Wizard.html">Wizard</a> class using <a class="xref" href="Terminal.Gui.LayoutStyle.html#Terminal_Gui_LayoutStyle_Computed">Computed</a> positioning.
  679. </div>
  680. <div class="markdown level1 conceptual"></div>
  681. <h5 class="decalaration">Declaration</h5>
  682. <div class="codewrapper">
  683. <pre><code class="lang-csharp hljs">public Wizard()</code></pre>
  684. </div>
  685. <a id="Terminal_Gui_Wizard__ctor_" data-uid="Terminal.Gui.Wizard.#ctor*"></a>
  686. <h4 id="Terminal_Gui_Wizard__ctor_NStack_ustring_" data-uid="Terminal.Gui.Wizard.#ctor(NStack.ustring)">Wizard(ustring)</h4>
  687. <div class="markdown level1 summary">
  688. Initializes a new instance of the <a class="xref" href="Terminal.Gui.Wizard.html">Wizard</a> class using <a class="xref" href="Terminal.Gui.LayoutStyle.html#Terminal_Gui_LayoutStyle_Computed">Computed</a> positioning.
  689. </div>
  690. <div class="markdown level1 conceptual"></div>
  691. <h5 class="decalaration">Declaration</h5>
  692. <div class="codewrapper">
  693. <pre><code class="lang-csharp hljs">public Wizard(ustring title)</code></pre>
  694. </div>
  695. <h5 class="parameters">Parameters</h5>
  696. <table class="table table-bordered table-striped table-condensed">
  697. <thead>
  698. <tr>
  699. <th>Type</th>
  700. <th>Name</th>
  701. <th>Description</th>
  702. </tr>
  703. </thead>
  704. <tbody>
  705. <tr>
  706. <td><span class="xref">NStack.ustring</span></td>
  707. <td><span class="parametername">title</span></td>
  708. <td>Sets the <a class="xref" href="Terminal.Gui.Wizard.html#Terminal_Gui_Wizard_Title">Title</a> for the Wizard.</td>
  709. </tr>
  710. </tbody>
  711. </table>
  712. <h3 id="properties">Properties
  713. </h3>
  714. <a id="Terminal_Gui_Wizard_BackButton_" data-uid="Terminal.Gui.Wizard.BackButton*"></a>
  715. <h4 id="Terminal_Gui_Wizard_BackButton" data-uid="Terminal.Gui.Wizard.BackButton">BackButton</h4>
  716. <div class="markdown level1 summary">
  717. If the <a class="xref" href="Terminal.Gui.Wizard.html#Terminal_Gui_Wizard_CurrentStep">CurrentStep</a> is not the first step in the wizard, this button causes
  718. the <a class="xref" href="Terminal.Gui.Wizard.html#Terminal_Gui_Wizard_MovingBack">MovingBack</a> event to be fired and the wizard moves to the previous step.
  719. </div>
  720. <div class="markdown level1 conceptual"></div>
  721. <h5 class="decalaration">Declaration</h5>
  722. <div class="codewrapper">
  723. <pre><code class="lang-csharp hljs">public Button BackButton { get; }</code></pre>
  724. </div>
  725. <h5 class="propertyValue">Property Value</h5>
  726. <table class="table table-bordered table-striped table-condensed">
  727. <thead>
  728. <tr>
  729. <th>Type</th>
  730. <th>Description</th>
  731. </tr>
  732. </thead>
  733. <tbody>
  734. <tr>
  735. <td><a class="xref" href="Terminal.Gui.Button.html">Button</a></td>
  736. <td></td>
  737. </tr>
  738. </tbody>
  739. </table>
  740. <a id="Terminal_Gui_Wizard_CurrentStep_" data-uid="Terminal.Gui.Wizard.CurrentStep*"></a>
  741. <h4 id="Terminal_Gui_Wizard_CurrentStep" data-uid="Terminal.Gui.Wizard.CurrentStep">CurrentStep</h4>
  742. <div class="markdown level1 summary">
  743. Gets or sets the currently active <a class="xref" href="Terminal.Gui.Wizard.WizardStep.html">Wizard.WizardStep</a>.
  744. </div>
  745. <div class="markdown level1 conceptual"></div>
  746. <h5 class="decalaration">Declaration</h5>
  747. <div class="codewrapper">
  748. <pre><code class="lang-csharp hljs">public Wizard.WizardStep CurrentStep { get; set; }</code></pre>
  749. </div>
  750. <h5 class="propertyValue">Property Value</h5>
  751. <table class="table table-bordered table-striped table-condensed">
  752. <thead>
  753. <tr>
  754. <th>Type</th>
  755. <th>Description</th>
  756. </tr>
  757. </thead>
  758. <tbody>
  759. <tr>
  760. <td><a class="xref" href="Terminal.Gui.Wizard.WizardStep.html">Wizard.WizardStep</a></td>
  761. <td></td>
  762. </tr>
  763. </tbody>
  764. </table>
  765. <a id="Terminal_Gui_Wizard_Modal_" data-uid="Terminal.Gui.Wizard.Modal*"></a>
  766. <h4 id="Terminal_Gui_Wizard_Modal" data-uid="Terminal.Gui.Wizard.Modal">Modal</h4>
  767. <div class="markdown level1 summary">
  768. Determines whether the <a class="xref" href="Terminal.Gui.Wizard.html">Wizard</a> is displayed as modal pop-up or not.
  769. The default is <code>true</code>. The Wizard will be shown with a frame with <a class="xref" href="Terminal.Gui.Wizard.html#Terminal_Gui_Wizard_Title">Title</a> and will behave like
  770. any <a class="xref" href="Terminal.Gui.Toplevel.html">Toplevel</a> window.
  771. If set to <code>false</code> the Wizard will have no frame and will behave like any embedded <a class="xref" href="Terminal.Gui.View.html">View</a>.
  772. To use Wizard as an embedded View
  773. <ol><li>Set <a class="xref" href="Terminal.Gui.Wizard.html#Terminal_Gui_Wizard_Modal">Modal</a> to <code>false</code>.</li><li>Add the Wizard to a containing view with <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Add_Terminal_Gui_View_">Add(View)</a>.</li></ol>
  774. If a non-Modal Wizard is added to the application after <a class="xref" href="Terminal.Gui.Application.html#Terminal_Gui_Application_Run_System_Func_System_Exception_System_Boolean__">Run(Func&lt;Exception, Boolean&gt;)</a> has been called
  775. the first step must be explicitly set by setting <a class="xref" href="Terminal.Gui.Wizard.html#Terminal_Gui_Wizard_CurrentStep">CurrentStep</a> to <a class="xref" href="Terminal.Gui.Wizard.html#Terminal_Gui_Wizard_GetNextStep">GetNextStep()</a>:
  776. <pre><code> wizard.CurrentStep = wizard.GetNextStep();</code></pre>
  777. </div>
  778. <div class="markdown level1 conceptual"></div>
  779. <h5 class="decalaration">Declaration</h5>
  780. <div class="codewrapper">
  781. <pre><code class="lang-csharp hljs">public bool Modal { get; set; }</code></pre>
  782. </div>
  783. <h5 class="propertyValue">Property Value</h5>
  784. <table class="table table-bordered table-striped table-condensed">
  785. <thead>
  786. <tr>
  787. <th>Type</th>
  788. <th>Description</th>
  789. </tr>
  790. </thead>
  791. <tbody>
  792. <tr>
  793. <td><span class="xref">System.Boolean</span></td>
  794. <td></td>
  795. </tr>
  796. </tbody>
  797. </table>
  798. <a id="Terminal_Gui_Wizard_NextFinishButton_" data-uid="Terminal.Gui.Wizard.NextFinishButton*"></a>
  799. <h4 id="Terminal_Gui_Wizard_NextFinishButton" data-uid="Terminal.Gui.Wizard.NextFinishButton">NextFinishButton</h4>
  800. <div class="markdown level1 summary">
  801. If the <a class="xref" href="Terminal.Gui.Wizard.html#Terminal_Gui_Wizard_CurrentStep">CurrentStep</a> is the last step in the wizard, this button causes
  802. the <a class="xref" href="Terminal.Gui.Wizard.html#Terminal_Gui_Wizard_Finished">Finished</a> event to be fired and the wizard to close. If the step is not the last step,
  803. the <a class="xref" href="Terminal.Gui.Wizard.html#Terminal_Gui_Wizard_MovingNext">MovingNext</a> event will be fired and the wizard will move next step.
  804. </div>
  805. <div class="markdown level1 conceptual"></div>
  806. <h5 class="decalaration">Declaration</h5>
  807. <div class="codewrapper">
  808. <pre><code class="lang-csharp hljs">public Button NextFinishButton { get; }</code></pre>
  809. </div>
  810. <h5 class="propertyValue">Property Value</h5>
  811. <table class="table table-bordered table-striped table-condensed">
  812. <thead>
  813. <tr>
  814. <th>Type</th>
  815. <th>Description</th>
  816. </tr>
  817. </thead>
  818. <tbody>
  819. <tr>
  820. <td><a class="xref" href="Terminal.Gui.Button.html">Button</a></td>
  821. <td></td>
  822. </tr>
  823. </tbody>
  824. </table>
  825. <a id="Terminal_Gui_Wizard_Title_" data-uid="Terminal.Gui.Wizard.Title*"></a>
  826. <h4 id="Terminal_Gui_Wizard_Title" data-uid="Terminal.Gui.Wizard.Title">Title</h4>
  827. <div class="markdown level1 summary">
  828. The title of the Wizard, shown at the top of the Wizard with &quot; - currentStep.Title&quot; appended.
  829. </div>
  830. <div class="markdown level1 conceptual"></div>
  831. <h5 class="decalaration">Declaration</h5>
  832. <div class="codewrapper">
  833. <pre><code class="lang-csharp hljs">public ustring Title { get; set; }</code></pre>
  834. </div>
  835. <h5 class="propertyValue">Property Value</h5>
  836. <table class="table table-bordered table-striped table-condensed">
  837. <thead>
  838. <tr>
  839. <th>Type</th>
  840. <th>Description</th>
  841. </tr>
  842. </thead>
  843. <tbody>
  844. <tr>
  845. <td><span class="xref">NStack.ustring</span></td>
  846. <td></td>
  847. </tr>
  848. </tbody>
  849. </table>
  850. <h3 id="methods">Methods
  851. </h3>
  852. <a id="Terminal_Gui_Wizard_AddStep_" data-uid="Terminal.Gui.Wizard.AddStep*"></a>
  853. <h4 id="Terminal_Gui_Wizard_AddStep_Terminal_Gui_Wizard_WizardStep_" data-uid="Terminal.Gui.Wizard.AddStep(Terminal.Gui.Wizard.WizardStep)">AddStep(Wizard.WizardStep)</h4>
  854. <div class="markdown level1 summary">
  855. Adds a step to the wizard. The Next and Back buttons navigate through the added steps in the
  856. order they were added.
  857. </div>
  858. <div class="markdown level1 conceptual"></div>
  859. <h5 class="decalaration">Declaration</h5>
  860. <div class="codewrapper">
  861. <pre><code class="lang-csharp hljs">public void AddStep(Wizard.WizardStep newStep)</code></pre>
  862. </div>
  863. <h5 class="parameters">Parameters</h5>
  864. <table class="table table-bordered table-striped table-condensed">
  865. <thead>
  866. <tr>
  867. <th>Type</th>
  868. <th>Name</th>
  869. <th>Description</th>
  870. </tr>
  871. </thead>
  872. <tbody>
  873. <tr>
  874. <td><a class="xref" href="Terminal.Gui.Wizard.WizardStep.html">Wizard.WizardStep</a></td>
  875. <td><span class="parametername">newStep</span></td>
  876. <td></td>
  877. </tr>
  878. </tbody>
  879. </table>
  880. <a id="Terminal_Gui_Wizard_GetFirstStep_" data-uid="Terminal.Gui.Wizard.GetFirstStep*"></a>
  881. <h4 id="Terminal_Gui_Wizard_GetFirstStep" data-uid="Terminal.Gui.Wizard.GetFirstStep">GetFirstStep()</h4>
  882. <div class="markdown level1 summary">
  883. Returns the first enabled step in the Wizard
  884. </div>
  885. <div class="markdown level1 conceptual"></div>
  886. <h5 class="decalaration">Declaration</h5>
  887. <div class="codewrapper">
  888. <pre><code class="lang-csharp hljs">public Wizard.WizardStep GetFirstStep()</code></pre>
  889. </div>
  890. <h5 class="returns">Returns</h5>
  891. <table class="table table-bordered table-striped table-condensed">
  892. <thead>
  893. <tr>
  894. <th>Type</th>
  895. <th>Description</th>
  896. </tr>
  897. </thead>
  898. <tbody>
  899. <tr>
  900. <td><a class="xref" href="Terminal.Gui.Wizard.WizardStep.html">Wizard.WizardStep</a></td>
  901. <td>The last enabled step</td>
  902. </tr>
  903. </tbody>
  904. </table>
  905. <a id="Terminal_Gui_Wizard_GetLastStep_" data-uid="Terminal.Gui.Wizard.GetLastStep*"></a>
  906. <h4 id="Terminal_Gui_Wizard_GetLastStep" data-uid="Terminal.Gui.Wizard.GetLastStep">GetLastStep()</h4>
  907. <div class="markdown level1 summary">
  908. Returns the last enabled step in the Wizard
  909. </div>
  910. <div class="markdown level1 conceptual"></div>
  911. <h5 class="decalaration">Declaration</h5>
  912. <div class="codewrapper">
  913. <pre><code class="lang-csharp hljs">public Wizard.WizardStep GetLastStep()</code></pre>
  914. </div>
  915. <h5 class="returns">Returns</h5>
  916. <table class="table table-bordered table-striped table-condensed">
  917. <thead>
  918. <tr>
  919. <th>Type</th>
  920. <th>Description</th>
  921. </tr>
  922. </thead>
  923. <tbody>
  924. <tr>
  925. <td><a class="xref" href="Terminal.Gui.Wizard.WizardStep.html">Wizard.WizardStep</a></td>
  926. <td>The last enabled step</td>
  927. </tr>
  928. </tbody>
  929. </table>
  930. <a id="Terminal_Gui_Wizard_GetNextStep_" data-uid="Terminal.Gui.Wizard.GetNextStep*"></a>
  931. <h4 id="Terminal_Gui_Wizard_GetNextStep" data-uid="Terminal.Gui.Wizard.GetNextStep">GetNextStep()</h4>
  932. <div class="markdown level1 summary">
  933. Returns the next enabled <a class="xref" href="Terminal.Gui.Wizard.WizardStep.html">Wizard.WizardStep</a> after the current step. Takes into account steps which
  934. are disabled. If <a class="xref" href="Terminal.Gui.Wizard.html#Terminal_Gui_Wizard_CurrentStep">CurrentStep</a> is <code>null</code> returns the first enabled step.
  935. </div>
  936. <div class="markdown level1 conceptual"></div>
  937. <h5 class="decalaration">Declaration</h5>
  938. <div class="codewrapper">
  939. <pre><code class="lang-csharp hljs">public Wizard.WizardStep GetNextStep()</code></pre>
  940. </div>
  941. <h5 class="returns">Returns</h5>
  942. <table class="table table-bordered table-striped table-condensed">
  943. <thead>
  944. <tr>
  945. <th>Type</th>
  946. <th>Description</th>
  947. </tr>
  948. </thead>
  949. <tbody>
  950. <tr>
  951. <td><a class="xref" href="Terminal.Gui.Wizard.WizardStep.html">Wizard.WizardStep</a></td>
  952. <td>The next step after the current step, if there is one; otherwise returns <code>null</code>, which
  953. indicates either there are no enabled steps or the current step is the last enabled step.</td>
  954. </tr>
  955. </tbody>
  956. </table>
  957. <a id="Terminal_Gui_Wizard_GetPreviousStep_" data-uid="Terminal.Gui.Wizard.GetPreviousStep*"></a>
  958. <h4 id="Terminal_Gui_Wizard_GetPreviousStep" data-uid="Terminal.Gui.Wizard.GetPreviousStep">GetPreviousStep()</h4>
  959. <div class="markdown level1 summary">
  960. Returns the first enabled <a class="xref" href="Terminal.Gui.Wizard.WizardStep.html">Wizard.WizardStep</a> before the current step. Takes into account steps which
  961. are disabled. If <a class="xref" href="Terminal.Gui.Wizard.html#Terminal_Gui_Wizard_CurrentStep">CurrentStep</a> is <code>null</code> returns the last enabled step.
  962. </div>
  963. <div class="markdown level1 conceptual"></div>
  964. <h5 class="decalaration">Declaration</h5>
  965. <div class="codewrapper">
  966. <pre><code class="lang-csharp hljs">public Wizard.WizardStep GetPreviousStep()</code></pre>
  967. </div>
  968. <h5 class="returns">Returns</h5>
  969. <table class="table table-bordered table-striped table-condensed">
  970. <thead>
  971. <tr>
  972. <th>Type</th>
  973. <th>Description</th>
  974. </tr>
  975. </thead>
  976. <tbody>
  977. <tr>
  978. <td><a class="xref" href="Terminal.Gui.Wizard.WizardStep.html">Wizard.WizardStep</a></td>
  979. <td>The first step ahead of the current step, if there is one; otherwise returns <code>null</code>, which
  980. indicates either there are no enabled steps or the current step is the first enabled step.</td>
  981. </tr>
  982. </tbody>
  983. </table>
  984. <a id="Terminal_Gui_Wizard_GoBack_" data-uid="Terminal.Gui.Wizard.GoBack*"></a>
  985. <h4 id="Terminal_Gui_Wizard_GoBack" data-uid="Terminal.Gui.Wizard.GoBack">GoBack()</h4>
  986. <div class="markdown level1 summary">
  987. Causes the wizad to move to the previous enabled step (or first step if <a class="xref" href="Terminal.Gui.Wizard.html#Terminal_Gui_Wizard_CurrentStep">CurrentStep</a> is not set).
  988. If there is no previous step, does nothing.
  989. </div>
  990. <div class="markdown level1 conceptual"></div>
  991. <h5 class="decalaration">Declaration</h5>
  992. <div class="codewrapper">
  993. <pre><code class="lang-csharp hljs">public void GoBack()</code></pre>
  994. </div>
  995. <a id="Terminal_Gui_Wizard_GoNext_" data-uid="Terminal.Gui.Wizard.GoNext*"></a>
  996. <h4 id="Terminal_Gui_Wizard_GoNext" data-uid="Terminal.Gui.Wizard.GoNext">GoNext()</h4>
  997. <div class="markdown level1 summary">
  998. Causes the wizad to move to the next enabled step (or last step if <a class="xref" href="Terminal.Gui.Wizard.html#Terminal_Gui_Wizard_CurrentStep">CurrentStep</a> is not set).
  999. If there is no previous step, does nothing.
  1000. </div>
  1001. <div class="markdown level1 conceptual"></div>
  1002. <h5 class="decalaration">Declaration</h5>
  1003. <div class="codewrapper">
  1004. <pre><code class="lang-csharp hljs">public void GoNext()</code></pre>
  1005. </div>
  1006. <a id="Terminal_Gui_Wizard_GoToStep_" data-uid="Terminal.Gui.Wizard.GoToStep*"></a>
  1007. <h4 id="Terminal_Gui_Wizard_GoToStep_Terminal_Gui_Wizard_WizardStep_" data-uid="Terminal.Gui.Wizard.GoToStep(Terminal.Gui.Wizard.WizardStep)">GoToStep(Wizard.WizardStep)</h4>
  1008. <div class="markdown level1 summary">
  1009. Changes to the specified <a class="xref" href="Terminal.Gui.Wizard.WizardStep.html">Wizard.WizardStep</a>.
  1010. </div>
  1011. <div class="markdown level1 conceptual"></div>
  1012. <h5 class="decalaration">Declaration</h5>
  1013. <div class="codewrapper">
  1014. <pre><code class="lang-csharp hljs">public bool GoToStep(Wizard.WizardStep newStep)</code></pre>
  1015. </div>
  1016. <h5 class="parameters">Parameters</h5>
  1017. <table class="table table-bordered table-striped table-condensed">
  1018. <thead>
  1019. <tr>
  1020. <th>Type</th>
  1021. <th>Name</th>
  1022. <th>Description</th>
  1023. </tr>
  1024. </thead>
  1025. <tbody>
  1026. <tr>
  1027. <td><a class="xref" href="Terminal.Gui.Wizard.WizardStep.html">Wizard.WizardStep</a></td>
  1028. <td><span class="parametername">newStep</span></td>
  1029. <td>The step to go to.</td>
  1030. </tr>
  1031. </tbody>
  1032. </table>
  1033. <h5 class="returns">Returns</h5>
  1034. <table class="table table-bordered table-striped table-condensed">
  1035. <thead>
  1036. <tr>
  1037. <th>Type</th>
  1038. <th>Description</th>
  1039. </tr>
  1040. </thead>
  1041. <tbody>
  1042. <tr>
  1043. <td><span class="xref">System.Boolean</span></td>
  1044. <td>True if the transition to the step succeeded. False if the step was not found or the operation was cancelled.</td>
  1045. </tr>
  1046. </tbody>
  1047. </table>
  1048. <a id="Terminal_Gui_Wizard_OnStepChanged_" data-uid="Terminal.Gui.Wizard.OnStepChanged*"></a>
  1049. <h4 id="Terminal_Gui_Wizard_OnStepChanged_Terminal_Gui_Wizard_WizardStep_Terminal_Gui_Wizard_WizardStep_" data-uid="Terminal.Gui.Wizard.OnStepChanged(Terminal.Gui.Wizard.WizardStep,Terminal.Gui.Wizard.WizardStep)">OnStepChanged(Wizard.WizardStep, Wizard.WizardStep)</h4>
  1050. <div class="markdown level1 summary">
  1051. Called when the <a class="xref" href="Terminal.Gui.Wizard.html">Wizard</a> has completed transition to a new <a class="xref" href="Terminal.Gui.Wizard.WizardStep.html">Wizard.WizardStep</a>. Fires the <a class="xref" href="Terminal.Gui.Wizard.html#Terminal_Gui_Wizard_StepChanged">StepChanged</a> event.
  1052. </div>
  1053. <div class="markdown level1 conceptual"></div>
  1054. <h5 class="decalaration">Declaration</h5>
  1055. <div class="codewrapper">
  1056. <pre><code class="lang-csharp hljs">public virtual bool OnStepChanged(Wizard.WizardStep oldStep, Wizard.WizardStep newStep)</code></pre>
  1057. </div>
  1058. <h5 class="parameters">Parameters</h5>
  1059. <table class="table table-bordered table-striped table-condensed">
  1060. <thead>
  1061. <tr>
  1062. <th>Type</th>
  1063. <th>Name</th>
  1064. <th>Description</th>
  1065. </tr>
  1066. </thead>
  1067. <tbody>
  1068. <tr>
  1069. <td><a class="xref" href="Terminal.Gui.Wizard.WizardStep.html">Wizard.WizardStep</a></td>
  1070. <td><span class="parametername">oldStep</span></td>
  1071. <td>The step the Wizard changed from</td>
  1072. </tr>
  1073. <tr>
  1074. <td><a class="xref" href="Terminal.Gui.Wizard.WizardStep.html">Wizard.WizardStep</a></td>
  1075. <td><span class="parametername">newStep</span></td>
  1076. <td>The step the Wizard has changed to</td>
  1077. </tr>
  1078. </tbody>
  1079. </table>
  1080. <h5 class="returns">Returns</h5>
  1081. <table class="table table-bordered table-striped table-condensed">
  1082. <thead>
  1083. <tr>
  1084. <th>Type</th>
  1085. <th>Description</th>
  1086. </tr>
  1087. </thead>
  1088. <tbody>
  1089. <tr>
  1090. <td><span class="xref">System.Boolean</span></td>
  1091. <td>True if the change is to be cancelled.</td>
  1092. </tr>
  1093. </tbody>
  1094. </table>
  1095. <a id="Terminal_Gui_Wizard_OnStepChanging_" data-uid="Terminal.Gui.Wizard.OnStepChanging*"></a>
  1096. <h4 id="Terminal_Gui_Wizard_OnStepChanging_Terminal_Gui_Wizard_WizardStep_Terminal_Gui_Wizard_WizardStep_" data-uid="Terminal.Gui.Wizard.OnStepChanging(Terminal.Gui.Wizard.WizardStep,Terminal.Gui.Wizard.WizardStep)">OnStepChanging(Wizard.WizardStep, Wizard.WizardStep)</h4>
  1097. <div class="markdown level1 summary">
  1098. Called when the <a class="xref" href="Terminal.Gui.Wizard.html">Wizard</a> is about to transition to another <a class="xref" href="Terminal.Gui.Wizard.WizardStep.html">Wizard.WizardStep</a>. Fires the <a class="xref" href="Terminal.Gui.Wizard.html#Terminal_Gui_Wizard_StepChanging">StepChanging</a> event.
  1099. </div>
  1100. <div class="markdown level1 conceptual"></div>
  1101. <h5 class="decalaration">Declaration</h5>
  1102. <div class="codewrapper">
  1103. <pre><code class="lang-csharp hljs">public virtual bool OnStepChanging(Wizard.WizardStep oldStep, Wizard.WizardStep newStep)</code></pre>
  1104. </div>
  1105. <h5 class="parameters">Parameters</h5>
  1106. <table class="table table-bordered table-striped table-condensed">
  1107. <thead>
  1108. <tr>
  1109. <th>Type</th>
  1110. <th>Name</th>
  1111. <th>Description</th>
  1112. </tr>
  1113. </thead>
  1114. <tbody>
  1115. <tr>
  1116. <td><a class="xref" href="Terminal.Gui.Wizard.WizardStep.html">Wizard.WizardStep</a></td>
  1117. <td><span class="parametername">oldStep</span></td>
  1118. <td>The step the Wizard is about to change from</td>
  1119. </tr>
  1120. <tr>
  1121. <td><a class="xref" href="Terminal.Gui.Wizard.WizardStep.html">Wizard.WizardStep</a></td>
  1122. <td><span class="parametername">newStep</span></td>
  1123. <td>The step the Wizard is about to change to</td>
  1124. </tr>
  1125. </tbody>
  1126. </table>
  1127. <h5 class="returns">Returns</h5>
  1128. <table class="table table-bordered table-striped table-condensed">
  1129. <thead>
  1130. <tr>
  1131. <th>Type</th>
  1132. <th>Description</th>
  1133. </tr>
  1134. </thead>
  1135. <tbody>
  1136. <tr>
  1137. <td><span class="xref">System.Boolean</span></td>
  1138. <td>True if the change is to be cancelled.</td>
  1139. </tr>
  1140. </tbody>
  1141. </table>
  1142. <a id="Terminal_Gui_Wizard_ProcessKey_" data-uid="Terminal.Gui.Wizard.ProcessKey*"></a>
  1143. <h4 id="Terminal_Gui_Wizard_ProcessKey_Terminal_Gui_KeyEvent_" data-uid="Terminal.Gui.Wizard.ProcessKey(Terminal.Gui.KeyEvent)">ProcessKey(KeyEvent)</h4>
  1144. <div class="markdown level1 summary">
  1145. <a class="xref" href="Terminal.Gui.Wizard.html">Wizard</a> is derived from <a class="xref" href="Terminal.Gui.Dialog.html">Dialog</a> and Dialog causes <code>Esc</code> to call
  1146. <a class="xref" href="Terminal.Gui.Application.html#Terminal_Gui_Application_RequestStop_Terminal_Gui_Toplevel_">RequestStop(Toplevel)</a>, closing the Dialog. Wizard overrides <a class="xref" href="Terminal.Gui.Responder.html#Terminal_Gui_Responder_ProcessKey_Terminal_Gui_KeyEvent_">ProcessKey(KeyEvent)</a>
  1147. to instead fire the <a class="xref" href="Terminal.Gui.Wizard.html#Terminal_Gui_Wizard_Cancelled">Cancelled</a> event when Wizard is being used as a non-modal (see <a class="xref" href="Terminal.Gui.Wizard.html#Terminal_Gui_Wizard_Modal">Modal</a>.
  1148. See <a class="xref" href="Terminal.Gui.Responder.html#Terminal_Gui_Responder_ProcessKey_Terminal_Gui_KeyEvent_">ProcessKey(KeyEvent)</a> for more.
  1149. </div>
  1150. <div class="markdown level1 conceptual"></div>
  1151. <h5 class="decalaration">Declaration</h5>
  1152. <div class="codewrapper">
  1153. <pre><code class="lang-csharp hljs">public override bool ProcessKey(KeyEvent kb)</code></pre>
  1154. </div>
  1155. <h5 class="parameters">Parameters</h5>
  1156. <table class="table table-bordered table-striped table-condensed">
  1157. <thead>
  1158. <tr>
  1159. <th>Type</th>
  1160. <th>Name</th>
  1161. <th>Description</th>
  1162. </tr>
  1163. </thead>
  1164. <tbody>
  1165. <tr>
  1166. <td><a class="xref" href="Terminal.Gui.KeyEvent.html">KeyEvent</a></td>
  1167. <td><span class="parametername">kb</span></td>
  1168. <td></td>
  1169. </tr>
  1170. </tbody>
  1171. </table>
  1172. <h5 class="returns">Returns</h5>
  1173. <table class="table table-bordered table-striped table-condensed">
  1174. <thead>
  1175. <tr>
  1176. <th>Type</th>
  1177. <th>Description</th>
  1178. </tr>
  1179. </thead>
  1180. <tbody>
  1181. <tr>
  1182. <td><span class="xref">System.Boolean</span></td>
  1183. <td></td>
  1184. </tr>
  1185. </tbody>
  1186. </table>
  1187. <h5 class="overrides">Overrides</h5>
  1188. <div><a class="xref" href="Terminal.Gui.Dialog.html#Terminal_Gui_Dialog_ProcessKey_Terminal_Gui_KeyEvent_">Dialog.ProcessKey(KeyEvent)</a></div>
  1189. <h3 id="events">Events
  1190. </h3>
  1191. <h4 id="Terminal_Gui_Wizard_Cancelled" data-uid="Terminal.Gui.Wizard.Cancelled">Cancelled</h4>
  1192. <div class="markdown level1 summary">
  1193. Raised when the user has cancelled the <a class="xref" href="Terminal.Gui.Wizard.html">Wizard</a> by pressin the Esc key.
  1194. To prevent a modal (<a class="xref" href="Terminal.Gui.Wizard.html#Terminal_Gui_Wizard_Modal">Modal</a> is <code>true</code>) Wizard from
  1195. closing, cancel the event by setting <a class="xref" href="Terminal.Gui.Wizard.WizardButtonEventArgs.html#Terminal_Gui_Wizard_WizardButtonEventArgs_Cancel">Cancel</a> to
  1196. <code>true</code> before returning from the event handler.
  1197. </div>
  1198. <div class="markdown level1 conceptual"></div>
  1199. <h5 class="decalaration">Declaration</h5>
  1200. <div class="codewrapper">
  1201. <pre><code class="lang-csharp hljs">public event Action&lt;Wizard.WizardButtonEventArgs&gt; Cancelled</code></pre>
  1202. </div>
  1203. <h5 class="eventType">Event Type</h5>
  1204. <table class="table table-bordered table-striped table-condensed">
  1205. <thead>
  1206. <tr>
  1207. <th>Type</th>
  1208. <th>Description</th>
  1209. </tr>
  1210. </thead>
  1211. <tbody>
  1212. <tr>
  1213. <td><span class="xref">System.Action</span>&lt;<a class="xref" href="Terminal.Gui.Wizard.WizardButtonEventArgs.html">Wizard.WizardButtonEventArgs</a>&gt;</td>
  1214. <td></td>
  1215. </tr>
  1216. </tbody>
  1217. </table>
  1218. <h4 id="Terminal_Gui_Wizard_Finished" data-uid="Terminal.Gui.Wizard.Finished">Finished</h4>
  1219. <div class="markdown level1 summary">
  1220. Raised when the Next/Finish button in the <a class="xref" href="Terminal.Gui.Wizard.html">Wizard</a> is clicked. The Next/Finish button is always
  1221. the last button in the array of Buttons passed to the <a class="xref" href="Terminal.Gui.Wizard.html">Wizard</a> constructor, if any. This event is only
  1222. raised if the <a class="xref" href="Terminal.Gui.Wizard.html#Terminal_Gui_Wizard_CurrentStep">CurrentStep</a> is the last Step in the Wizard flow
  1223. (otherwise the <a class="xref" href="Terminal.Gui.Wizard.html#Terminal_Gui_Wizard_Finished">Finished</a> event is raised).
  1224. </div>
  1225. <div class="markdown level1 conceptual"></div>
  1226. <h5 class="decalaration">Declaration</h5>
  1227. <div class="codewrapper">
  1228. <pre><code class="lang-csharp hljs">public event Action&lt;Wizard.WizardButtonEventArgs&gt; Finished</code></pre>
  1229. </div>
  1230. <h5 class="eventType">Event Type</h5>
  1231. <table class="table table-bordered table-striped table-condensed">
  1232. <thead>
  1233. <tr>
  1234. <th>Type</th>
  1235. <th>Description</th>
  1236. </tr>
  1237. </thead>
  1238. <tbody>
  1239. <tr>
  1240. <td><span class="xref">System.Action</span>&lt;<a class="xref" href="Terminal.Gui.Wizard.WizardButtonEventArgs.html">Wizard.WizardButtonEventArgs</a>&gt;</td>
  1241. <td></td>
  1242. </tr>
  1243. </tbody>
  1244. </table>
  1245. <h4 id="Terminal_Gui_Wizard_MovingBack" data-uid="Terminal.Gui.Wizard.MovingBack">MovingBack</h4>
  1246. <div class="markdown level1 summary">
  1247. Raised when the Back button in the <a class="xref" href="Terminal.Gui.Wizard.html">Wizard</a> is clicked. The Back button is always
  1248. the first button in the array of Buttons passed to the <a class="xref" href="Terminal.Gui.Wizard.html">Wizard</a> constructor, if any.
  1249. </div>
  1250. <div class="markdown level1 conceptual"></div>
  1251. <h5 class="decalaration">Declaration</h5>
  1252. <div class="codewrapper">
  1253. <pre><code class="lang-csharp hljs">public event Action&lt;Wizard.WizardButtonEventArgs&gt; MovingBack</code></pre>
  1254. </div>
  1255. <h5 class="eventType">Event Type</h5>
  1256. <table class="table table-bordered table-striped table-condensed">
  1257. <thead>
  1258. <tr>
  1259. <th>Type</th>
  1260. <th>Description</th>
  1261. </tr>
  1262. </thead>
  1263. <tbody>
  1264. <tr>
  1265. <td><span class="xref">System.Action</span>&lt;<a class="xref" href="Terminal.Gui.Wizard.WizardButtonEventArgs.html">Wizard.WizardButtonEventArgs</a>&gt;</td>
  1266. <td></td>
  1267. </tr>
  1268. </tbody>
  1269. </table>
  1270. <h4 id="Terminal_Gui_Wizard_MovingNext" data-uid="Terminal.Gui.Wizard.MovingNext">MovingNext</h4>
  1271. <div class="markdown level1 summary">
  1272. Raised when the Next/Finish button in the <a class="xref" href="Terminal.Gui.Wizard.html">Wizard</a> is clicked (or the user presses Enter).
  1273. The Next/Finish button is always the last button in the array of Buttons passed to the <a class="xref" href="Terminal.Gui.Wizard.html">Wizard</a> constructor,
  1274. if any. This event is only raised if the <a class="xref" href="Terminal.Gui.Wizard.html#Terminal_Gui_Wizard_CurrentStep">CurrentStep</a> is the last Step in the Wizard flow
  1275. (otherwise the <a class="xref" href="Terminal.Gui.Wizard.html#Terminal_Gui_Wizard_Finished">Finished</a> event is raised).
  1276. </div>
  1277. <div class="markdown level1 conceptual"></div>
  1278. <h5 class="decalaration">Declaration</h5>
  1279. <div class="codewrapper">
  1280. <pre><code class="lang-csharp hljs">public event Action&lt;Wizard.WizardButtonEventArgs&gt; MovingNext</code></pre>
  1281. </div>
  1282. <h5 class="eventType">Event Type</h5>
  1283. <table class="table table-bordered table-striped table-condensed">
  1284. <thead>
  1285. <tr>
  1286. <th>Type</th>
  1287. <th>Description</th>
  1288. </tr>
  1289. </thead>
  1290. <tbody>
  1291. <tr>
  1292. <td><span class="xref">System.Action</span>&lt;<a class="xref" href="Terminal.Gui.Wizard.WizardButtonEventArgs.html">Wizard.WizardButtonEventArgs</a>&gt;</td>
  1293. <td></td>
  1294. </tr>
  1295. </tbody>
  1296. </table>
  1297. <h4 id="Terminal_Gui_Wizard_StepChanged" data-uid="Terminal.Gui.Wizard.StepChanged">StepChanged</h4>
  1298. <div class="markdown level1 summary">
  1299. This event is raised after the <a class="xref" href="Terminal.Gui.Wizard.html">Wizard</a> has changed the <a class="xref" href="Terminal.Gui.Wizard.html#Terminal_Gui_Wizard_CurrentStep">CurrentStep</a>.
  1300. </div>
  1301. <div class="markdown level1 conceptual"></div>
  1302. <h5 class="decalaration">Declaration</h5>
  1303. <div class="codewrapper">
  1304. <pre><code class="lang-csharp hljs">public event Action&lt;Wizard.StepChangeEventArgs&gt; StepChanged</code></pre>
  1305. </div>
  1306. <h5 class="eventType">Event Type</h5>
  1307. <table class="table table-bordered table-striped table-condensed">
  1308. <thead>
  1309. <tr>
  1310. <th>Type</th>
  1311. <th>Description</th>
  1312. </tr>
  1313. </thead>
  1314. <tbody>
  1315. <tr>
  1316. <td><span class="xref">System.Action</span>&lt;<a class="xref" href="Terminal.Gui.Wizard.StepChangeEventArgs.html">Wizard.StepChangeEventArgs</a>&gt;</td>
  1317. <td></td>
  1318. </tr>
  1319. </tbody>
  1320. </table>
  1321. <h4 id="Terminal_Gui_Wizard_StepChanging" data-uid="Terminal.Gui.Wizard.StepChanging">StepChanging</h4>
  1322. <div class="markdown level1 summary">
  1323. This event is raised when the current <a class="xref" href="Terminal.Gui.Wizard.html#Terminal_Gui_Wizard_CurrentStep">CurrentStep</a>) is about to change. Use <a class="xref" href="Terminal.Gui.Wizard.StepChangeEventArgs.html#Terminal_Gui_Wizard_StepChangeEventArgs_Cancel">Cancel</a>
  1324. to abort the transition.
  1325. </div>
  1326. <div class="markdown level1 conceptual"></div>
  1327. <h5 class="decalaration">Declaration</h5>
  1328. <div class="codewrapper">
  1329. <pre><code class="lang-csharp hljs">public event Action&lt;Wizard.StepChangeEventArgs&gt; StepChanging</code></pre>
  1330. </div>
  1331. <h5 class="eventType">Event Type</h5>
  1332. <table class="table table-bordered table-striped table-condensed">
  1333. <thead>
  1334. <tr>
  1335. <th>Type</th>
  1336. <th>Description</th>
  1337. </tr>
  1338. </thead>
  1339. <tbody>
  1340. <tr>
  1341. <td><span class="xref">System.Action</span>&lt;<a class="xref" href="Terminal.Gui.Wizard.StepChangeEventArgs.html">Wizard.StepChangeEventArgs</a>&gt;</td>
  1342. <td></td>
  1343. </tr>
  1344. </tbody>
  1345. </table>
  1346. <h3 id="implements">Implements</h3>
  1347. <div>
  1348. <span class="xref">System.IDisposable</span>
  1349. </div>
  1350. <div>
  1351. <span class="xref">System.ComponentModel.ISupportInitializeNotification</span>
  1352. </div>
  1353. <div>
  1354. <span class="xref">System.ComponentModel.ISupportInitialize</span>
  1355. </div>
  1356. </article>
  1357. </div>
  1358. <div class="hidden-sm col-md-2" role="complementary">
  1359. <div class="sideaffix">
  1360. <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
  1361. <h5>In This Article</h5>
  1362. <div></div>
  1363. </nav>
  1364. </div>
  1365. </div>
  1366. </div>
  1367. </div>
  1368. <footer>
  1369. <div class="grad-bottom"></div>
  1370. <div class="footer">
  1371. <div class="container">
  1372. <span class="pull-right">
  1373. <a href="#top">Back to top</a>
  1374. </span>
  1375. <span>Generated by <strong>DocFX</strong></span>
  1376. </div>
  1377. </div>
  1378. </footer>
  1379. </div>
  1380. <script type="text/javascript" src="../../styles/docfx.vendor.js"></script>
  1381. <script type="text/javascript" src="../../styles/docfx.js"></script>
  1382. <script type="text/javascript" src="../../styles/main.js"></script>
  1383. </body>
  1384. </html>