Terminal.Gui.Wizard.html 64 KB

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