Terminal.Gui.Button.html 44 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043
  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 Button
  8. </title>
  9. <meta name="viewport" content="width=device-width">
  10. <meta name="title" content="Class Button
  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.Button">
  74. <h1 id="Terminal_Gui_Button" data-uid="Terminal.Gui.Button" class="text-break">Class Button
  75. </h1>
  76. <div class="markdown level0 summary">
  77. Button is a <a class="xref" href="Terminal.Gui.View.html">View</a> that provides an item that invokes an <span class="xref">System.Action</span> when activated by the user.
  78. </div>
  79. <div class="markdown level0 conceptual"></div>
  80. <div class="inheritance">
  81. <h5>Inheritance</h5>
  82. <div class="level0"><span class="xref">System.Object</span></div>
  83. <div class="level1"><a class="xref" href="Terminal.Gui.Responder.html">Responder</a></div>
  84. <div class="level2"><a class="xref" href="Terminal.Gui.View.html">View</a></div>
  85. <div class="level3"><span class="xref">Button</span></div>
  86. </div>
  87. <div class="implements">
  88. <h5>Implements</h5>
  89. <div><span class="xref">System.IDisposable</span></div>
  90. <div><span class="xref">System.ComponentModel.ISupportInitializeNotification</span></div>
  91. <div><span class="xref">System.ComponentModel.ISupportInitialize</span></div>
  92. </div>
  93. <h5 id="Terminal_Gui_Button_remarks"><strong>Remarks</strong></h5>
  94. <div class="markdown level0 remarks">
  95. <p>
  96. Provides a button showing text invokes an <span class="xref">System.Action</span> when clicked on with a mouse
  97. or when the user presses SPACE, ENTER, or hotkey. The hotkey is the first letter or digit following the first underscore (&apos;_&apos;)
  98. in the button text.
  99. </p>
  100. <p>
  101. Use <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_HotKeySpecifier">HotKeySpecifier</a> to change the hotkey specifier from the default of (&apos;_&apos;).
  102. </p>
  103. <p>
  104. If no hotkey specifier is found, the first uppercase letter encountered will be used as the hotkey.
  105. </p>
  106. <p>
  107. When the button is configured as the default (<a class="xref" href="Terminal.Gui.Button.html#Terminal_Gui_Button_IsDefault">IsDefault</a>) and the user presses
  108. the ENTER key, if no other <a class="xref" href="Terminal.Gui.View.html">View</a> processes the <a class="xref" href="Terminal.Gui.KeyEvent.html">KeyEvent</a>, the <a class="xref" href="Terminal.Gui.Button.html">Button</a>&apos;s
  109. <span class="xref">System.Action</span> will be invoked.
  110. </p>
  111. </div>
  112. <div class="inheritedMembers">
  113. <h5>Inherited Members</h5>
  114. <div>
  115. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_GetMinWidthHeight_Terminal_Gui_Size__">View.GetMinWidthHeight(Size)</a>
  116. </div>
  117. <div>
  118. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SetMinWidthHeight">View.SetMinWidthHeight()</a>
  119. </div>
  120. <div>
  121. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ProcessResizeView">View.ProcessResizeView()</a>
  122. </div>
  123. <div>
  124. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SetNeedsDisplay">View.SetNeedsDisplay()</a>
  125. </div>
  126. <div>
  127. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ClearLayoutNeeded">View.ClearLayoutNeeded()</a>
  128. </div>
  129. <div>
  130. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SetNeedsDisplay_Terminal_Gui_Rect_">View.SetNeedsDisplay(Rect)</a>
  131. </div>
  132. <div>
  133. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SetChildNeedsDisplay">View.SetChildNeedsDisplay()</a>
  134. </div>
  135. <div>
  136. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Add_Terminal_Gui_View_">View.Add(View)</a>
  137. </div>
  138. <div>
  139. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Add_Terminal_Gui_View___">View.Add(View[])</a>
  140. </div>
  141. <div>
  142. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_RemoveAll">View.RemoveAll()</a>
  143. </div>
  144. <div>
  145. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Remove_Terminal_Gui_View_">View.Remove(View)</a>
  146. </div>
  147. <div>
  148. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_BringSubviewToFront_Terminal_Gui_View_">View.BringSubviewToFront(View)</a>
  149. </div>
  150. <div>
  151. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SendSubviewToBack_Terminal_Gui_View_">View.SendSubviewToBack(View)</a>
  152. </div>
  153. <div>
  154. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SendSubviewBackwards_Terminal_Gui_View_">View.SendSubviewBackwards(View)</a>
  155. </div>
  156. <div>
  157. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_BringSubviewForward_Terminal_Gui_View_">View.BringSubviewForward(View)</a>
  158. </div>
  159. <div>
  160. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Clear">View.Clear()</a>
  161. </div>
  162. <div>
  163. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Clear_Terminal_Gui_Rect_">View.Clear(Rect)</a>
  164. </div>
  165. <div>
  166. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ScreenToView_System_Int32_System_Int32_">View.ScreenToView(Int32, Int32)</a>
  167. </div>
  168. <div>
  169. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ClipToBounds">View.ClipToBounds()</a>
  170. </div>
  171. <div>
  172. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SetClip_Terminal_Gui_Rect_">View.SetClip(Rect)</a>
  173. </div>
  174. <div>
  175. <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>
  176. </div>
  177. <div>
  178. <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>
  179. </div>
  180. <div>
  181. <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>
  182. </div>
  183. <div>
  184. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Move_System_Int32_System_Int32_System_Boolean_">View.Move(Int32, Int32, Boolean)</a>
  185. </div>
  186. <div>
  187. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnAdded_Terminal_Gui_View_">View.OnAdded(View)</a>
  188. </div>
  189. <div>
  190. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnRemoved_Terminal_Gui_View_">View.OnRemoved(View)</a>
  191. </div>
  192. <div>
  193. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnLeave_Terminal_Gui_View_">View.OnLeave(View)</a>
  194. </div>
  195. <div>
  196. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_AddRune_System_Int32_System_Int32_System_Rune_">View.AddRune(Int32, Int32, Rune)</a>
  197. </div>
  198. <div>
  199. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ClearNeedsDisplay">View.ClearNeedsDisplay()</a>
  200. </div>
  201. <div>
  202. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Redraw_Terminal_Gui_Rect_">View.Redraw(Rect)</a>
  203. </div>
  204. <div>
  205. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnDrawContent_Terminal_Gui_Rect_">View.OnDrawContent(Rect)</a>
  206. </div>
  207. <div>
  208. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnDrawContentComplete_Terminal_Gui_Rect_">View.OnDrawContentComplete(Rect)</a>
  209. </div>
  210. <div>
  211. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SetFocus">View.SetFocus()</a>
  212. </div>
  213. <div>
  214. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_InvokeKeybindings_Terminal_Gui_KeyEvent_">View.InvokeKeybindings(KeyEvent)</a>
  215. </div>
  216. <div>
  217. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_AddKeyBinding_Terminal_Gui_Key_Terminal_Gui_Command_">View.AddKeyBinding(Key, Command)</a>
  218. </div>
  219. <div>
  220. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ReplaceKeyBinding_Terminal_Gui_Key_Terminal_Gui_Key_">View.ReplaceKeyBinding(Key, Key)</a>
  221. </div>
  222. <div>
  223. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ContainsKeyBinding_Terminal_Gui_Key_">View.ContainsKeyBinding(Key)</a>
  224. </div>
  225. <div>
  226. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ClearKeybindings">View.ClearKeybindings()</a>
  227. </div>
  228. <div>
  229. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ClearKeybinding_Terminal_Gui_Key_">View.ClearKeybinding(Key)</a>
  230. </div>
  231. <div>
  232. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ClearKeybinding_Terminal_Gui_Command_">View.ClearKeybinding(Command)</a>
  233. </div>
  234. <div>
  235. <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>
  236. </div>
  237. <div>
  238. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_GetSupportedCommands">View.GetSupportedCommands()</a>
  239. </div>
  240. <div>
  241. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_GetKeyFromCommand_Terminal_Gui_Command_">View.GetKeyFromCommand(Command)</a>
  242. </div>
  243. <div>
  244. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnKeyDown_Terminal_Gui_KeyEvent_">View.OnKeyDown(KeyEvent)</a>
  245. </div>
  246. <div>
  247. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnKeyUp_Terminal_Gui_KeyEvent_">View.OnKeyUp(KeyEvent)</a>
  248. </div>
  249. <div>
  250. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_EnsureFocus">View.EnsureFocus()</a>
  251. </div>
  252. <div>
  253. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_FocusFirst">View.FocusFirst()</a>
  254. </div>
  255. <div>
  256. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_FocusLast">View.FocusLast()</a>
  257. </div>
  258. <div>
  259. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_FocusPrev">View.FocusPrev()</a>
  260. </div>
  261. <div>
  262. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_FocusNext">View.FocusNext()</a>
  263. </div>
  264. <div>
  265. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_LayoutSubviews">View.LayoutSubviews()</a>
  266. </div>
  267. <div>
  268. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ToString">View.ToString()</a>
  269. </div>
  270. <div>
  271. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_GetAutoSize">View.GetAutoSize()</a>
  272. </div>
  273. <div>
  274. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_GetHotKeySpecifierLength_System_Boolean_">View.GetHotKeySpecifierLength(Boolean)</a>
  275. </div>
  276. <div>
  277. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_GetTextFormatterBoundsSize">View.GetTextFormatterBoundsSize()</a>
  278. </div>
  279. <div>
  280. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_GetBoundsTextFormatterSize">View.GetBoundsTextFormatterSize()</a>
  281. </div>
  282. <div>
  283. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnMouseEnter_Terminal_Gui_MouseEvent_">View.OnMouseEnter(MouseEvent)</a>
  284. </div>
  285. <div>
  286. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnMouseLeave_Terminal_Gui_MouseEvent_">View.OnMouseLeave(MouseEvent)</a>
  287. </div>
  288. <div>
  289. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnMouseEvent_Terminal_Gui_MouseEvent_">View.OnMouseEvent(MouseEvent)</a>
  290. </div>
  291. <div>
  292. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnMouseClick_Terminal_Gui_View_MouseEventArgs_">View.OnMouseClick(View.MouseEventArgs)</a>
  293. </div>
  294. <div>
  295. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnCanFocusChanged">View.OnCanFocusChanged()</a>
  296. </div>
  297. <div>
  298. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnEnabledChanged">View.OnEnabledChanged()</a>
  299. </div>
  300. <div>
  301. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnVisibleChanged">View.OnVisibleChanged()</a>
  302. </div>
  303. <div>
  304. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Dispose_System_Boolean_">View.Dispose(Boolean)</a>
  305. </div>
  306. <div>
  307. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_BeginInit">View.BeginInit()</a>
  308. </div>
  309. <div>
  310. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_EndInit">View.EndInit()</a>
  311. </div>
  312. <div>
  313. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SetWidth_System_Int32_System_Int32__">View.SetWidth(Int32, Int32)</a>
  314. </div>
  315. <div>
  316. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SetHeight_System_Int32_System_Int32__">View.SetHeight(Int32, Int32)</a>
  317. </div>
  318. <div>
  319. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_GetCurrentWidth_System_Int32__">View.GetCurrentWidth(Int32)</a>
  320. </div>
  321. <div>
  322. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_GetCurrentHeight_System_Int32__">View.GetCurrentHeight(Int32)</a>
  323. </div>
  324. <div>
  325. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_GetNormalColor">View.GetNormalColor()</a>
  326. </div>
  327. <div>
  328. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_GetTopSuperView">View.GetTopSuperView()</a>
  329. </div>
  330. <div>
  331. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_HotKeySpecifier">View.HotKeySpecifier</a>
  332. </div>
  333. <div>
  334. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Shortcut">View.Shortcut</a>
  335. </div>
  336. <div>
  337. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ShortcutTag">View.ShortcutTag</a>
  338. </div>
  339. <div>
  340. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ShortcutAction">View.ShortcutAction</a>
  341. </div>
  342. <div>
  343. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Data">View.Data</a>
  344. </div>
  345. <div>
  346. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Driver">View.Driver</a>
  347. </div>
  348. <div>
  349. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Subviews">View.Subviews</a>
  350. </div>
  351. <div>
  352. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_TabIndexes">View.TabIndexes</a>
  353. </div>
  354. <div>
  355. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_TabIndex">View.TabIndex</a>
  356. </div>
  357. <div>
  358. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_TabStop">View.TabStop</a>
  359. </div>
  360. <div>
  361. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_CanFocus">View.CanFocus</a>
  362. </div>
  363. <div>
  364. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Id">View.Id</a>
  365. </div>
  366. <div>
  367. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_IsCurrentTop">View.IsCurrentTop</a>
  368. </div>
  369. <div>
  370. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_WantMousePositionReports">View.WantMousePositionReports</a>
  371. </div>
  372. <div>
  373. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_WantContinuousButtonPressed">View.WantContinuousButtonPressed</a>
  374. </div>
  375. <div>
  376. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Frame">View.Frame</a>
  377. </div>
  378. <div>
  379. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_LayoutStyle">View.LayoutStyle</a>
  380. </div>
  381. <div>
  382. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Bounds">View.Bounds</a>
  383. </div>
  384. <div>
  385. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_X">View.X</a>
  386. </div>
  387. <div>
  388. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Y">View.Y</a>
  389. </div>
  390. <div>
  391. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Width">View.Width</a>
  392. </div>
  393. <div>
  394. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Height">View.Height</a>
  395. </div>
  396. <div>
  397. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ForceValidatePosDim">View.ForceValidatePosDim</a>
  398. </div>
  399. <div>
  400. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_TextFormatter">View.TextFormatter</a>
  401. </div>
  402. <div>
  403. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SuperView">View.SuperView</a>
  404. </div>
  405. <div>
  406. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_HasFocus">View.HasFocus</a>
  407. </div>
  408. <div>
  409. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Focused">View.Focused</a>
  410. </div>
  411. <div>
  412. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_MostFocused">View.MostFocused</a>
  413. </div>
  414. <div>
  415. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ColorScheme">View.ColorScheme</a>
  416. </div>
  417. <div>
  418. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Text">View.Text</a>
  419. </div>
  420. <div>
  421. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_AutoSize">View.AutoSize</a>
  422. </div>
  423. <div>
  424. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_PreserveTrailingSpaces">View.PreserveTrailingSpaces</a>
  425. </div>
  426. <div>
  427. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_TextAlignment">View.TextAlignment</a>
  428. </div>
  429. <div>
  430. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_VerticalTextAlignment">View.VerticalTextAlignment</a>
  431. </div>
  432. <div>
  433. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_TextDirection">View.TextDirection</a>
  434. </div>
  435. <div>
  436. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_IsInitialized">View.IsInitialized</a>
  437. </div>
  438. <div>
  439. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_IsAdded">View.IsAdded</a>
  440. </div>
  441. <div>
  442. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Enabled">View.Enabled</a>
  443. </div>
  444. <div>
  445. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Visible">View.Visible</a>
  446. </div>
  447. <div>
  448. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Border">View.Border</a>
  449. </div>
  450. <div>
  451. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Added">View.Added</a>
  452. </div>
  453. <div>
  454. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Removed">View.Removed</a>
  455. </div>
  456. <div>
  457. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Enter">View.Enter</a>
  458. </div>
  459. <div>
  460. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Leave">View.Leave</a>
  461. </div>
  462. <div>
  463. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_MouseEnter">View.MouseEnter</a>
  464. </div>
  465. <div>
  466. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_MouseLeave">View.MouseLeave</a>
  467. </div>
  468. <div>
  469. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_MouseClick">View.MouseClick</a>
  470. </div>
  471. <div>
  472. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_CanFocusChanged">View.CanFocusChanged</a>
  473. </div>
  474. <div>
  475. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_EnabledChanged">View.EnabledChanged</a>
  476. </div>
  477. <div>
  478. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_VisibleChanged">View.VisibleChanged</a>
  479. </div>
  480. <div>
  481. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_HotKeyChanged">View.HotKeyChanged</a>
  482. </div>
  483. <div>
  484. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_DrawContent">View.DrawContent</a>
  485. </div>
  486. <div>
  487. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_DrawContentComplete">View.DrawContentComplete</a>
  488. </div>
  489. <div>
  490. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_KeyPress">View.KeyPress</a>
  491. </div>
  492. <div>
  493. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_KeyDown">View.KeyDown</a>
  494. </div>
  495. <div>
  496. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_KeyUp">View.KeyUp</a>
  497. </div>
  498. <div>
  499. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_LayoutStarted">View.LayoutStarted</a>
  500. </div>
  501. <div>
  502. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_LayoutComplete">View.LayoutComplete</a>
  503. </div>
  504. <div>
  505. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Initialized">View.Initialized</a>
  506. </div>
  507. <div>
  508. <a class="xref" href="Terminal.Gui.Responder.html#Terminal_Gui_Responder_Dispose">Responder.Dispose()</a>
  509. </div>
  510. </div>
  511. <h6><strong>Namespace</strong>: <a class="xref" href="Terminal.Gui.html">Terminal.Gui</a></h6>
  512. <h6><strong>Assembly</strong>: Terminal.Gui.dll</h6>
  513. <h5 id="Terminal_Gui_Button_syntax">Syntax</h5>
  514. <div class="codewrapper">
  515. <pre><code class="lang-csharp hljs">public class Button : View</code></pre>
  516. </div>
  517. <h3 id="constructors">Constructors
  518. </h3>
  519. <a id="Terminal_Gui_Button__ctor_" data-uid="Terminal.Gui.Button.#ctor*"></a>
  520. <h4 id="Terminal_Gui_Button__ctor" data-uid="Terminal.Gui.Button.#ctor">Button()</h4>
  521. <div class="markdown level1 summary">
  522. Initializes a new instance of <a class="xref" href="Terminal.Gui.Button.html">Button</a> using <a class="xref" href="Terminal.Gui.LayoutStyle.html#Terminal_Gui_LayoutStyle_Computed">Computed</a> layout.
  523. </div>
  524. <div class="markdown level1 conceptual"></div>
  525. <h5 class="decalaration">Declaration</h5>
  526. <div class="codewrapper">
  527. <pre><code class="lang-csharp hljs">public Button()</code></pre>
  528. </div>
  529. <a id="Terminal_Gui_Button__ctor_" data-uid="Terminal.Gui.Button.#ctor*"></a>
  530. <h4 id="Terminal_Gui_Button__ctor_NStack_ustring_System_Boolean_" data-uid="Terminal.Gui.Button.#ctor(NStack.ustring,System.Boolean)">Button(ustring, Boolean)</h4>
  531. <div class="markdown level1 summary">
  532. Initializes a new instance of <a class="xref" href="Terminal.Gui.Button.html">Button</a> using <a class="xref" href="Terminal.Gui.LayoutStyle.html#Terminal_Gui_LayoutStyle_Computed">Computed</a> layout.
  533. </div>
  534. <div class="markdown level1 conceptual"></div>
  535. <h5 class="decalaration">Declaration</h5>
  536. <div class="codewrapper">
  537. <pre><code class="lang-csharp hljs">public Button(ustring text, bool is_default = false)</code></pre>
  538. </div>
  539. <h5 class="parameters">Parameters</h5>
  540. <table class="table table-bordered table-striped table-condensed">
  541. <thead>
  542. <tr>
  543. <th>Type</th>
  544. <th>Name</th>
  545. <th>Description</th>
  546. </tr>
  547. </thead>
  548. <tbody>
  549. <tr>
  550. <td><span class="xref">NStack.ustring</span></td>
  551. <td><span class="parametername">text</span></td>
  552. <td>The button&apos;s text</td>
  553. </tr>
  554. <tr>
  555. <td><span class="xref">System.Boolean</span></td>
  556. <td><span class="parametername">is_default</span></td>
  557. <td>
  558. If <code>true</code>, a special decoration is used, and the user pressing the enter key
  559. in a <a class="xref" href="Terminal.Gui.Dialog.html">Dialog</a> will implicitly activate this button.
  560. </td>
  561. </tr>
  562. </tbody>
  563. </table>
  564. <a id="Terminal_Gui_Button__ctor_" data-uid="Terminal.Gui.Button.#ctor*"></a>
  565. <h4 id="Terminal_Gui_Button__ctor_System_Int32_System_Int32_NStack_ustring_" data-uid="Terminal.Gui.Button.#ctor(System.Int32,System.Int32,NStack.ustring)">Button(Int32, Int32, ustring)</h4>
  566. <div class="markdown level1 summary">
  567. Initializes a new instance of <a class="xref" href="Terminal.Gui.Button.html">Button</a> using <a class="xref" href="Terminal.Gui.LayoutStyle.html#Terminal_Gui_LayoutStyle_Absolute">Absolute</a> layout, based on the given text
  568. </div>
  569. <div class="markdown level1 conceptual"></div>
  570. <h5 class="decalaration">Declaration</h5>
  571. <div class="codewrapper">
  572. <pre><code class="lang-csharp hljs">public Button(int x, int y, ustring text)</code></pre>
  573. </div>
  574. <h5 class="parameters">Parameters</h5>
  575. <table class="table table-bordered table-striped table-condensed">
  576. <thead>
  577. <tr>
  578. <th>Type</th>
  579. <th>Name</th>
  580. <th>Description</th>
  581. </tr>
  582. </thead>
  583. <tbody>
  584. <tr>
  585. <td><span class="xref">System.Int32</span></td>
  586. <td><span class="parametername">x</span></td>
  587. <td>X position where the button will be shown.</td>
  588. </tr>
  589. <tr>
  590. <td><span class="xref">System.Int32</span></td>
  591. <td><span class="parametername">y</span></td>
  592. <td>Y position where the button will be shown.</td>
  593. </tr>
  594. <tr>
  595. <td><span class="xref">NStack.ustring</span></td>
  596. <td><span class="parametername">text</span></td>
  597. <td>The button&apos;s text</td>
  598. </tr>
  599. </tbody>
  600. </table>
  601. <a id="Terminal_Gui_Button__ctor_" data-uid="Terminal.Gui.Button.#ctor*"></a>
  602. <h4 id="Terminal_Gui_Button__ctor_System_Int32_System_Int32_NStack_ustring_System_Boolean_" data-uid="Terminal.Gui.Button.#ctor(System.Int32,System.Int32,NStack.ustring,System.Boolean)">Button(Int32, Int32, ustring, Boolean)</h4>
  603. <div class="markdown level1 summary">
  604. Initializes a new instance of <a class="xref" href="Terminal.Gui.Button.html">Button</a> using <a class="xref" href="Terminal.Gui.LayoutStyle.html#Terminal_Gui_LayoutStyle_Absolute">Absolute</a> layout, based on the given text.
  605. </div>
  606. <div class="markdown level1 conceptual"></div>
  607. <h5 class="decalaration">Declaration</h5>
  608. <div class="codewrapper">
  609. <pre><code class="lang-csharp hljs">public Button(int x, int y, ustring text, bool is_default)</code></pre>
  610. </div>
  611. <h5 class="parameters">Parameters</h5>
  612. <table class="table table-bordered table-striped table-condensed">
  613. <thead>
  614. <tr>
  615. <th>Type</th>
  616. <th>Name</th>
  617. <th>Description</th>
  618. </tr>
  619. </thead>
  620. <tbody>
  621. <tr>
  622. <td><span class="xref">System.Int32</span></td>
  623. <td><span class="parametername">x</span></td>
  624. <td>X position where the button will be shown.</td>
  625. </tr>
  626. <tr>
  627. <td><span class="xref">System.Int32</span></td>
  628. <td><span class="parametername">y</span></td>
  629. <td>Y position where the button will be shown.</td>
  630. </tr>
  631. <tr>
  632. <td><span class="xref">NStack.ustring</span></td>
  633. <td><span class="parametername">text</span></td>
  634. <td>The button&apos;s text</td>
  635. </tr>
  636. <tr>
  637. <td><span class="xref">System.Boolean</span></td>
  638. <td><span class="parametername">is_default</span></td>
  639. <td>
  640. If <code>true</code>, a special decoration is used, and the user pressing the enter key
  641. in a <a class="xref" href="Terminal.Gui.Dialog.html">Dialog</a> will implicitly activate this button.
  642. </td>
  643. </tr>
  644. </tbody>
  645. </table>
  646. <h3 id="properties">Properties
  647. </h3>
  648. <a id="Terminal_Gui_Button_HotKey_" data-uid="Terminal.Gui.Button.HotKey*"></a>
  649. <h4 id="Terminal_Gui_Button_HotKey" data-uid="Terminal.Gui.Button.HotKey">HotKey</h4>
  650. <div class="markdown level1 summary">
  651. Gets or sets the HotKey defined for this view. A user pressing HotKey on the keyboard while this view has focus will cause the Clicked event to fire.
  652. </div>
  653. <div class="markdown level1 conceptual"></div>
  654. <h5 class="decalaration">Declaration</h5>
  655. <div class="codewrapper">
  656. <pre><code class="lang-csharp hljs">public override Key HotKey { get; set; }</code></pre>
  657. </div>
  658. <h5 class="propertyValue">Property Value</h5>
  659. <table class="table table-bordered table-striped table-condensed">
  660. <thead>
  661. <tr>
  662. <th>Type</th>
  663. <th>Description</th>
  664. </tr>
  665. </thead>
  666. <tbody>
  667. <tr>
  668. <td><a class="xref" href="Terminal.Gui.Key.html">Key</a></td>
  669. <td></td>
  670. </tr>
  671. </tbody>
  672. </table>
  673. <h5 class="overrides">Overrides</h5>
  674. <div><a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_HotKey">View.HotKey</a></div>
  675. <a id="Terminal_Gui_Button_IsDefault_" data-uid="Terminal.Gui.Button.IsDefault*"></a>
  676. <h4 id="Terminal_Gui_Button_IsDefault" data-uid="Terminal.Gui.Button.IsDefault">IsDefault</h4>
  677. <div class="markdown level1 summary">
  678. Gets or sets whether the <a class="xref" href="Terminal.Gui.Button.html">Button</a> is the default action to activate in a dialog.
  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 bool IsDefault { get; set; }</code></pre>
  684. </div>
  685. <h5 class="propertyValue">Property Value</h5>
  686. <table class="table table-bordered table-striped table-condensed">
  687. <thead>
  688. <tr>
  689. <th>Type</th>
  690. <th>Description</th>
  691. </tr>
  692. </thead>
  693. <tbody>
  694. <tr>
  695. <td><span class="xref">System.Boolean</span></td>
  696. <td><code>true</code> if is default; otherwise, <code>false</code>.</td>
  697. </tr>
  698. </tbody>
  699. </table>
  700. <h3 id="methods">Methods
  701. </h3>
  702. <a id="Terminal_Gui_Button_MouseEvent_" data-uid="Terminal.Gui.Button.MouseEvent*"></a>
  703. <h4 id="Terminal_Gui_Button_MouseEvent_Terminal_Gui_MouseEvent_" data-uid="Terminal.Gui.Button.MouseEvent(Terminal.Gui.MouseEvent)">MouseEvent(MouseEvent)</h4>
  704. <div class="markdown level1 summary">
  705. Method invoked when a mouse event is generated
  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 override bool MouseEvent(MouseEvent me)</code></pre>
  711. </div>
  712. <h5 class="parameters">Parameters</h5>
  713. <table class="table table-bordered table-striped table-condensed">
  714. <thead>
  715. <tr>
  716. <th>Type</th>
  717. <th>Name</th>
  718. <th>Description</th>
  719. </tr>
  720. </thead>
  721. <tbody>
  722. <tr>
  723. <td><a class="xref" href="Terminal.Gui.MouseEvent.html">MouseEvent</a></td>
  724. <td><span class="parametername">me</span></td>
  725. <td></td>
  726. </tr>
  727. </tbody>
  728. </table>
  729. <h5 class="returns">Returns</h5>
  730. <table class="table table-bordered table-striped table-condensed">
  731. <thead>
  732. <tr>
  733. <th>Type</th>
  734. <th>Description</th>
  735. </tr>
  736. </thead>
  737. <tbody>
  738. <tr>
  739. <td><span class="xref">System.Boolean</span></td>
  740. <td><code>true</code>, if the event was handled, <code>false</code> otherwise.</td>
  741. </tr>
  742. </tbody>
  743. </table>
  744. <h5 class="overrides">Overrides</h5>
  745. <div><a class="xref" href="Terminal.Gui.Responder.html#Terminal_Gui_Responder_MouseEvent_Terminal_Gui_MouseEvent_">Responder.MouseEvent(MouseEvent)</a></div>
  746. <a id="Terminal_Gui_Button_OnClicked_" data-uid="Terminal.Gui.Button.OnClicked*"></a>
  747. <h4 id="Terminal_Gui_Button_OnClicked" data-uid="Terminal.Gui.Button.OnClicked">OnClicked()</h4>
  748. <div class="markdown level1 summary">
  749. Virtual method to invoke the <a class="xref" href="Terminal.Gui.Button.html#Terminal_Gui_Button_Clicked">Clicked</a> event.
  750. </div>
  751. <div class="markdown level1 conceptual"></div>
  752. <h5 class="decalaration">Declaration</h5>
  753. <div class="codewrapper">
  754. <pre><code class="lang-csharp hljs">public virtual void OnClicked()</code></pre>
  755. </div>
  756. <a id="Terminal_Gui_Button_OnEnter_" data-uid="Terminal.Gui.Button.OnEnter*"></a>
  757. <h4 id="Terminal_Gui_Button_OnEnter_Terminal_Gui_View_" data-uid="Terminal.Gui.Button.OnEnter(Terminal.Gui.View)">OnEnter(View)</h4>
  758. <div class="markdown level1 summary">
  759. Method invoked when a view gets focus.
  760. </div>
  761. <div class="markdown level1 conceptual"></div>
  762. <h5 class="decalaration">Declaration</h5>
  763. <div class="codewrapper">
  764. <pre><code class="lang-csharp hljs">public override bool OnEnter(View view)</code></pre>
  765. </div>
  766. <h5 class="parameters">Parameters</h5>
  767. <table class="table table-bordered table-striped table-condensed">
  768. <thead>
  769. <tr>
  770. <th>Type</th>
  771. <th>Name</th>
  772. <th>Description</th>
  773. </tr>
  774. </thead>
  775. <tbody>
  776. <tr>
  777. <td><a class="xref" href="Terminal.Gui.View.html">View</a></td>
  778. <td><span class="parametername">view</span></td>
  779. <td>The view that is losing focus.</td>
  780. </tr>
  781. </tbody>
  782. </table>
  783. <h5 class="returns">Returns</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><code>true</code>, if the event was handled, <code>false</code> otherwise.</td>
  795. </tr>
  796. </tbody>
  797. </table>
  798. <h5 class="overrides">Overrides</h5>
  799. <div><a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnEnter_Terminal_Gui_View_">View.OnEnter(View)</a></div>
  800. <a id="Terminal_Gui_Button_PositionCursor_" data-uid="Terminal.Gui.Button.PositionCursor*"></a>
  801. <h4 id="Terminal_Gui_Button_PositionCursor" data-uid="Terminal.Gui.Button.PositionCursor">PositionCursor()</h4>
  802. <div class="markdown level1 summary">
  803. Positions the cursor in the right position based on the currently focused view in the chain.
  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 override void PositionCursor()</code></pre>
  809. </div>
  810. <h5 class="overrides">Overrides</h5>
  811. <div><a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_PositionCursor">View.PositionCursor()</a></div>
  812. <a id="Terminal_Gui_Button_ProcessColdKey_" data-uid="Terminal.Gui.Button.ProcessColdKey*"></a>
  813. <h4 id="Terminal_Gui_Button_ProcessColdKey_Terminal_Gui_KeyEvent_" data-uid="Terminal.Gui.Button.ProcessColdKey(Terminal.Gui.KeyEvent)">ProcessColdKey(KeyEvent)</h4>
  814. <div class="markdown level1 summary">
  815. This method can be overwritten by views that
  816. want to provide accelerator functionality
  817. (Alt-key for example), but without
  818. interefering with normal ProcessKey behavior.
  819. </div>
  820. <div class="markdown level1 conceptual"></div>
  821. <h5 class="decalaration">Declaration</h5>
  822. <div class="codewrapper">
  823. <pre><code class="lang-csharp hljs">public override bool ProcessColdKey(KeyEvent kb)</code></pre>
  824. </div>
  825. <h5 class="parameters">Parameters</h5>
  826. <table class="table table-bordered table-striped table-condensed">
  827. <thead>
  828. <tr>
  829. <th>Type</th>
  830. <th>Name</th>
  831. <th>Description</th>
  832. </tr>
  833. </thead>
  834. <tbody>
  835. <tr>
  836. <td><a class="xref" href="Terminal.Gui.KeyEvent.html">KeyEvent</a></td>
  837. <td><span class="parametername">kb</span></td>
  838. <td></td>
  839. </tr>
  840. </tbody>
  841. </table>
  842. <h5 class="returns">Returns</h5>
  843. <table class="table table-bordered table-striped table-condensed">
  844. <thead>
  845. <tr>
  846. <th>Type</th>
  847. <th>Description</th>
  848. </tr>
  849. </thead>
  850. <tbody>
  851. <tr>
  852. <td><span class="xref">System.Boolean</span></td>
  853. <td></td>
  854. </tr>
  855. </tbody>
  856. </table>
  857. <h5 class="overrides">Overrides</h5>
  858. <div><a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ProcessColdKey_Terminal_Gui_KeyEvent_">View.ProcessColdKey(KeyEvent)</a></div>
  859. <a id="Terminal_Gui_Button_ProcessHotKey_" data-uid="Terminal.Gui.Button.ProcessHotKey*"></a>
  860. <h4 id="Terminal_Gui_Button_ProcessHotKey_Terminal_Gui_KeyEvent_" data-uid="Terminal.Gui.Button.ProcessHotKey(Terminal.Gui.KeyEvent)">ProcessHotKey(KeyEvent)</h4>
  861. <div class="markdown level1 summary">
  862. This method can be overwritten by view that
  863. want to provide accelerator functionality
  864. (Alt-key for example).
  865. </div>
  866. <div class="markdown level1 conceptual"></div>
  867. <h5 class="decalaration">Declaration</h5>
  868. <div class="codewrapper">
  869. <pre><code class="lang-csharp hljs">public override bool ProcessHotKey(KeyEvent kb)</code></pre>
  870. </div>
  871. <h5 class="parameters">Parameters</h5>
  872. <table class="table table-bordered table-striped table-condensed">
  873. <thead>
  874. <tr>
  875. <th>Type</th>
  876. <th>Name</th>
  877. <th>Description</th>
  878. </tr>
  879. </thead>
  880. <tbody>
  881. <tr>
  882. <td><a class="xref" href="Terminal.Gui.KeyEvent.html">KeyEvent</a></td>
  883. <td><span class="parametername">kb</span></td>
  884. <td></td>
  885. </tr>
  886. </tbody>
  887. </table>
  888. <h5 class="returns">Returns</h5>
  889. <table class="table table-bordered table-striped table-condensed">
  890. <thead>
  891. <tr>
  892. <th>Type</th>
  893. <th>Description</th>
  894. </tr>
  895. </thead>
  896. <tbody>
  897. <tr>
  898. <td><span class="xref">System.Boolean</span></td>
  899. <td></td>
  900. </tr>
  901. </tbody>
  902. </table>
  903. <h5 class="overrides">Overrides</h5>
  904. <div><a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ProcessHotKey_Terminal_Gui_KeyEvent_">View.ProcessHotKey(KeyEvent)</a></div>
  905. <a id="Terminal_Gui_Button_ProcessKey_" data-uid="Terminal.Gui.Button.ProcessKey*"></a>
  906. <h4 id="Terminal_Gui_Button_ProcessKey_Terminal_Gui_KeyEvent_" data-uid="Terminal.Gui.Button.ProcessKey(Terminal.Gui.KeyEvent)">ProcessKey(KeyEvent)</h4>
  907. <div class="markdown level1 summary">
  908. If the view is focused, gives the view a
  909. chance to process the keystroke.
  910. </div>
  911. <div class="markdown level1 conceptual"></div>
  912. <h5 class="decalaration">Declaration</h5>
  913. <div class="codewrapper">
  914. <pre><code class="lang-csharp hljs">public override bool ProcessKey(KeyEvent kb)</code></pre>
  915. </div>
  916. <h5 class="parameters">Parameters</h5>
  917. <table class="table table-bordered table-striped table-condensed">
  918. <thead>
  919. <tr>
  920. <th>Type</th>
  921. <th>Name</th>
  922. <th>Description</th>
  923. </tr>
  924. </thead>
  925. <tbody>
  926. <tr>
  927. <td><a class="xref" href="Terminal.Gui.KeyEvent.html">KeyEvent</a></td>
  928. <td><span class="parametername">kb</span></td>
  929. <td></td>
  930. </tr>
  931. </tbody>
  932. </table>
  933. <h5 class="returns">Returns</h5>
  934. <table class="table table-bordered table-striped table-condensed">
  935. <thead>
  936. <tr>
  937. <th>Type</th>
  938. <th>Description</th>
  939. </tr>
  940. </thead>
  941. <tbody>
  942. <tr>
  943. <td><span class="xref">System.Boolean</span></td>
  944. <td></td>
  945. </tr>
  946. </tbody>
  947. </table>
  948. <h5 class="overrides">Overrides</h5>
  949. <div><a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ProcessKey_Terminal_Gui_KeyEvent_">View.ProcessKey(KeyEvent)</a></div>
  950. <a id="Terminal_Gui_Button_UpdateTextFormatterText_" data-uid="Terminal.Gui.Button.UpdateTextFormatterText*"></a>
  951. <h4 id="Terminal_Gui_Button_UpdateTextFormatterText" data-uid="Terminal.Gui.Button.UpdateTextFormatterText">UpdateTextFormatterText()</h4>
  952. <div class="markdown level1 summary">
  953. Can be overridden if the <a class="xref" href="Terminal.Gui.TextFormatter.html#Terminal_Gui_TextFormatter_Text">Text</a> has
  954. different format than the default.
  955. </div>
  956. <div class="markdown level1 conceptual"></div>
  957. <h5 class="decalaration">Declaration</h5>
  958. <div class="codewrapper">
  959. <pre><code class="lang-csharp hljs">protected override void UpdateTextFormatterText()</code></pre>
  960. </div>
  961. <h5 class="overrides">Overrides</h5>
  962. <div><a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_UpdateTextFormatterText">View.UpdateTextFormatterText()</a></div>
  963. <h3 id="events">Events
  964. </h3>
  965. <h4 id="Terminal_Gui_Button_Clicked" data-uid="Terminal.Gui.Button.Clicked">Clicked</h4>
  966. <div class="markdown level1 summary">
  967. Clicked <span class="xref">System.Action</span>, raised when the user clicks the primary mouse button within the Bounds of this <a class="xref" href="Terminal.Gui.View.html">View</a>
  968. or if the user presses the action key while this view is focused. (TODO: IsDefault)
  969. </div>
  970. <div class="markdown level1 conceptual"></div>
  971. <h5 class="decalaration">Declaration</h5>
  972. <div class="codewrapper">
  973. <pre><code class="lang-csharp hljs">public event Action Clicked</code></pre>
  974. </div>
  975. <h5 class="eventType">Event Type</h5>
  976. <table class="table table-bordered table-striped table-condensed">
  977. <thead>
  978. <tr>
  979. <th>Type</th>
  980. <th>Description</th>
  981. </tr>
  982. </thead>
  983. <tbody>
  984. <tr>
  985. <td><span class="xref">System.Action</span></td>
  986. <td></td>
  987. </tr>
  988. </tbody>
  989. </table>
  990. <h3 id="implements">Implements</h3>
  991. <div>
  992. <span class="xref">System.IDisposable</span>
  993. </div>
  994. <div>
  995. <span class="xref">System.ComponentModel.ISupportInitializeNotification</span>
  996. </div>
  997. <div>
  998. <span class="xref">System.ComponentModel.ISupportInitialize</span>
  999. </div>
  1000. </article>
  1001. </div>
  1002. <div class="hidden-sm col-md-2" role="complementary">
  1003. <div class="sideaffix">
  1004. <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
  1005. <h5>In This Article</h5>
  1006. <div></div>
  1007. </nav>
  1008. </div>
  1009. </div>
  1010. </div>
  1011. </div>
  1012. <footer>
  1013. <div class="grad-bottom"></div>
  1014. <div class="footer">
  1015. <div class="container">
  1016. <span class="pull-right">
  1017. <a href="#top">Back to top</a>
  1018. </span>
  1019. <span>Generated by <strong>DocFX</strong></span>
  1020. </div>
  1021. </div>
  1022. </footer>
  1023. </div>
  1024. <script type="text/javascript" src="../../styles/docfx.vendor.js"></script>
  1025. <script type="text/javascript" src="../../styles/docfx.js"></script>
  1026. <script type="text/javascript" src="../../styles/main.js"></script>
  1027. </body>
  1028. </html>