Terminal.Gui.Button.html 54 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153
  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.4.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_Added">View.Added</a>
  116. </div>
  117. <div>
  118. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Removed">View.Removed</a>
  119. </div>
  120. <div>
  121. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Enter">View.Enter</a>
  122. </div>
  123. <div>
  124. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Leave">View.Leave</a>
  125. </div>
  126. <div>
  127. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_MouseEnter">View.MouseEnter</a>
  128. </div>
  129. <div>
  130. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_MouseLeave">View.MouseLeave</a>
  131. </div>
  132. <div>
  133. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_MouseClick">View.MouseClick</a>
  134. </div>
  135. <div>
  136. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_CanFocusChanged">View.CanFocusChanged</a>
  137. </div>
  138. <div>
  139. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_EnabledChanged">View.EnabledChanged</a>
  140. </div>
  141. <div>
  142. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_VisibleChanged">View.VisibleChanged</a>
  143. </div>
  144. <div>
  145. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_HotKeyChanged">View.HotKeyChanged</a>
  146. </div>
  147. <div>
  148. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_HotKeySpecifier">View.HotKeySpecifier</a>
  149. </div>
  150. <div>
  151. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Shortcut">View.Shortcut</a>
  152. </div>
  153. <div>
  154. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ShortcutTag">View.ShortcutTag</a>
  155. </div>
  156. <div>
  157. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ShortcutAction">View.ShortcutAction</a>
  158. </div>
  159. <div>
  160. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Data">View.Data</a>
  161. </div>
  162. <div>
  163. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Driver">View.Driver</a>
  164. </div>
  165. <div>
  166. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Subviews">View.Subviews</a>
  167. </div>
  168. <div>
  169. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_TabIndexes">View.TabIndexes</a>
  170. </div>
  171. <div>
  172. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_TabIndex">View.TabIndex</a>
  173. </div>
  174. <div>
  175. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_TabStop">View.TabStop</a>
  176. </div>
  177. <div>
  178. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_CanFocus">View.CanFocus</a>
  179. </div>
  180. <div>
  181. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Id">View.Id</a>
  182. </div>
  183. <div>
  184. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_IsCurrentTop">View.IsCurrentTop</a>
  185. </div>
  186. <div>
  187. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_WantMousePositionReports">View.WantMousePositionReports</a>
  188. </div>
  189. <div>
  190. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_WantContinuousButtonPressed">View.WantContinuousButtonPressed</a>
  191. </div>
  192. <div>
  193. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Frame">View.Frame</a>
  194. </div>
  195. <div>
  196. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_LayoutStyle">View.LayoutStyle</a>
  197. </div>
  198. <div>
  199. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Bounds">View.Bounds</a>
  200. </div>
  201. <div>
  202. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_X">View.X</a>
  203. </div>
  204. <div>
  205. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Y">View.Y</a>
  206. </div>
  207. <div>
  208. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Width">View.Width</a>
  209. </div>
  210. <div>
  211. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Height">View.Height</a>
  212. </div>
  213. <div>
  214. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ForceValidatePosDim">View.ForceValidatePosDim</a>
  215. </div>
  216. <div>
  217. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_GetMinWidthHeight_Terminal_Gui_Size__">View.GetMinWidthHeight(Size)</a>
  218. </div>
  219. <div>
  220. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SetMinWidthHeight">View.SetMinWidthHeight()</a>
  221. </div>
  222. <div>
  223. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_TextFormatter">View.TextFormatter</a>
  224. </div>
  225. <div>
  226. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SuperView">View.SuperView</a>
  227. </div>
  228. <div>
  229. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ProcessResizeView">View.ProcessResizeView()</a>
  230. </div>
  231. <div>
  232. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SetNeedsDisplay">View.SetNeedsDisplay()</a>
  233. </div>
  234. <div>
  235. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ClearLayoutNeeded">View.ClearLayoutNeeded()</a>
  236. </div>
  237. <div>
  238. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SetNeedsDisplay_Terminal_Gui_Rect_">View.SetNeedsDisplay(Rect)</a>
  239. </div>
  240. <div>
  241. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SetChildNeedsDisplay">View.SetChildNeedsDisplay()</a>
  242. </div>
  243. <div>
  244. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Add_Terminal_Gui_View_">View.Add(View)</a>
  245. </div>
  246. <div>
  247. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Add_Terminal_Gui_View___">View.Add(View[])</a>
  248. </div>
  249. <div>
  250. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_RemoveAll">View.RemoveAll()</a>
  251. </div>
  252. <div>
  253. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Remove_Terminal_Gui_View_">View.Remove(View)</a>
  254. </div>
  255. <div>
  256. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_BringSubviewToFront_Terminal_Gui_View_">View.BringSubviewToFront(View)</a>
  257. </div>
  258. <div>
  259. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SendSubviewToBack_Terminal_Gui_View_">View.SendSubviewToBack(View)</a>
  260. </div>
  261. <div>
  262. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SendSubviewBackwards_Terminal_Gui_View_">View.SendSubviewBackwards(View)</a>
  263. </div>
  264. <div>
  265. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_BringSubviewForward_Terminal_Gui_View_">View.BringSubviewForward(View)</a>
  266. </div>
  267. <div>
  268. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Clear">View.Clear()</a>
  269. </div>
  270. <div>
  271. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Clear_Terminal_Gui_Rect_">View.Clear(Rect)</a>
  272. </div>
  273. <div>
  274. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ScreenToView_System_Int32_System_Int32_">View.ScreenToView(Int32, Int32)</a>
  275. </div>
  276. <div>
  277. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ClipToBounds">View.ClipToBounds()</a>
  278. </div>
  279. <div>
  280. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SetClip_Terminal_Gui_Rect_">View.SetClip(Rect)</a>
  281. </div>
  282. <div>
  283. <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>
  284. </div>
  285. <div>
  286. <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>
  287. </div>
  288. <div>
  289. <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>
  290. </div>
  291. <div>
  292. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Move_System_Int32_System_Int32_System_Boolean_">View.Move(Int32, Int32, Boolean)</a>
  293. </div>
  294. <div>
  295. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_HasFocus">View.HasFocus</a>
  296. </div>
  297. <div>
  298. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnAdded_Terminal_Gui_View_">View.OnAdded(View)</a>
  299. </div>
  300. <div>
  301. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnRemoved_Terminal_Gui_View_">View.OnRemoved(View)</a>
  302. </div>
  303. <div>
  304. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnLeave_Terminal_Gui_View_">View.OnLeave(View)</a>
  305. </div>
  306. <div>
  307. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Focused">View.Focused</a>
  308. </div>
  309. <div>
  310. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_MostFocused">View.MostFocused</a>
  311. </div>
  312. <div>
  313. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ColorScheme">View.ColorScheme</a>
  314. </div>
  315. <div>
  316. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_AddRune_System_Int32_System_Int32_System_Rune_">View.AddRune(Int32, Int32, Rune)</a>
  317. </div>
  318. <div>
  319. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ClearNeedsDisplay">View.ClearNeedsDisplay()</a>
  320. </div>
  321. <div>
  322. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Redraw_Terminal_Gui_Rect_">View.Redraw(Rect)</a>
  323. </div>
  324. <div>
  325. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_DrawContent">View.DrawContent</a>
  326. </div>
  327. <div>
  328. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnDrawContent_Terminal_Gui_Rect_">View.OnDrawContent(Rect)</a>
  329. </div>
  330. <div>
  331. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_DrawContentComplete">View.DrawContentComplete</a>
  332. </div>
  333. <div>
  334. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnDrawContentComplete_Terminal_Gui_Rect_">View.OnDrawContentComplete(Rect)</a>
  335. </div>
  336. <div>
  337. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SetFocus">View.SetFocus()</a>
  338. </div>
  339. <div>
  340. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_KeyPress">View.KeyPress</a>
  341. </div>
  342. <div>
  343. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_InvokeKeybindings_Terminal_Gui_KeyEvent_">View.InvokeKeybindings(KeyEvent)</a>
  344. </div>
  345. <div>
  346. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_AddKeyBinding_Terminal_Gui_Key_Terminal_Gui_Command___">View.AddKeyBinding(Key, Command[])</a>
  347. </div>
  348. <div>
  349. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ReplaceKeyBinding_Terminal_Gui_Key_Terminal_Gui_Key_">View.ReplaceKeyBinding(Key, Key)</a>
  350. </div>
  351. <div>
  352. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ContainsKeyBinding_Terminal_Gui_Key_">View.ContainsKeyBinding(Key)</a>
  353. </div>
  354. <div>
  355. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ClearKeybindings">View.ClearKeybindings()</a>
  356. </div>
  357. <div>
  358. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ClearKeybinding_Terminal_Gui_Key_">View.ClearKeybinding(Key)</a>
  359. </div>
  360. <div>
  361. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ClearKeybinding_Terminal_Gui_Command___">View.ClearKeybinding(Command[])</a>
  362. </div>
  363. <div>
  364. <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>
  365. </div>
  366. <div>
  367. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_GetSupportedCommands">View.GetSupportedCommands()</a>
  368. </div>
  369. <div>
  370. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_GetKeyFromCommand_Terminal_Gui_Command___">View.GetKeyFromCommand(Command[])</a>
  371. </div>
  372. <div>
  373. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_KeyDown">View.KeyDown</a>
  374. </div>
  375. <div>
  376. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnKeyDown_Terminal_Gui_KeyEvent_">View.OnKeyDown(KeyEvent)</a>
  377. </div>
  378. <div>
  379. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_KeyUp">View.KeyUp</a>
  380. </div>
  381. <div>
  382. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnKeyUp_Terminal_Gui_KeyEvent_">View.OnKeyUp(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_LayoutStarted">View.LayoutStarted</a>
  401. </div>
  402. <div>
  403. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_LayoutComplete">View.LayoutComplete</a>
  404. </div>
  405. <div>
  406. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Initialized">View.Initialized</a>
  407. </div>
  408. <div>
  409. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_LayoutSubviews">View.LayoutSubviews()</a>
  410. </div>
  411. <div>
  412. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Text">View.Text</a>
  413. </div>
  414. <div>
  415. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_AutoSize">View.AutoSize</a>
  416. </div>
  417. <div>
  418. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_PreserveTrailingSpaces">View.PreserveTrailingSpaces</a>
  419. </div>
  420. <div>
  421. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_TextAlignment">View.TextAlignment</a>
  422. </div>
  423. <div>
  424. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_VerticalTextAlignment">View.VerticalTextAlignment</a>
  425. </div>
  426. <div>
  427. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_TextDirection">View.TextDirection</a>
  428. </div>
  429. <div>
  430. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_IsInitialized">View.IsInitialized</a>
  431. </div>
  432. <div>
  433. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_IsAdded">View.IsAdded</a>
  434. </div>
  435. <div>
  436. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Enabled">View.Enabled</a>
  437. </div>
  438. <div>
  439. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Visible">View.Visible</a>
  440. </div>
  441. <div>
  442. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Border">View.Border</a>
  443. </div>
  444. <div>
  445. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ToString">View.ToString()</a>
  446. </div>
  447. <div>
  448. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_GetAutoSize">View.GetAutoSize()</a>
  449. </div>
  450. <div>
  451. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_GetHotKeySpecifierLength_System_Boolean_">View.GetHotKeySpecifierLength(Boolean)</a>
  452. </div>
  453. <div>
  454. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_GetTextFormatterBoundsSize">View.GetTextFormatterBoundsSize()</a>
  455. </div>
  456. <div>
  457. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_GetBoundsTextFormatterSize">View.GetBoundsTextFormatterSize()</a>
  458. </div>
  459. <div>
  460. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnMouseEnter_Terminal_Gui_MouseEvent_">View.OnMouseEnter(MouseEvent)</a>
  461. </div>
  462. <div>
  463. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnMouseLeave_Terminal_Gui_MouseEvent_">View.OnMouseLeave(MouseEvent)</a>
  464. </div>
  465. <div>
  466. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnMouseEvent_Terminal_Gui_MouseEvent_">View.OnMouseEvent(MouseEvent)</a>
  467. </div>
  468. <div>
  469. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnMouseClick_Terminal_Gui_View_MouseEventArgs_">View.OnMouseClick(View.MouseEventArgs)</a>
  470. </div>
  471. <div>
  472. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnCanFocusChanged">View.OnCanFocusChanged()</a>
  473. </div>
  474. <div>
  475. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnEnabledChanged">View.OnEnabledChanged()</a>
  476. </div>
  477. <div>
  478. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnVisibleChanged">View.OnVisibleChanged()</a>
  479. </div>
  480. <div>
  481. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Dispose_System_Boolean_">View.Dispose(Boolean)</a>
  482. </div>
  483. <div>
  484. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_BeginInit">View.BeginInit()</a>
  485. </div>
  486. <div>
  487. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_EndInit">View.EndInit()</a>
  488. </div>
  489. <div>
  490. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SetWidth_System_Int32_System_Int32__">View.SetWidth(Int32, Int32)</a>
  491. </div>
  492. <div>
  493. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SetHeight_System_Int32_System_Int32__">View.SetHeight(Int32, Int32)</a>
  494. </div>
  495. <div>
  496. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_GetCurrentWidth_System_Int32__">View.GetCurrentWidth(Int32)</a>
  497. </div>
  498. <div>
  499. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_GetCurrentHeight_System_Int32__">View.GetCurrentHeight(Int32)</a>
  500. </div>
  501. <div>
  502. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_GetNormalColor">View.GetNormalColor()</a>
  503. </div>
  504. <div>
  505. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_GetTopSuperView">View.GetTopSuperView()</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. <span class="xref">System.Object.Equals(System.Object)</span>
  512. </div>
  513. <div>
  514. <span class="xref">System.Object.Equals(System.Object, System.Object)</span>
  515. </div>
  516. <div>
  517. <span class="xref">System.Object.GetHashCode()</span>
  518. </div>
  519. <div>
  520. <span class="xref">System.Object.GetType()</span>
  521. </div>
  522. <div>
  523. <span class="xref">System.Object.MemberwiseClone()</span>
  524. </div>
  525. <div>
  526. <span class="xref">System.Object.ReferenceEquals(System.Object, System.Object)</span>
  527. </div>
  528. </div>
  529. <h6><strong>Namespace</strong>: <a class="xref" href="Terminal.Gui.html">Terminal.Gui</a></h6>
  530. <h6><strong>Assembly</strong>: Terminal.Gui.dll</h6>
  531. <h5 id="Terminal_Gui_Button_syntax">Syntax</h5>
  532. <div class="codewrapper">
  533. <pre><code class="lang-csharp hljs">public class Button : View, IDisposable, ISupportInitializeNotification, ISupportInitialize</code></pre>
  534. </div>
  535. <h3 id="constructors">Constructors
  536. </h3>
  537. <span class="small pull-right mobile-hide">
  538. <span class="divider">|</span>
  539. <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/apidoc/new?filename=Terminal_Gui_Button__ctor.md&amp;value=---%0Auid%3A%20Terminal.Gui.Button.%23ctor%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
  540. </span>
  541. <span class="small pull-right mobile-hide">
  542. <a href="tig:tig/gui.cs/blob/main/Terminal.Gui/Views/Button.cs/#L47">View Source</a>
  543. </span>
  544. <a id="Terminal_Gui_Button__ctor_" data-uid="Terminal.Gui.Button.#ctor*"></a>
  545. <h4 id="Terminal_Gui_Button__ctor" data-uid="Terminal.Gui.Button.#ctor">Button()</h4>
  546. <div class="markdown level1 summary">
  547. 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.
  548. </div>
  549. <div class="markdown level1 conceptual"></div>
  550. <h5 class="decalaration">Declaration</h5>
  551. <div class="codewrapper">
  552. <pre><code class="lang-csharp hljs">public Button()</code></pre>
  553. </div>
  554. <span class="small pull-right mobile-hide">
  555. <span class="divider">|</span>
  556. <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/apidoc/new?filename=Terminal_Gui_Button__ctor_NStack_ustring_System_Boolean_.md&amp;value=---%0Auid%3A%20Terminal.Gui.Button.%23ctor(NStack.ustring%2CSystem.Boolean)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
  557. </span>
  558. <span class="small pull-right mobile-hide">
  559. <a href="tig:tig/gui.cs/blob/main/Terminal.Gui/Views/Button.cs/#L61">View Source</a>
  560. </span>
  561. <a id="Terminal_Gui_Button__ctor_" data-uid="Terminal.Gui.Button.#ctor*"></a>
  562. <h4 id="Terminal_Gui_Button__ctor_NStack_ustring_System_Boolean_" data-uid="Terminal.Gui.Button.#ctor(NStack.ustring,System.Boolean)">Button(ustring, Boolean)</h4>
  563. <div class="markdown level1 summary">
  564. 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.
  565. </div>
  566. <div class="markdown level1 conceptual"></div>
  567. <h5 class="decalaration">Declaration</h5>
  568. <div class="codewrapper">
  569. <pre><code class="lang-csharp hljs">public Button(ustring text, bool is_default = false)</code></pre>
  570. </div>
  571. <h5 class="parameters">Parameters</h5>
  572. <table class="table table-bordered table-striped table-condensed">
  573. <thead>
  574. <tr>
  575. <th>Type</th>
  576. <th>Name</th>
  577. <th>Description</th>
  578. </tr>
  579. </thead>
  580. <tbody>
  581. <tr>
  582. <td><span class="xref">NStack.ustring</span></td>
  583. <td><span class="parametername">text</span></td>
  584. <td>The button&apos;s text</td>
  585. </tr>
  586. <tr>
  587. <td><span class="xref">System.Boolean</span></td>
  588. <td><span class="parametername">is_default</span></td>
  589. <td>
  590. If <code>true</code>, a special decoration is used, and the user pressing the enter key
  591. in a <a class="xref" href="Terminal.Gui.Dialog.html">Dialog</a> will implicitly activate this button.
  592. </td>
  593. </tr>
  594. </tbody>
  595. </table>
  596. <span class="small pull-right mobile-hide">
  597. <span class="divider">|</span>
  598. <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/apidoc/new?filename=Terminal_Gui_Button__ctor_System_Int32_System_Int32_NStack_ustring_.md&amp;value=---%0Auid%3A%20Terminal.Gui.Button.%23ctor(System.Int32%2CSystem.Int32%2CNStack.ustring)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
  599. </span>
  600. <span class="small pull-right mobile-hide">
  601. <a href="tig:tig/gui.cs/blob/main/Terminal.Gui/Views/Button.cs/#L76">View Source</a>
  602. </span>
  603. <a id="Terminal_Gui_Button__ctor_" data-uid="Terminal.Gui.Button.#ctor*"></a>
  604. <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>
  605. <div class="markdown level1 summary">
  606. 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
  607. </div>
  608. <div class="markdown level1 conceptual"></div>
  609. <h5 class="decalaration">Declaration</h5>
  610. <div class="codewrapper">
  611. <pre><code class="lang-csharp hljs">public Button(int x, int y, ustring text)</code></pre>
  612. </div>
  613. <h5 class="parameters">Parameters</h5>
  614. <table class="table table-bordered table-striped table-condensed">
  615. <thead>
  616. <tr>
  617. <th>Type</th>
  618. <th>Name</th>
  619. <th>Description</th>
  620. </tr>
  621. </thead>
  622. <tbody>
  623. <tr>
  624. <td><span class="xref">System.Int32</span></td>
  625. <td><span class="parametername">x</span></td>
  626. <td>X position where the button will be shown.</td>
  627. </tr>
  628. <tr>
  629. <td><span class="xref">System.Int32</span></td>
  630. <td><span class="parametername">y</span></td>
  631. <td>Y position where the button will be shown.</td>
  632. </tr>
  633. <tr>
  634. <td><span class="xref">NStack.ustring</span></td>
  635. <td><span class="parametername">text</span></td>
  636. <td>The button&apos;s text</td>
  637. </tr>
  638. </tbody>
  639. </table>
  640. <span class="small pull-right mobile-hide">
  641. <span class="divider">|</span>
  642. <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/apidoc/new?filename=Terminal_Gui_Button__ctor_System_Int32_System_Int32_NStack_ustring_System_Boolean_.md&amp;value=---%0Auid%3A%20Terminal.Gui.Button.%23ctor(System.Int32%2CSystem.Int32%2CNStack.ustring%2CSystem.Boolean)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
  643. </span>
  644. <span class="small pull-right mobile-hide">
  645. <a href="tig:tig/gui.cs/blob/main/Terminal.Gui/Views/Button.cs/#L92">View Source</a>
  646. </span>
  647. <a id="Terminal_Gui_Button__ctor_" data-uid="Terminal.Gui.Button.#ctor*"></a>
  648. <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>
  649. <div class="markdown level1 summary">
  650. 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.
  651. </div>
  652. <div class="markdown level1 conceptual"></div>
  653. <h5 class="decalaration">Declaration</h5>
  654. <div class="codewrapper">
  655. <pre><code class="lang-csharp hljs">public Button(int x, int y, ustring text, bool is_default)</code></pre>
  656. </div>
  657. <h5 class="parameters">Parameters</h5>
  658. <table class="table table-bordered table-striped table-condensed">
  659. <thead>
  660. <tr>
  661. <th>Type</th>
  662. <th>Name</th>
  663. <th>Description</th>
  664. </tr>
  665. </thead>
  666. <tbody>
  667. <tr>
  668. <td><span class="xref">System.Int32</span></td>
  669. <td><span class="parametername">x</span></td>
  670. <td>X position where the button will be shown.</td>
  671. </tr>
  672. <tr>
  673. <td><span class="xref">System.Int32</span></td>
  674. <td><span class="parametername">y</span></td>
  675. <td>Y position where the button will be shown.</td>
  676. </tr>
  677. <tr>
  678. <td><span class="xref">NStack.ustring</span></td>
  679. <td><span class="parametername">text</span></td>
  680. <td>The button&apos;s text</td>
  681. </tr>
  682. <tr>
  683. <td><span class="xref">System.Boolean</span></td>
  684. <td><span class="parametername">is_default</span></td>
  685. <td>
  686. If <code>true</code>, a special decoration is used, and the user pressing the enter key
  687. in a <a class="xref" href="Terminal.Gui.Dialog.html">Dialog</a> will implicitly activate this button.
  688. </td>
  689. </tr>
  690. </tbody>
  691. </table>
  692. <h3 id="properties">Properties
  693. </h3>
  694. <span class="small pull-right mobile-hide">
  695. <span class="divider">|</span>
  696. <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/apidoc/new?filename=Terminal_Gui_Button_HotKey.md&amp;value=---%0Auid%3A%20Terminal.Gui.Button.HotKey%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
  697. </span>
  698. <span class="small pull-right mobile-hide">
  699. <a href="tig:tig/gui.cs/blob/main/Terminal.Gui/Views/Button.cs/#L142">View Source</a>
  700. </span>
  701. <a id="Terminal_Gui_Button_HotKey_" data-uid="Terminal.Gui.Button.HotKey*"></a>
  702. <h4 id="Terminal_Gui_Button_HotKey" data-uid="Terminal.Gui.Button.HotKey">HotKey</h4>
  703. <div class="markdown level1 summary"></div>
  704. <div class="markdown level1 conceptual"></div>
  705. <h5 class="decalaration">Declaration</h5>
  706. <div class="codewrapper">
  707. <pre><code class="lang-csharp hljs">public override Key HotKey { get; set; }</code></pre>
  708. </div>
  709. <h5 class="propertyValue">Property Value</h5>
  710. <table class="table table-bordered table-striped table-condensed">
  711. <thead>
  712. <tr>
  713. <th>Type</th>
  714. <th>Description</th>
  715. </tr>
  716. </thead>
  717. <tbody>
  718. <tr>
  719. <td><a class="xref" href="Terminal.Gui.Key.html">Key</a></td>
  720. <td></td>
  721. </tr>
  722. </tbody>
  723. </table>
  724. <h5 class="overrides">Overrides</h5>
  725. <div><a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_HotKey">View.HotKey</a></div>
  726. <span class="small pull-right mobile-hide">
  727. <span class="divider">|</span>
  728. <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/apidoc/new?filename=Terminal_Gui_Button_IsDefault.md&amp;value=---%0Auid%3A%20Terminal.Gui.Button.IsDefault%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
  729. </span>
  730. <span class="small pull-right mobile-hide">
  731. <a href="tig:tig/gui.cs/blob/main/Terminal.Gui/Views/Button.cs/#L132">View Source</a>
  732. </span>
  733. <a id="Terminal_Gui_Button_IsDefault_" data-uid="Terminal.Gui.Button.IsDefault*"></a>
  734. <h4 id="Terminal_Gui_Button_IsDefault" data-uid="Terminal.Gui.Button.IsDefault">IsDefault</h4>
  735. <div class="markdown level1 summary">
  736. Gets or sets whether the <a class="xref" href="Terminal.Gui.Button.html">Button</a> is the default action to activate in a dialog.
  737. </div>
  738. <div class="markdown level1 conceptual"></div>
  739. <h5 class="decalaration">Declaration</h5>
  740. <div class="codewrapper">
  741. <pre><code class="lang-csharp hljs">public bool IsDefault { get; set; }</code></pre>
  742. </div>
  743. <h5 class="propertyValue">Property Value</h5>
  744. <table class="table table-bordered table-striped table-condensed">
  745. <thead>
  746. <tr>
  747. <th>Type</th>
  748. <th>Description</th>
  749. </tr>
  750. </thead>
  751. <tbody>
  752. <tr>
  753. <td><span class="xref">System.Boolean</span></td>
  754. <td><code>true</code> if is default; otherwise, <code>false</code>.</td>
  755. </tr>
  756. </tbody>
  757. </table>
  758. <h3 id="methods">Methods
  759. </h3>
  760. <span class="small pull-right mobile-hide">
  761. <span class="divider">|</span>
  762. <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/apidoc/new?filename=Terminal_Gui_Button_MouseEvent_Terminal_Gui_MouseEvent_.md&amp;value=---%0Auid%3A%20Terminal.Gui.Button.MouseEvent(Terminal.Gui.MouseEvent)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
  763. </span>
  764. <span class="small pull-right mobile-hide">
  765. <a href="tig:tig/gui.cs/blob/main/Terminal.Gui/Views/Button.cs/#L249">View Source</a>
  766. </span>
  767. <a id="Terminal_Gui_Button_MouseEvent_" data-uid="Terminal.Gui.Button.MouseEvent*"></a>
  768. <h4 id="Terminal_Gui_Button_MouseEvent_Terminal_Gui_MouseEvent_" data-uid="Terminal.Gui.Button.MouseEvent(Terminal.Gui.MouseEvent)">MouseEvent(MouseEvent)</h4>
  769. <div class="markdown level1 summary"></div>
  770. <div class="markdown level1 conceptual"></div>
  771. <h5 class="decalaration">Declaration</h5>
  772. <div class="codewrapper">
  773. <pre><code class="lang-csharp hljs">public override bool MouseEvent(MouseEvent me)</code></pre>
  774. </div>
  775. <h5 class="parameters">Parameters</h5>
  776. <table class="table table-bordered table-striped table-condensed">
  777. <thead>
  778. <tr>
  779. <th>Type</th>
  780. <th>Name</th>
  781. <th>Description</th>
  782. </tr>
  783. </thead>
  784. <tbody>
  785. <tr>
  786. <td><a class="xref" href="Terminal.Gui.MouseEvent.html">MouseEvent</a></td>
  787. <td><span class="parametername">me</span></td>
  788. <td></td>
  789. </tr>
  790. </tbody>
  791. </table>
  792. <h5 class="returns">Returns</h5>
  793. <table class="table table-bordered table-striped table-condensed">
  794. <thead>
  795. <tr>
  796. <th>Type</th>
  797. <th>Description</th>
  798. </tr>
  799. </thead>
  800. <tbody>
  801. <tr>
  802. <td><span class="xref">System.Boolean</span></td>
  803. <td></td>
  804. </tr>
  805. </tbody>
  806. </table>
  807. <h5 class="overrides">Overrides</h5>
  808. <div><a class="xref" href="Terminal.Gui.Responder.html#Terminal_Gui_Responder_MouseEvent_Terminal_Gui_MouseEvent_">Responder.MouseEvent(MouseEvent)</a></div>
  809. <span class="small pull-right mobile-hide">
  810. <span class="divider">|</span>
  811. <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/apidoc/new?filename=Terminal_Gui_Button_OnClicked.md&amp;value=---%0Auid%3A%20Terminal.Gui.Button.OnClicked%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
  812. </span>
  813. <span class="small pull-right mobile-hide">
  814. <a href="tig:tig/gui.cs/blob/main/Terminal.Gui/Views/Button.cs/#L232">View Source</a>
  815. </span>
  816. <a id="Terminal_Gui_Button_OnClicked_" data-uid="Terminal.Gui.Button.OnClicked*"></a>
  817. <h4 id="Terminal_Gui_Button_OnClicked" data-uid="Terminal.Gui.Button.OnClicked">OnClicked()</h4>
  818. <div class="markdown level1 summary">
  819. Virtual method to invoke the <a class="xref" href="Terminal.Gui.Button.html#Terminal_Gui_Button_Clicked">Clicked</a> event.
  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 virtual void OnClicked()</code></pre>
  825. </div>
  826. <span class="small pull-right mobile-hide">
  827. <span class="divider">|</span>
  828. <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/apidoc/new?filename=Terminal_Gui_Button_OnEnter_Terminal_Gui_View_.md&amp;value=---%0Auid%3A%20Terminal.Gui.Button.OnEnter(Terminal.Gui.View)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
  829. </span>
  830. <span class="small pull-right mobile-hide">
  831. <a href="tig:tig/gui.cs/blob/main/Terminal.Gui/Views/Button.cs/#L282">View Source</a>
  832. </span>
  833. <a id="Terminal_Gui_Button_OnEnter_" data-uid="Terminal.Gui.Button.OnEnter*"></a>
  834. <h4 id="Terminal_Gui_Button_OnEnter_Terminal_Gui_View_" data-uid="Terminal.Gui.Button.OnEnter(Terminal.Gui.View)">OnEnter(View)</h4>
  835. <div class="markdown level1 summary"></div>
  836. <div class="markdown level1 conceptual"></div>
  837. <h5 class="decalaration">Declaration</h5>
  838. <div class="codewrapper">
  839. <pre><code class="lang-csharp hljs">public override bool OnEnter(View view)</code></pre>
  840. </div>
  841. <h5 class="parameters">Parameters</h5>
  842. <table class="table table-bordered table-striped table-condensed">
  843. <thead>
  844. <tr>
  845. <th>Type</th>
  846. <th>Name</th>
  847. <th>Description</th>
  848. </tr>
  849. </thead>
  850. <tbody>
  851. <tr>
  852. <td><a class="xref" href="Terminal.Gui.View.html">View</a></td>
  853. <td><span class="parametername">view</span></td>
  854. <td></td>
  855. </tr>
  856. </tbody>
  857. </table>
  858. <h5 class="returns">Returns</h5>
  859. <table class="table table-bordered table-striped table-condensed">
  860. <thead>
  861. <tr>
  862. <th>Type</th>
  863. <th>Description</th>
  864. </tr>
  865. </thead>
  866. <tbody>
  867. <tr>
  868. <td><span class="xref">System.Boolean</span></td>
  869. <td></td>
  870. </tr>
  871. </tbody>
  872. </table>
  873. <h5 class="overrides">Overrides</h5>
  874. <div><a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnEnter_Terminal_Gui_View_">View.OnEnter(View)</a></div>
  875. <span class="small pull-right mobile-hide">
  876. <span class="divider">|</span>
  877. <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/apidoc/new?filename=Terminal_Gui_Button_PositionCursor.md&amp;value=---%0Auid%3A%20Terminal.Gui.Button.PositionCursor%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
  878. </span>
  879. <span class="small pull-right mobile-hide">
  880. <a href="tig:tig/gui.cs/blob/main/Terminal.Gui/Views/Button.cs/#L268">View Source</a>
  881. </span>
  882. <a id="Terminal_Gui_Button_PositionCursor_" data-uid="Terminal.Gui.Button.PositionCursor*"></a>
  883. <h4 id="Terminal_Gui_Button_PositionCursor" data-uid="Terminal.Gui.Button.PositionCursor">PositionCursor()</h4>
  884. <div class="markdown level1 summary"></div>
  885. <div class="markdown level1 conceptual"></div>
  886. <h5 class="decalaration">Declaration</h5>
  887. <div class="codewrapper">
  888. <pre><code class="lang-csharp hljs">public override void PositionCursor()</code></pre>
  889. </div>
  890. <h5 class="overrides">Overrides</h5>
  891. <div><a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_PositionCursor">View.PositionCursor()</a></div>
  892. <span class="small pull-right mobile-hide">
  893. <span class="divider">|</span>
  894. <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/apidoc/new?filename=Terminal_Gui_Button_ProcessColdKey_Terminal_Gui_KeyEvent_.md&amp;value=---%0Auid%3A%20Terminal.Gui.Button.ProcessColdKey(Terminal.Gui.KeyEvent)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
  895. </span>
  896. <span class="small pull-right mobile-hide">
  897. <a href="tig:tig/gui.cs/blob/main/Terminal.Gui/Views/Button.cs/#L181">View Source</a>
  898. </span>
  899. <a id="Terminal_Gui_Button_ProcessColdKey_" data-uid="Terminal.Gui.Button.ProcessColdKey*"></a>
  900. <h4 id="Terminal_Gui_Button_ProcessColdKey_Terminal_Gui_KeyEvent_" data-uid="Terminal.Gui.Button.ProcessColdKey(Terminal.Gui.KeyEvent)">ProcessColdKey(KeyEvent)</h4>
  901. <div class="markdown level1 summary"></div>
  902. <div class="markdown level1 conceptual"></div>
  903. <h5 class="decalaration">Declaration</h5>
  904. <div class="codewrapper">
  905. <pre><code class="lang-csharp hljs">public override bool ProcessColdKey(KeyEvent kb)</code></pre>
  906. </div>
  907. <h5 class="parameters">Parameters</h5>
  908. <table class="table table-bordered table-striped table-condensed">
  909. <thead>
  910. <tr>
  911. <th>Type</th>
  912. <th>Name</th>
  913. <th>Description</th>
  914. </tr>
  915. </thead>
  916. <tbody>
  917. <tr>
  918. <td><a class="xref" href="Terminal.Gui.KeyEvent.html">KeyEvent</a></td>
  919. <td><span class="parametername">kb</span></td>
  920. <td></td>
  921. </tr>
  922. </tbody>
  923. </table>
  924. <h5 class="returns">Returns</h5>
  925. <table class="table table-bordered table-striped table-condensed">
  926. <thead>
  927. <tr>
  928. <th>Type</th>
  929. <th>Description</th>
  930. </tr>
  931. </thead>
  932. <tbody>
  933. <tr>
  934. <td><span class="xref">System.Boolean</span></td>
  935. <td></td>
  936. </tr>
  937. </tbody>
  938. </table>
  939. <h5 class="overrides">Overrides</h5>
  940. <div><a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ProcessColdKey_Terminal_Gui_KeyEvent_">View.ProcessColdKey(KeyEvent)</a></div>
  941. <span class="small pull-right mobile-hide">
  942. <span class="divider">|</span>
  943. <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/apidoc/new?filename=Terminal_Gui_Button_ProcessHotKey_Terminal_Gui_KeyEvent_.md&amp;value=---%0Auid%3A%20Terminal.Gui.Button.ProcessHotKey(Terminal.Gui.KeyEvent)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
  944. </span>
  945. <span class="small pull-right mobile-hide">
  946. <a href="tig:tig/gui.cs/blob/main/Terminal.Gui/Views/Button.cs/#L171">View Source</a>
  947. </span>
  948. <a id="Terminal_Gui_Button_ProcessHotKey_" data-uid="Terminal.Gui.Button.ProcessHotKey*"></a>
  949. <h4 id="Terminal_Gui_Button_ProcessHotKey_Terminal_Gui_KeyEvent_" data-uid="Terminal.Gui.Button.ProcessHotKey(Terminal.Gui.KeyEvent)">ProcessHotKey(KeyEvent)</h4>
  950. <div class="markdown level1 summary"></div>
  951. <div class="markdown level1 conceptual"></div>
  952. <h5 class="decalaration">Declaration</h5>
  953. <div class="codewrapper">
  954. <pre><code class="lang-csharp hljs">public override bool ProcessHotKey(KeyEvent kb)</code></pre>
  955. </div>
  956. <h5 class="parameters">Parameters</h5>
  957. <table class="table table-bordered table-striped table-condensed">
  958. <thead>
  959. <tr>
  960. <th>Type</th>
  961. <th>Name</th>
  962. <th>Description</th>
  963. </tr>
  964. </thead>
  965. <tbody>
  966. <tr>
  967. <td><a class="xref" href="Terminal.Gui.KeyEvent.html">KeyEvent</a></td>
  968. <td><span class="parametername">kb</span></td>
  969. <td></td>
  970. </tr>
  971. </tbody>
  972. </table>
  973. <h5 class="returns">Returns</h5>
  974. <table class="table table-bordered table-striped table-condensed">
  975. <thead>
  976. <tr>
  977. <th>Type</th>
  978. <th>Description</th>
  979. </tr>
  980. </thead>
  981. <tbody>
  982. <tr>
  983. <td><span class="xref">System.Boolean</span></td>
  984. <td></td>
  985. </tr>
  986. </tbody>
  987. </table>
  988. <h5 class="overrides">Overrides</h5>
  989. <div><a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ProcessHotKey_Terminal_Gui_KeyEvent_">View.ProcessHotKey(KeyEvent)</a></div>
  990. <span class="small pull-right mobile-hide">
  991. <span class="divider">|</span>
  992. <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/apidoc/new?filename=Terminal_Gui_Button_ProcessKey_Terminal_Gui_KeyEvent_.md&amp;value=---%0Auid%3A%20Terminal.Gui.Button.ProcessKey(Terminal.Gui.KeyEvent)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
  993. </span>
  994. <span class="small pull-right mobile-hide">
  995. <a href="tig:tig/gui.cs/blob/main/Terminal.Gui/Views/Button.cs/#L191">View Source</a>
  996. </span>
  997. <a id="Terminal_Gui_Button_ProcessKey_" data-uid="Terminal.Gui.Button.ProcessKey*"></a>
  998. <h4 id="Terminal_Gui_Button_ProcessKey_Terminal_Gui_KeyEvent_" data-uid="Terminal.Gui.Button.ProcessKey(Terminal.Gui.KeyEvent)">ProcessKey(KeyEvent)</h4>
  999. <div class="markdown level1 summary"></div>
  1000. <div class="markdown level1 conceptual"></div>
  1001. <h5 class="decalaration">Declaration</h5>
  1002. <div class="codewrapper">
  1003. <pre><code class="lang-csharp hljs">public override bool ProcessKey(KeyEvent kb)</code></pre>
  1004. </div>
  1005. <h5 class="parameters">Parameters</h5>
  1006. <table class="table table-bordered table-striped table-condensed">
  1007. <thead>
  1008. <tr>
  1009. <th>Type</th>
  1010. <th>Name</th>
  1011. <th>Description</th>
  1012. </tr>
  1013. </thead>
  1014. <tbody>
  1015. <tr>
  1016. <td><a class="xref" href="Terminal.Gui.KeyEvent.html">KeyEvent</a></td>
  1017. <td><span class="parametername">kb</span></td>
  1018. <td></td>
  1019. </tr>
  1020. </tbody>
  1021. </table>
  1022. <h5 class="returns">Returns</h5>
  1023. <table class="table table-bordered table-striped table-condensed">
  1024. <thead>
  1025. <tr>
  1026. <th>Type</th>
  1027. <th>Description</th>
  1028. </tr>
  1029. </thead>
  1030. <tbody>
  1031. <tr>
  1032. <td><span class="xref">System.Boolean</span></td>
  1033. <td></td>
  1034. </tr>
  1035. </tbody>
  1036. </table>
  1037. <h5 class="overrides">Overrides</h5>
  1038. <div><a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ProcessKey_Terminal_Gui_KeyEvent_">View.ProcessKey(KeyEvent)</a></div>
  1039. <span class="small pull-right mobile-hide">
  1040. <span class="divider">|</span>
  1041. <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/apidoc/new?filename=Terminal_Gui_Button_UpdateTextFormatterText.md&amp;value=---%0Auid%3A%20Terminal.Gui.Button.UpdateTextFormatterText%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
  1042. </span>
  1043. <span class="small pull-right mobile-hide">
  1044. <a href="tig:tig/gui.cs/blob/main/Terminal.Gui/Views/Button.cs/#L162">View Source</a>
  1045. </span>
  1046. <a id="Terminal_Gui_Button_UpdateTextFormatterText_" data-uid="Terminal.Gui.Button.UpdateTextFormatterText*"></a>
  1047. <h4 id="Terminal_Gui_Button_UpdateTextFormatterText" data-uid="Terminal.Gui.Button.UpdateTextFormatterText">UpdateTextFormatterText()</h4>
  1048. <div class="markdown level1 summary"></div>
  1049. <div class="markdown level1 conceptual"></div>
  1050. <h5 class="decalaration">Declaration</h5>
  1051. <div class="codewrapper">
  1052. <pre><code class="lang-csharp hljs">protected override void UpdateTextFormatterText()</code></pre>
  1053. </div>
  1054. <h5 class="overrides">Overrides</h5>
  1055. <div><a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_UpdateTextFormatterText">View.UpdateTextFormatterText()</a></div>
  1056. <h3 id="events">Events
  1057. </h3>
  1058. <span class="small pull-right mobile-hide">
  1059. <span class="divider">|</span>
  1060. <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/apidoc/new?filename=Terminal_Gui_Button_Clicked.md&amp;value=---%0Auid%3A%20Terminal.Gui.Button.Clicked%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
  1061. </span>
  1062. <span class="small pull-right mobile-hide">
  1063. <a href="tig:tig/gui.cs/blob/main/Terminal.Gui/Views/Button.cs/#L246">View Source</a>
  1064. </span>
  1065. <h4 id="Terminal_Gui_Button_Clicked" data-uid="Terminal.Gui.Button.Clicked">Clicked</h4>
  1066. <div class="markdown level1 summary">
  1067. 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>
  1068. or if the user presses the action key while this view is focused. (TODO: IsDefault)
  1069. </div>
  1070. <div class="markdown level1 conceptual"></div>
  1071. <h5 class="decalaration">Declaration</h5>
  1072. <div class="codewrapper">
  1073. <pre><code class="lang-csharp hljs">public event Action Clicked</code></pre>
  1074. </div>
  1075. <h5 class="eventType">Event Type</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.Action</span></td>
  1086. <td></td>
  1087. </tr>
  1088. </tbody>
  1089. </table>
  1090. <h3 id="implements">Implements</h3>
  1091. <div>
  1092. <span class="xref">System.IDisposable</span>
  1093. </div>
  1094. <div>
  1095. <span class="xref">System.ComponentModel.ISupportInitializeNotification</span>
  1096. </div>
  1097. <div>
  1098. <span class="xref">System.ComponentModel.ISupportInitialize</span>
  1099. </div>
  1100. </article>
  1101. </div>
  1102. <div class="hidden-sm col-md-2" role="complementary">
  1103. <div class="sideaffix">
  1104. <div class="contribution">
  1105. <ul class="nav">
  1106. <li>
  1107. <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/apidoc/new?filename=Terminal_Gui_Button.md&amp;value=---%0Auid%3A%20Terminal.Gui.Button%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A" class="contribution-link">Improve this Doc</a>
  1108. </li>
  1109. <li>
  1110. <a href="tig:tig/gui.cs/blob/main/Terminal.Gui/Views/Button.cs/#L33" class="contribution-link">View Source</a>
  1111. </li>
  1112. </ul>
  1113. </div>
  1114. <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
  1115. <h5>In This Article</h5>
  1116. <div></div>
  1117. </nav>
  1118. </div>
  1119. </div>
  1120. </div>
  1121. </div>
  1122. <footer>
  1123. <div class="grad-bottom"></div>
  1124. <div class="footer">
  1125. <div class="container">
  1126. <span class="pull-right">
  1127. <a href="#top">Back to top</a>
  1128. </span>
  1129. <span>Generated by <strong>DocFX</strong></span>
  1130. </div>
  1131. </div>
  1132. </footer>
  1133. </div>
  1134. <script type="text/javascript" src="../../styles/docfx.vendor.js"></script>
  1135. <script type="text/javascript" src="../../styles/docfx.js"></script>
  1136. <script type="text/javascript" src="../../styles/main.js"></script>
  1137. </body>
  1138. </html>