Terminal.Gui.Button.html 60 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212
  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. <link rel="shortcut icon" href="../../favicon.ico">
  13. <link rel="stylesheet" href="../../styles/docfx.vendor.min.css">
  14. <link rel="stylesheet" href="../../styles/docfx.css">
  15. <link rel="stylesheet" href="../../styles/main.css">
  16. <meta property="docfx:navrel" content="../../toc.html">
  17. <meta property="docfx:tocrel" content="toc.html">
  18. <meta property="docfx:rel" content="../../">
  19. </head>
  20. <body data-spy="scroll" data-target="#affix" data-offset="120">
  21. <div id="wrapper">
  22. <header>
  23. <nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation">
  24. <div class="container">
  25. <div class="navbar-header">
  26. <button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
  27. <span class="sr-only">Toggle navigation</span>
  28. <span class="icon-bar"></span>
  29. <span class="icon-bar"></span>
  30. <span class="icon-bar"></span>
  31. </button>
  32. <a class="navbar-brand" href="../../index.html">
  33. <img id="logo" class="svg" src="../../images/logo48.png" alt="">
  34. </a>
  35. </div>
  36. <div class="collapse navbar-collapse" id="navbar">
  37. <form class="navbar-form navbar-right" role="search" id="search">
  38. <div class="form-group">
  39. <input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">
  40. </div>
  41. </form>
  42. </div>
  43. </div>
  44. </nav>
  45. <div class="subnav navbar navbar-default">
  46. <div class="container hide-when-search" id="breadcrumb">
  47. <ul class="breadcrumb">
  48. <li></li>
  49. </ul>
  50. </div>
  51. </div>
  52. </header>
  53. <div class="container body-content">
  54. <div id="search-results">
  55. <div class="search-list">Search Results for <span></span></div>
  56. <div class="sr-items">
  57. <p><i class="glyphicon glyphicon-refresh index-loading"></i></p>
  58. </div>
  59. <ul id="pagination" data-first="First" data-prev="Previous" data-next="Next" data-last="Last"></ul>
  60. </div>
  61. </div>
  62. <div role="main" class="container body-content hide-when-search">
  63. <div class="sidenav hide-when-search">
  64. <a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
  65. <div class="sidetoggle collapse" id="sidetoggle">
  66. <div id="sidetoc"></div>
  67. </div>
  68. </div>
  69. <div class="article row grid-right">
  70. <div class="col-md-10">
  71. <article class="content wrap" id="_content" data-uid="Terminal.Gui.Button">
  72. <h1 id="Terminal_Gui_Button" data-uid="Terminal.Gui.Button" class="text-break">Class Button
  73. </h1>
  74. <div class="markdown level0 summary">Button is a <a class="xref" href="Terminal.Gui.View.html">View</a> that provides an item that invokes an <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.action">Action</a> when activated by the user.</div>
  75. <div class="markdown level0 conceptual"></div>
  76. <div class="inheritance">
  77. <h5>Inheritance</h5>
  78. <div class="level0"><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a></div>
  79. <div class="level1"><a class="xref" href="Terminal.Gui.Responder.html">Responder</a></div>
  80. <div class="level2"><a class="xref" href="Terminal.Gui.View.html">View</a></div>
  81. <div class="level3"><span class="xref">Button</span></div>
  82. </div>
  83. <div class="implements">
  84. <h5>Implements</h5>
  85. <div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.idisposable">IDisposable</a></div>
  86. <div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.componentmodel.isupportinitializenotification">ISupportInitializeNotification</a></div>
  87. <div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.componentmodel.isupportinitialize">ISupportInitialize</a></div>
  88. </div>
  89. <div class="inheritedMembers">
  90. <h5>Inherited Members</h5>
  91. <div>
  92. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Added">View.Added</a>
  93. </div>
  94. <div>
  95. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Removed">View.Removed</a>
  96. </div>
  97. <div>
  98. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Enter">View.Enter</a>
  99. </div>
  100. <div>
  101. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Leave">View.Leave</a>
  102. </div>
  103. <div>
  104. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_MouseEnter">View.MouseEnter</a>
  105. </div>
  106. <div>
  107. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_MouseLeave">View.MouseLeave</a>
  108. </div>
  109. <div>
  110. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_MouseClick">View.MouseClick</a>
  111. </div>
  112. <div>
  113. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_CanFocusChanged">View.CanFocusChanged</a>
  114. </div>
  115. <div>
  116. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_EnabledChanged">View.EnabledChanged</a>
  117. </div>
  118. <div>
  119. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_VisibleChanged">View.VisibleChanged</a>
  120. </div>
  121. <div>
  122. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_HotKeyChanged">View.HotKeyChanged</a>
  123. </div>
  124. <div>
  125. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_HotKeySpecifier">View.HotKeySpecifier</a>
  126. </div>
  127. <div>
  128. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Shortcut">View.Shortcut</a>
  129. </div>
  130. <div>
  131. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ShortcutTag">View.ShortcutTag</a>
  132. </div>
  133. <div>
  134. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ShortcutAction">View.ShortcutAction</a>
  135. </div>
  136. <div>
  137. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Data">View.Data</a>
  138. </div>
  139. <div>
  140. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Driver">View.Driver</a>
  141. </div>
  142. <div>
  143. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Subviews">View.Subviews</a>
  144. </div>
  145. <div>
  146. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_TabIndexes">View.TabIndexes</a>
  147. </div>
  148. <div>
  149. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_TabIndex">View.TabIndex</a>
  150. </div>
  151. <div>
  152. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_TabStop">View.TabStop</a>
  153. </div>
  154. <div>
  155. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_CanFocus">View.CanFocus</a>
  156. </div>
  157. <div>
  158. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Id">View.Id</a>
  159. </div>
  160. <div>
  161. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_IsCurrentTop">View.IsCurrentTop</a>
  162. </div>
  163. <div>
  164. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_WantMousePositionReports">View.WantMousePositionReports</a>
  165. </div>
  166. <div>
  167. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_WantContinuousButtonPressed">View.WantContinuousButtonPressed</a>
  168. </div>
  169. <div>
  170. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Frame">View.Frame</a>
  171. </div>
  172. <div>
  173. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_LayoutStyle">View.LayoutStyle</a>
  174. </div>
  175. <div>
  176. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Bounds">View.Bounds</a>
  177. </div>
  178. <div>
  179. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_X">View.X</a>
  180. </div>
  181. <div>
  182. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Y">View.Y</a>
  183. </div>
  184. <div>
  185. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Width">View.Width</a>
  186. </div>
  187. <div>
  188. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Height">View.Height</a>
  189. </div>
  190. <div>
  191. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ForceValidatePosDim">View.ForceValidatePosDim</a>
  192. </div>
  193. <div>
  194. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_GetMinWidthHeight_Terminal_Gui_Size__">View.GetMinWidthHeight(out Size)</a>
  195. </div>
  196. <div>
  197. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SetMinWidthHeight">View.SetMinWidthHeight()</a>
  198. </div>
  199. <div>
  200. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_TextFormatter">View.TextFormatter</a>
  201. </div>
  202. <div>
  203. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SuperView">View.SuperView</a>
  204. </div>
  205. <div>
  206. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ProcessResizeView">View.ProcessResizeView()</a>
  207. </div>
  208. <div>
  209. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SetNeedsDisplay">View.SetNeedsDisplay()</a>
  210. </div>
  211. <div>
  212. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ClearLayoutNeeded">View.ClearLayoutNeeded()</a>
  213. </div>
  214. <div>
  215. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SetNeedsDisplay_Terminal_Gui_Rect_">View.SetNeedsDisplay(Rect)</a>
  216. </div>
  217. <div>
  218. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SetChildNeedsDisplay">View.SetChildNeedsDisplay()</a>
  219. </div>
  220. <div>
  221. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Add_Terminal_Gui_View_">View.Add(View)</a>
  222. </div>
  223. <div>
  224. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Add_Terminal_Gui_View___">View.Add(params View[])</a>
  225. </div>
  226. <div>
  227. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_RemoveAll">View.RemoveAll()</a>
  228. </div>
  229. <div>
  230. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Remove_Terminal_Gui_View_">View.Remove(View)</a>
  231. </div>
  232. <div>
  233. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_BringSubviewToFront_Terminal_Gui_View_">View.BringSubviewToFront(View)</a>
  234. </div>
  235. <div>
  236. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SendSubviewToBack_Terminal_Gui_View_">View.SendSubviewToBack(View)</a>
  237. </div>
  238. <div>
  239. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SendSubviewBackwards_Terminal_Gui_View_">View.SendSubviewBackwards(View)</a>
  240. </div>
  241. <div>
  242. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_BringSubviewForward_Terminal_Gui_View_">View.BringSubviewForward(View)</a>
  243. </div>
  244. <div>
  245. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Clear">View.Clear()</a>
  246. </div>
  247. <div>
  248. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Clear_Terminal_Gui_Rect_">View.Clear(Rect)</a>
  249. </div>
  250. <div>
  251. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ScreenToView_System_Int32_System_Int32_">View.ScreenToView(int, int)</a>
  252. </div>
  253. <div>
  254. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ClipToBounds">View.ClipToBounds()</a>
  255. </div>
  256. <div>
  257. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SetClip_Terminal_Gui_Rect_">View.SetClip(Rect)</a>
  258. </div>
  259. <div>
  260. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_DrawFrame_Terminal_Gui_Rect_System_Int32_System_Boolean_">View.DrawFrame(Rect, int, bool)</a>
  261. </div>
  262. <div>
  263. <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>
  264. </div>
  265. <div>
  266. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_DrawHotString_NStack_ustring_System_Boolean_Terminal_Gui_ColorScheme_">View.DrawHotString(ustring, bool, ColorScheme)</a>
  267. </div>
  268. <div>
  269. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Move_System_Int32_System_Int32_System_Boolean_">View.Move(int, int, bool)</a>
  270. </div>
  271. <div>
  272. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_HasFocus">View.HasFocus</a>
  273. </div>
  274. <div>
  275. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnAdded_Terminal_Gui_View_">View.OnAdded(View)</a>
  276. </div>
  277. <div>
  278. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnRemoved_Terminal_Gui_View_">View.OnRemoved(View)</a>
  279. </div>
  280. <div>
  281. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnLeave_Terminal_Gui_View_">View.OnLeave(View)</a>
  282. </div>
  283. <div>
  284. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Focused">View.Focused</a>
  285. </div>
  286. <div>
  287. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_MostFocused">View.MostFocused</a>
  288. </div>
  289. <div>
  290. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ColorScheme">View.ColorScheme</a>
  291. </div>
  292. <div>
  293. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_AddRune_System_Int32_System_Int32_System_Rune_">View.AddRune(int, int, Rune)</a>
  294. </div>
  295. <div>
  296. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ClearNeedsDisplay">View.ClearNeedsDisplay()</a>
  297. </div>
  298. <div>
  299. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Redraw_Terminal_Gui_Rect_">View.Redraw(Rect)</a>
  300. </div>
  301. <div>
  302. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_DrawContent">View.DrawContent</a>
  303. </div>
  304. <div>
  305. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnDrawContent_Terminal_Gui_Rect_">View.OnDrawContent(Rect)</a>
  306. </div>
  307. <div>
  308. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_DrawContentComplete">View.DrawContentComplete</a>
  309. </div>
  310. <div>
  311. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnDrawContentComplete_Terminal_Gui_Rect_">View.OnDrawContentComplete(Rect)</a>
  312. </div>
  313. <div>
  314. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SetFocus">View.SetFocus()</a>
  315. </div>
  316. <div>
  317. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_KeyPress">View.KeyPress</a>
  318. </div>
  319. <div>
  320. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_InvokeKeybindings_Terminal_Gui_KeyEvent_">View.InvokeKeybindings(KeyEvent)</a>
  321. </div>
  322. <div>
  323. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_AddKeyBinding_Terminal_Gui_Key_Terminal_Gui_Command___">View.AddKeyBinding(Key, params Command[])</a>
  324. </div>
  325. <div>
  326. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ReplaceKeyBinding_Terminal_Gui_Key_Terminal_Gui_Key_">View.ReplaceKeyBinding(Key, Key)</a>
  327. </div>
  328. <div>
  329. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ContainsKeyBinding_Terminal_Gui_Key_">View.ContainsKeyBinding(Key)</a>
  330. </div>
  331. <div>
  332. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ClearKeybindings">View.ClearKeybindings()</a>
  333. </div>
  334. <div>
  335. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ClearKeybinding_Terminal_Gui_Key_">View.ClearKeybinding(Key)</a>
  336. </div>
  337. <div>
  338. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ClearKeybinding_Terminal_Gui_Command___">View.ClearKeybinding(params Command[])</a>
  339. </div>
  340. <div>
  341. <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;bool?&gt;)</a>
  342. </div>
  343. <div>
  344. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_GetSupportedCommands">View.GetSupportedCommands()</a>
  345. </div>
  346. <div>
  347. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_GetKeyFromCommand_Terminal_Gui_Command___">View.GetKeyFromCommand(params Command[])</a>
  348. </div>
  349. <div>
  350. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_KeyDown">View.KeyDown</a>
  351. </div>
  352. <div>
  353. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnKeyDown_Terminal_Gui_KeyEvent_">View.OnKeyDown(KeyEvent)</a>
  354. </div>
  355. <div>
  356. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_KeyUp">View.KeyUp</a>
  357. </div>
  358. <div>
  359. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnKeyUp_Terminal_Gui_KeyEvent_">View.OnKeyUp(KeyEvent)</a>
  360. </div>
  361. <div>
  362. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_EnsureFocus">View.EnsureFocus()</a>
  363. </div>
  364. <div>
  365. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_FocusFirst">View.FocusFirst()</a>
  366. </div>
  367. <div>
  368. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_FocusLast">View.FocusLast()</a>
  369. </div>
  370. <div>
  371. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_FocusPrev">View.FocusPrev()</a>
  372. </div>
  373. <div>
  374. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_FocusNext">View.FocusNext()</a>
  375. </div>
  376. <div>
  377. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_LayoutStarted">View.LayoutStarted</a>
  378. </div>
  379. <div>
  380. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_LayoutComplete">View.LayoutComplete</a>
  381. </div>
  382. <div>
  383. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Initialized">View.Initialized</a>
  384. </div>
  385. <div>
  386. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_LayoutSubviews">View.LayoutSubviews()</a>
  387. </div>
  388. <div>
  389. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Text">View.Text</a>
  390. </div>
  391. <div>
  392. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_AutoSize">View.AutoSize</a>
  393. </div>
  394. <div>
  395. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_PreserveTrailingSpaces">View.PreserveTrailingSpaces</a>
  396. </div>
  397. <div>
  398. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_TextAlignment">View.TextAlignment</a>
  399. </div>
  400. <div>
  401. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_VerticalTextAlignment">View.VerticalTextAlignment</a>
  402. </div>
  403. <div>
  404. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_TextDirection">View.TextDirection</a>
  405. </div>
  406. <div>
  407. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_IsInitialized">View.IsInitialized</a>
  408. </div>
  409. <div>
  410. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_IsAdded">View.IsAdded</a>
  411. </div>
  412. <div>
  413. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Enabled">View.Enabled</a>
  414. </div>
  415. <div>
  416. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ClearOnVisibleFalse">View.ClearOnVisibleFalse</a>
  417. </div>
  418. <div>
  419. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Visible">View.Visible</a>
  420. </div>
  421. <div>
  422. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Border">View.Border</a>
  423. </div>
  424. <div>
  425. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_IgnoreBorderPropertyOnRedraw">View.IgnoreBorderPropertyOnRedraw</a>
  426. </div>
  427. <div>
  428. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ToString">View.ToString()</a>
  429. </div>
  430. <div>
  431. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_GetAutoSize">View.GetAutoSize()</a>
  432. </div>
  433. <div>
  434. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_GetHotKeySpecifierLength_System_Boolean_">View.GetHotKeySpecifierLength(bool)</a>
  435. </div>
  436. <div>
  437. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_GetTextFormatterBoundsSize">View.GetTextFormatterBoundsSize()</a>
  438. </div>
  439. <div>
  440. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_GetBoundsTextFormatterSize">View.GetBoundsTextFormatterSize()</a>
  441. </div>
  442. <div>
  443. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnMouseEnter_Terminal_Gui_MouseEvent_">View.OnMouseEnter(MouseEvent)</a>
  444. </div>
  445. <div>
  446. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnMouseLeave_Terminal_Gui_MouseEvent_">View.OnMouseLeave(MouseEvent)</a>
  447. </div>
  448. <div>
  449. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnMouseEvent_Terminal_Gui_MouseEvent_">View.OnMouseEvent(MouseEvent)</a>
  450. </div>
  451. <div>
  452. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnMouseClick_Terminal_Gui_View_MouseEventArgs_">View.OnMouseClick(View.MouseEventArgs)</a>
  453. </div>
  454. <div>
  455. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnCanFocusChanged">View.OnCanFocusChanged()</a>
  456. </div>
  457. <div>
  458. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnEnabledChanged">View.OnEnabledChanged()</a>
  459. </div>
  460. <div>
  461. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnVisibleChanged">View.OnVisibleChanged()</a>
  462. </div>
  463. <div>
  464. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Dispose_System_Boolean_">View.Dispose(bool)</a>
  465. </div>
  466. <div>
  467. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_BeginInit">View.BeginInit()</a>
  468. </div>
  469. <div>
  470. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_EndInit">View.EndInit()</a>
  471. </div>
  472. <div>
  473. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SetWidth_System_Int32_System_Int32__">View.SetWidth(int, out int)</a>
  474. </div>
  475. <div>
  476. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SetHeight_System_Int32_System_Int32__">View.SetHeight(int, out int)</a>
  477. </div>
  478. <div>
  479. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_GetCurrentWidth_System_Int32__">View.GetCurrentWidth(out int)</a>
  480. </div>
  481. <div>
  482. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_GetCurrentHeight_System_Int32__">View.GetCurrentHeight(out int)</a>
  483. </div>
  484. <div>
  485. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_GetNormalColor">View.GetNormalColor()</a>
  486. </div>
  487. <div>
  488. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_GetFocusColor">View.GetFocusColor()</a>
  489. </div>
  490. <div>
  491. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_GetHotNormalColor">View.GetHotNormalColor()</a>
  492. </div>
  493. <div>
  494. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_GetTopSuperView">View.GetTopSuperView()</a>
  495. </div>
  496. <div>
  497. <a class="xref" href="Terminal.Gui.Responder.html#Terminal_Gui_Responder_Dispose">Responder.Dispose()</a>
  498. </div>
  499. <div>
  500. <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)">object.Equals(object)</a>
  501. </div>
  502. <div>
  503. <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)">object.Equals(object, object)</a>
  504. </div>
  505. <div>
  506. <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.gethashcode">object.GetHashCode()</a>
  507. </div>
  508. <div>
  509. <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.gettype">object.GetType()</a>
  510. </div>
  511. <div>
  512. <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone">object.MemberwiseClone()</a>
  513. </div>
  514. <div>
  515. <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.referenceequals">object.ReferenceEquals(object, object)</a>
  516. </div>
  517. </div>
  518. <h6><strong>Namespace</strong>: <a class="xref" href="Terminal.html">Terminal</a>.<a class="xref" href="Terminal.Gui.html">Gui</a></h6>
  519. <h6><strong>Assembly</strong>: Terminal.Gui.dll</h6>
  520. <h5 id="Terminal_Gui_Button_syntax">Syntax</h5>
  521. <div class="codewrapper">
  522. <pre><code class="lang-csharp hljs">public class Button : View, IDisposable, ISupportInitializeNotification, ISupportInitialize</code></pre>
  523. </div>
  524. <h5 id="Terminal_Gui_Button_remarks"><strong>Remarks</strong></h5>
  525. <div class="markdown level0 remarks"><p>
  526. Provides a button showing text invokes an <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.action">Action</a> when clicked on with a mouse
  527. or when the user presses SPACE, ENTER, or hotkey. The hotkey is the first letter or digit following the first underscore ('_')
  528. in the button text.
  529. </p>
  530. <p>
  531. Use <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_HotKeySpecifier">HotKeySpecifier</a> to change the hotkey specifier from the default of ('_').
  532. </p>
  533. <p>
  534. If no hotkey specifier is found, the first uppercase letter encountered will be used as the hotkey.
  535. </p>
  536. <p>
  537. 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
  538. 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>'s
  539. <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.action">Action</a> will be invoked.
  540. </p></div>
  541. <h3 id="constructors">Constructors
  542. </h3>
  543. <span class="small pull-right mobile-hide">
  544. <span class="divider">|</span>
  545. <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/docfx/overrides/new?filename=Terminal_Gui_Button__ctor.md&amp;value=---%0Auid%3A%20Terminal.Gui.Button.%23ctor%0Asummary%3A%20&#39;*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax&#39;%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Edit this page</a>
  546. </span>
  547. <span class="small pull-right mobile-hide">
  548. <a href="tig:tig/Terminal.Gui/blob/v2_develop/Terminal.Gui/Views/Button.cs/#L47">View Source</a>
  549. </span>
  550. <a id="Terminal_Gui_Button__ctor_" data-uid="Terminal.Gui.Button.#ctor*"></a>
  551. <h4 id="Terminal_Gui_Button__ctor" data-uid="Terminal.Gui.Button.#ctor">Button()</h4>
  552. <div class="markdown level1 summary">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.</div>
  553. <div class="markdown level1 conceptual"></div>
  554. <h5 class="declaration">Declaration</h5>
  555. <div class="codewrapper">
  556. <pre><code class="lang-csharp hljs">public Button()</code></pre>
  557. </div>
  558. <h5 id="Terminal_Gui_Button__ctor_remarks">Remarks</h5>
  559. <div class="markdown level1 remarks">The width of the <a class="xref" href="Terminal.Gui.Button.html">Button</a> is computed based on the
  560. text length. The height will always be 1.</div>
  561. <span class="small pull-right mobile-hide">
  562. <span class="divider">|</span>
  563. <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/docfx/overrides/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&#39;*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax&#39;%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Edit this page</a>
  564. </span>
  565. <span class="small pull-right mobile-hide">
  566. <a href="tig:tig/Terminal.Gui/blob/v2_develop/Terminal.Gui/Views/Button.cs/#L61">View Source</a>
  567. </span>
  568. <a id="Terminal_Gui_Button__ctor_" data-uid="Terminal.Gui.Button.#ctor*"></a>
  569. <h4 id="Terminal_Gui_Button__ctor_NStack_ustring_System_Boolean_" data-uid="Terminal.Gui.Button.#ctor(NStack.ustring,System.Boolean)">Button(ustring, bool)</h4>
  570. <div class="markdown level1 summary">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.</div>
  571. <div class="markdown level1 conceptual"></div>
  572. <h5 class="declaration">Declaration</h5>
  573. <div class="codewrapper">
  574. <pre><code class="lang-csharp hljs">public Button(ustring text, bool is_default = false)</code></pre>
  575. </div>
  576. <h5 class="parameters">Parameters</h5>
  577. <table class="table table-bordered table-condensed">
  578. <thead>
  579. <tr>
  580. <th>Type</th>
  581. <th>Name</th>
  582. <th>Description</th>
  583. </tr>
  584. </thead>
  585. <tbody>
  586. <tr>
  587. <td><span class="xref">ustring</span></td>
  588. <td><span class="parametername">text</span></td>
  589. <td>The button's text</td>
  590. </tr>
  591. <tr>
  592. <td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></td>
  593. <td><span class="parametername">is_default</span></td>
  594. <td>If <code>true</code>, a special decoration is used, and the user pressing the enter key
  595. in a <a class="xref" href="Terminal.Gui.Dialog.html">Dialog</a> will implicitly activate this button.</td>
  596. </tr>
  597. </tbody>
  598. </table>
  599. <h5 id="Terminal_Gui_Button__ctor_NStack_ustring_System_Boolean__remarks">Remarks</h5>
  600. <div class="markdown level1 remarks">The width of the <a class="xref" href="Terminal.Gui.Button.html">Button</a> is computed based on the
  601. text length. The height will always be 1.</div>
  602. <span class="small pull-right mobile-hide">
  603. <span class="divider">|</span>
  604. <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/docfx/overrides/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&#39;*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax&#39;%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Edit this page</a>
  605. </span>
  606. <span class="small pull-right mobile-hide">
  607. <a href="tig:tig/Terminal.Gui/blob/v2_develop/Terminal.Gui/Views/Button.cs/#L76">View Source</a>
  608. </span>
  609. <a id="Terminal_Gui_Button__ctor_" data-uid="Terminal.Gui.Button.#ctor*"></a>
  610. <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(int, int, ustring)</h4>
  611. <div class="markdown level1 summary">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</div>
  612. <div class="markdown level1 conceptual"></div>
  613. <h5 class="declaration">Declaration</h5>
  614. <div class="codewrapper">
  615. <pre><code class="lang-csharp hljs">public Button(int x, int y, ustring text)</code></pre>
  616. </div>
  617. <h5 class="parameters">Parameters</h5>
  618. <table class="table table-bordered table-condensed">
  619. <thead>
  620. <tr>
  621. <th>Type</th>
  622. <th>Name</th>
  623. <th>Description</th>
  624. </tr>
  625. </thead>
  626. <tbody>
  627. <tr>
  628. <td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></td>
  629. <td><span class="parametername">x</span></td>
  630. <td>X position where the button will be shown.</td>
  631. </tr>
  632. <tr>
  633. <td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></td>
  634. <td><span class="parametername">y</span></td>
  635. <td>Y position where the button will be shown.</td>
  636. </tr>
  637. <tr>
  638. <td><span class="xref">ustring</span></td>
  639. <td><span class="parametername">text</span></td>
  640. <td>The button's text</td>
  641. </tr>
  642. </tbody>
  643. </table>
  644. <h5 id="Terminal_Gui_Button__ctor_System_Int32_System_Int32_NStack_ustring__remarks">Remarks</h5>
  645. <div class="markdown level1 remarks">The width of the <a class="xref" href="Terminal.Gui.Button.html">Button</a> is computed based on the
  646. text length. The height will always be 1.</div>
  647. <span class="small pull-right mobile-hide">
  648. <span class="divider">|</span>
  649. <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/docfx/overrides/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&#39;*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax&#39;%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Edit this page</a>
  650. </span>
  651. <span class="small pull-right mobile-hide">
  652. <a href="tig:tig/Terminal.Gui/blob/v2_develop/Terminal.Gui/Views/Button.cs/#L92">View Source</a>
  653. </span>
  654. <a id="Terminal_Gui_Button__ctor_" data-uid="Terminal.Gui.Button.#ctor*"></a>
  655. <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(int, int, ustring, bool)</h4>
  656. <div class="markdown level1 summary">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.</div>
  657. <div class="markdown level1 conceptual"></div>
  658. <h5 class="declaration">Declaration</h5>
  659. <div class="codewrapper">
  660. <pre><code class="lang-csharp hljs">public Button(int x, int y, ustring text, bool is_default)</code></pre>
  661. </div>
  662. <h5 class="parameters">Parameters</h5>
  663. <table class="table table-bordered table-condensed">
  664. <thead>
  665. <tr>
  666. <th>Type</th>
  667. <th>Name</th>
  668. <th>Description</th>
  669. </tr>
  670. </thead>
  671. <tbody>
  672. <tr>
  673. <td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></td>
  674. <td><span class="parametername">x</span></td>
  675. <td>X position where the button will be shown.</td>
  676. </tr>
  677. <tr>
  678. <td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></td>
  679. <td><span class="parametername">y</span></td>
  680. <td>Y position where the button will be shown.</td>
  681. </tr>
  682. <tr>
  683. <td><span class="xref">ustring</span></td>
  684. <td><span class="parametername">text</span></td>
  685. <td>The button's text</td>
  686. </tr>
  687. <tr>
  688. <td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></td>
  689. <td><span class="parametername">is_default</span></td>
  690. <td>If <code>true</code>, a special decoration is used, and the user pressing the enter key
  691. in a <a class="xref" href="Terminal.Gui.Dialog.html">Dialog</a> will implicitly activate this button.</td>
  692. </tr>
  693. </tbody>
  694. </table>
  695. <h5 id="Terminal_Gui_Button__ctor_System_Int32_System_Int32_NStack_ustring_System_Boolean__remarks">Remarks</h5>
  696. <div class="markdown level1 remarks">The width of the <a class="xref" href="Terminal.Gui.Button.html">Button</a> is computed based on the
  697. text length. The height will always be 1.</div>
  698. <h3 id="properties">Properties
  699. </h3>
  700. <span class="small pull-right mobile-hide">
  701. <span class="divider">|</span>
  702. <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/docfx/overrides/new?filename=Terminal_Gui_Button_HotKey.md&amp;value=---%0Auid%3A%20Terminal.Gui.Button.HotKey%0Asummary%3A%20&#39;*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax&#39;%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Edit this page</a>
  703. </span>
  704. <span class="small pull-right mobile-hide">
  705. <a href="tig:tig/Terminal.Gui/blob/v2_develop/Terminal.Gui/Views/Button.cs/#L142">View Source</a>
  706. </span>
  707. <a id="Terminal_Gui_Button_HotKey_" data-uid="Terminal.Gui.Button.HotKey*"></a>
  708. <h4 id="Terminal_Gui_Button_HotKey" data-uid="Terminal.Gui.Button.HotKey">HotKey</h4>
  709. <div class="markdown level1 summary">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.</div>
  710. <div class="markdown level1 conceptual"></div>
  711. <h5 class="declaration">Declaration</h5>
  712. <div class="codewrapper">
  713. <pre><code class="lang-csharp hljs">public override Key HotKey { get; set; }</code></pre>
  714. </div>
  715. <h5 class="propertyValue">Property Value</h5>
  716. <table class="table table-bordered table-condensed">
  717. <thead>
  718. <tr>
  719. <th>Type</th>
  720. <th>Description</th>
  721. </tr>
  722. </thead>
  723. <tbody>
  724. <tr>
  725. <td><a class="xref" href="Terminal.Gui.Key.html">Key</a></td>
  726. <td></td>
  727. </tr>
  728. </tbody>
  729. </table>
  730. <h5 class="overrides">Overrides</h5>
  731. <div><a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_HotKey">View.HotKey</a></div>
  732. <span class="small pull-right mobile-hide">
  733. <span class="divider">|</span>
  734. <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/docfx/overrides/new?filename=Terminal_Gui_Button_IsDefault.md&amp;value=---%0Auid%3A%20Terminal.Gui.Button.IsDefault%0Asummary%3A%20&#39;*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax&#39;%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Edit this page</a>
  735. </span>
  736. <span class="small pull-right mobile-hide">
  737. <a href="tig:tig/Terminal.Gui/blob/v2_develop/Terminal.Gui/Views/Button.cs/#L132">View Source</a>
  738. </span>
  739. <a id="Terminal_Gui_Button_IsDefault_" data-uid="Terminal.Gui.Button.IsDefault*"></a>
  740. <h4 id="Terminal_Gui_Button_IsDefault" data-uid="Terminal.Gui.Button.IsDefault">IsDefault</h4>
  741. <div class="markdown level1 summary">Gets or sets whether the <a class="xref" href="Terminal.Gui.Button.html">Button</a> is the default action to activate in a dialog.</div>
  742. <div class="markdown level1 conceptual"></div>
  743. <h5 class="declaration">Declaration</h5>
  744. <div class="codewrapper">
  745. <pre><code class="lang-csharp hljs">public bool IsDefault { get; set; }</code></pre>
  746. </div>
  747. <h5 class="propertyValue">Property Value</h5>
  748. <table class="table table-bordered table-condensed">
  749. <thead>
  750. <tr>
  751. <th>Type</th>
  752. <th>Description</th>
  753. </tr>
  754. </thead>
  755. <tbody>
  756. <tr>
  757. <td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></td>
  758. <td><code>true</code> if is default; otherwise, <code>false</code>.</td>
  759. </tr>
  760. </tbody>
  761. </table>
  762. <h3 id="methods">Methods
  763. </h3>
  764. <span class="small pull-right mobile-hide">
  765. <span class="divider">|</span>
  766. <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/docfx/overrides/new?filename=Terminal_Gui_Button_MouseEvent_Terminal_Gui_MouseEvent_.md&amp;value=---%0Auid%3A%20Terminal.Gui.Button.MouseEvent(Terminal.Gui.MouseEvent)%0Asummary%3A%20&#39;*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax&#39;%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Edit this page</a>
  767. </span>
  768. <span class="small pull-right mobile-hide">
  769. <a href="tig:tig/Terminal.Gui/blob/v2_develop/Terminal.Gui/Views/Button.cs/#L249">View Source</a>
  770. </span>
  771. <a id="Terminal_Gui_Button_MouseEvent_" data-uid="Terminal.Gui.Button.MouseEvent*"></a>
  772. <h4 id="Terminal_Gui_Button_MouseEvent_Terminal_Gui_MouseEvent_" data-uid="Terminal.Gui.Button.MouseEvent(Terminal.Gui.MouseEvent)">MouseEvent(MouseEvent)</h4>
  773. <div class="markdown level1 summary">Method invoked when a mouse event is generated</div>
  774. <div class="markdown level1 conceptual"></div>
  775. <h5 class="declaration">Declaration</h5>
  776. <div class="codewrapper">
  777. <pre><code class="lang-csharp hljs">public override bool MouseEvent(MouseEvent me)</code></pre>
  778. </div>
  779. <h5 class="parameters">Parameters</h5>
  780. <table class="table table-bordered table-condensed">
  781. <thead>
  782. <tr>
  783. <th>Type</th>
  784. <th>Name</th>
  785. <th>Description</th>
  786. </tr>
  787. </thead>
  788. <tbody>
  789. <tr>
  790. <td><a class="xref" href="Terminal.Gui.MouseEvent.html">MouseEvent</a></td>
  791. <td><span class="parametername">me</span></td>
  792. <td></td>
  793. </tr>
  794. </tbody>
  795. </table>
  796. <h5 class="returns">Returns</h5>
  797. <table class="table table-bordered table-condensed">
  798. <thead>
  799. <tr>
  800. <th>Type</th>
  801. <th>Description</th>
  802. </tr>
  803. </thead>
  804. <tbody>
  805. <tr>
  806. <td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></td>
  807. <td><code>true</code>, if the event was handled, <code>false</code> otherwise.</td>
  808. </tr>
  809. </tbody>
  810. </table>
  811. <h5 class="overrides">Overrides</h5>
  812. <div><a class="xref" href="Terminal.Gui.Responder.html#Terminal_Gui_Responder_MouseEvent_Terminal_Gui_MouseEvent_">Responder.MouseEvent(MouseEvent)</a></div>
  813. <span class="small pull-right mobile-hide">
  814. <span class="divider">|</span>
  815. <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/docfx/overrides/new?filename=Terminal_Gui_Button_OnClicked.md&amp;value=---%0Auid%3A%20Terminal.Gui.Button.OnClicked%0Asummary%3A%20&#39;*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax&#39;%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Edit this page</a>
  816. </span>
  817. <span class="small pull-right mobile-hide">
  818. <a href="tig:tig/Terminal.Gui/blob/v2_develop/Terminal.Gui/Views/Button.cs/#L232">View Source</a>
  819. </span>
  820. <a id="Terminal_Gui_Button_OnClicked_" data-uid="Terminal.Gui.Button.OnClicked*"></a>
  821. <h4 id="Terminal_Gui_Button_OnClicked" data-uid="Terminal.Gui.Button.OnClicked">OnClicked()</h4>
  822. <div class="markdown level1 summary">Virtual method to invoke the <a class="xref" href="Terminal.Gui.Button.html#Terminal_Gui_Button_Clicked">Clicked</a> event.</div>
  823. <div class="markdown level1 conceptual"></div>
  824. <h5 class="declaration">Declaration</h5>
  825. <div class="codewrapper">
  826. <pre><code class="lang-csharp hljs">public virtual void OnClicked()</code></pre>
  827. </div>
  828. <span class="small pull-right mobile-hide">
  829. <span class="divider">|</span>
  830. <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/docfx/overrides/new?filename=Terminal_Gui_Button_OnEnter_Terminal_Gui_View_.md&amp;value=---%0Auid%3A%20Terminal.Gui.Button.OnEnter(Terminal.Gui.View)%0Asummary%3A%20&#39;*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax&#39;%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Edit this page</a>
  831. </span>
  832. <span class="small pull-right mobile-hide">
  833. <a href="tig:tig/Terminal.Gui/blob/v2_develop/Terminal.Gui/Views/Button.cs/#L281">View Source</a>
  834. </span>
  835. <a id="Terminal_Gui_Button_OnEnter_" data-uid="Terminal.Gui.Button.OnEnter*"></a>
  836. <h4 id="Terminal_Gui_Button_OnEnter_Terminal_Gui_View_" data-uid="Terminal.Gui.Button.OnEnter(Terminal.Gui.View)">OnEnter(View)</h4>
  837. <div class="markdown level1 summary">Method invoked when a view gets focus.</div>
  838. <div class="markdown level1 conceptual"></div>
  839. <h5 class="declaration">Declaration</h5>
  840. <div class="codewrapper">
  841. <pre><code class="lang-csharp hljs">public override bool OnEnter(View view)</code></pre>
  842. </div>
  843. <h5 class="parameters">Parameters</h5>
  844. <table class="table table-bordered table-condensed">
  845. <thead>
  846. <tr>
  847. <th>Type</th>
  848. <th>Name</th>
  849. <th>Description</th>
  850. </tr>
  851. </thead>
  852. <tbody>
  853. <tr>
  854. <td><a class="xref" href="Terminal.Gui.View.html">View</a></td>
  855. <td><span class="parametername">view</span></td>
  856. <td>The view that is losing focus.</td>
  857. </tr>
  858. </tbody>
  859. </table>
  860. <h5 class="returns">Returns</h5>
  861. <table class="table table-bordered table-condensed">
  862. <thead>
  863. <tr>
  864. <th>Type</th>
  865. <th>Description</th>
  866. </tr>
  867. </thead>
  868. <tbody>
  869. <tr>
  870. <td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></td>
  871. <td><code>true</code>, if the event was handled, <code>false</code> otherwise.</td>
  872. </tr>
  873. </tbody>
  874. </table>
  875. <h5 class="overrides">Overrides</h5>
  876. <div><a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnEnter_Terminal_Gui_View_">View.OnEnter(View)</a></div>
  877. <span class="small pull-right mobile-hide">
  878. <span class="divider">|</span>
  879. <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/docfx/overrides/new?filename=Terminal_Gui_Button_PositionCursor.md&amp;value=---%0Auid%3A%20Terminal.Gui.Button.PositionCursor%0Asummary%3A%20&#39;*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax&#39;%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Edit this page</a>
  880. </span>
  881. <span class="small pull-right mobile-hide">
  882. <a href="tig:tig/Terminal.Gui/blob/v2_develop/Terminal.Gui/Views/Button.cs/#L267">View Source</a>
  883. </span>
  884. <a id="Terminal_Gui_Button_PositionCursor_" data-uid="Terminal.Gui.Button.PositionCursor*"></a>
  885. <h4 id="Terminal_Gui_Button_PositionCursor" data-uid="Terminal.Gui.Button.PositionCursor">PositionCursor()</h4>
  886. <div class="markdown level1 summary">Positions the cursor in the right position based on the currently focused view in the chain.</div>
  887. <div class="markdown level1 conceptual"></div>
  888. <h5 class="declaration">Declaration</h5>
  889. <div class="codewrapper">
  890. <pre><code class="lang-csharp hljs">public override void PositionCursor()</code></pre>
  891. </div>
  892. <h5 class="overrides">Overrides</h5>
  893. <div><a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_PositionCursor">View.PositionCursor()</a></div>
  894. <span class="small pull-right mobile-hide">
  895. <span class="divider">|</span>
  896. <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/docfx/overrides/new?filename=Terminal_Gui_Button_ProcessColdKey_Terminal_Gui_KeyEvent_.md&amp;value=---%0Auid%3A%20Terminal.Gui.Button.ProcessColdKey(Terminal.Gui.KeyEvent)%0Asummary%3A%20&#39;*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax&#39;%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Edit this page</a>
  897. </span>
  898. <span class="small pull-right mobile-hide">
  899. <a href="tig:tig/Terminal.Gui/blob/v2_develop/Terminal.Gui/Views/Button.cs/#L181">View Source</a>
  900. </span>
  901. <a id="Terminal_Gui_Button_ProcessColdKey_" data-uid="Terminal.Gui.Button.ProcessColdKey*"></a>
  902. <h4 id="Terminal_Gui_Button_ProcessColdKey_Terminal_Gui_KeyEvent_" data-uid="Terminal.Gui.Button.ProcessColdKey(Terminal.Gui.KeyEvent)">ProcessColdKey(KeyEvent)</h4>
  903. <div class="markdown level1 summary">This method can be overwritten by views that
  904. want to provide accelerator functionality
  905. (Alt-key for example), but without
  906. interefering with normal ProcessKey behavior.</div>
  907. <div class="markdown level1 conceptual"></div>
  908. <h5 class="declaration">Declaration</h5>
  909. <div class="codewrapper">
  910. <pre><code class="lang-csharp hljs">public override bool ProcessColdKey(KeyEvent kb)</code></pre>
  911. </div>
  912. <h5 class="parameters">Parameters</h5>
  913. <table class="table table-bordered table-condensed">
  914. <thead>
  915. <tr>
  916. <th>Type</th>
  917. <th>Name</th>
  918. <th>Description</th>
  919. </tr>
  920. </thead>
  921. <tbody>
  922. <tr>
  923. <td><a class="xref" href="Terminal.Gui.KeyEvent.html">KeyEvent</a></td>
  924. <td><span class="parametername">kb</span></td>
  925. <td></td>
  926. </tr>
  927. </tbody>
  928. </table>
  929. <h5 class="returns">Returns</h5>
  930. <table class="table table-bordered table-condensed">
  931. <thead>
  932. <tr>
  933. <th>Type</th>
  934. <th>Description</th>
  935. </tr>
  936. </thead>
  937. <tbody>
  938. <tr>
  939. <td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></td>
  940. <td></td>
  941. </tr>
  942. </tbody>
  943. </table>
  944. <h5 class="overrides">Overrides</h5>
  945. <div><a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ProcessColdKey_Terminal_Gui_KeyEvent_">View.ProcessColdKey(KeyEvent)</a></div>
  946. <h5 id="Terminal_Gui_Button_ProcessColdKey_Terminal_Gui_KeyEvent__remarks">Remarks</h5>
  947. <div class="markdown level1 remarks"><p>
  948. After keys are sent to the subviews on the
  949. current view, all the view are
  950. processed and the key is passed to the views
  951. to allow some of them to process the keystroke
  952. as a cold-key. </p>
  953. <p>
  954. This functionality is used, for example, by
  955. default buttons to act on the enter key.
  956. Processing this as a hot-key would prevent
  957. non-default buttons from consuming the enter
  958. keypress when they have the focus.
  959. </p></div>
  960. <span class="small pull-right mobile-hide">
  961. <span class="divider">|</span>
  962. <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/docfx/overrides/new?filename=Terminal_Gui_Button_ProcessHotKey_Terminal_Gui_KeyEvent_.md&amp;value=---%0Auid%3A%20Terminal.Gui.Button.ProcessHotKey(Terminal.Gui.KeyEvent)%0Asummary%3A%20&#39;*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax&#39;%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Edit this page</a>
  963. </span>
  964. <span class="small pull-right mobile-hide">
  965. <a href="tig:tig/Terminal.Gui/blob/v2_develop/Terminal.Gui/Views/Button.cs/#L171">View Source</a>
  966. </span>
  967. <a id="Terminal_Gui_Button_ProcessHotKey_" data-uid="Terminal.Gui.Button.ProcessHotKey*"></a>
  968. <h4 id="Terminal_Gui_Button_ProcessHotKey_Terminal_Gui_KeyEvent_" data-uid="Terminal.Gui.Button.ProcessHotKey(Terminal.Gui.KeyEvent)">ProcessHotKey(KeyEvent)</h4>
  969. <div class="markdown level1 summary">This method can be overwritten by view that
  970. want to provide accelerator functionality
  971. (Alt-key for example).</div>
  972. <div class="markdown level1 conceptual"></div>
  973. <h5 class="declaration">Declaration</h5>
  974. <div class="codewrapper">
  975. <pre><code class="lang-csharp hljs">public override bool ProcessHotKey(KeyEvent kb)</code></pre>
  976. </div>
  977. <h5 class="parameters">Parameters</h5>
  978. <table class="table table-bordered table-condensed">
  979. <thead>
  980. <tr>
  981. <th>Type</th>
  982. <th>Name</th>
  983. <th>Description</th>
  984. </tr>
  985. </thead>
  986. <tbody>
  987. <tr>
  988. <td><a class="xref" href="Terminal.Gui.KeyEvent.html">KeyEvent</a></td>
  989. <td><span class="parametername">kb</span></td>
  990. <td></td>
  991. </tr>
  992. </tbody>
  993. </table>
  994. <h5 class="returns">Returns</h5>
  995. <table class="table table-bordered table-condensed">
  996. <thead>
  997. <tr>
  998. <th>Type</th>
  999. <th>Description</th>
  1000. </tr>
  1001. </thead>
  1002. <tbody>
  1003. <tr>
  1004. <td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></td>
  1005. <td></td>
  1006. </tr>
  1007. </tbody>
  1008. </table>
  1009. <h5 class="overrides">Overrides</h5>
  1010. <div><a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ProcessHotKey_Terminal_Gui_KeyEvent_">View.ProcessHotKey(KeyEvent)</a></div>
  1011. <h5 id="Terminal_Gui_Button_ProcessHotKey_Terminal_Gui_KeyEvent__remarks">Remarks</h5>
  1012. <div class="markdown level1 remarks"><p>
  1013. Before keys are sent to the subview on the
  1014. current view, all the views are
  1015. processed and the key is passed to the widgets
  1016. to allow some of them to process the keystroke
  1017. as a hot-key. </p>
  1018. <p>
  1019. For example, if you implement a button that
  1020. has a hotkey ok "o", you would catch the
  1021. combination Alt-o here. If the event is
  1022. caught, you must return true to stop the
  1023. keystroke from being dispatched to other
  1024. views.
  1025. </p></div>
  1026. <span class="small pull-right mobile-hide">
  1027. <span class="divider">|</span>
  1028. <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/docfx/overrides/new?filename=Terminal_Gui_Button_ProcessKey_Terminal_Gui_KeyEvent_.md&amp;value=---%0Auid%3A%20Terminal.Gui.Button.ProcessKey(Terminal.Gui.KeyEvent)%0Asummary%3A%20&#39;*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax&#39;%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Edit this page</a>
  1029. </span>
  1030. <span class="small pull-right mobile-hide">
  1031. <a href="tig:tig/Terminal.Gui/blob/v2_develop/Terminal.Gui/Views/Button.cs/#L191">View Source</a>
  1032. </span>
  1033. <a id="Terminal_Gui_Button_ProcessKey_" data-uid="Terminal.Gui.Button.ProcessKey*"></a>
  1034. <h4 id="Terminal_Gui_Button_ProcessKey_Terminal_Gui_KeyEvent_" data-uid="Terminal.Gui.Button.ProcessKey(Terminal.Gui.KeyEvent)">ProcessKey(KeyEvent)</h4>
  1035. <div class="markdown level1 summary">If the view is focused, gives the view a
  1036. chance to process the keystroke.</div>
  1037. <div class="markdown level1 conceptual"></div>
  1038. <h5 class="declaration">Declaration</h5>
  1039. <div class="codewrapper">
  1040. <pre><code class="lang-csharp hljs">public override bool ProcessKey(KeyEvent kb)</code></pre>
  1041. </div>
  1042. <h5 class="parameters">Parameters</h5>
  1043. <table class="table table-bordered table-condensed">
  1044. <thead>
  1045. <tr>
  1046. <th>Type</th>
  1047. <th>Name</th>
  1048. <th>Description</th>
  1049. </tr>
  1050. </thead>
  1051. <tbody>
  1052. <tr>
  1053. <td><a class="xref" href="Terminal.Gui.KeyEvent.html">KeyEvent</a></td>
  1054. <td><span class="parametername">kb</span></td>
  1055. <td></td>
  1056. </tr>
  1057. </tbody>
  1058. </table>
  1059. <h5 class="returns">Returns</h5>
  1060. <table class="table table-bordered table-condensed">
  1061. <thead>
  1062. <tr>
  1063. <th>Type</th>
  1064. <th>Description</th>
  1065. </tr>
  1066. </thead>
  1067. <tbody>
  1068. <tr>
  1069. <td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></td>
  1070. <td></td>
  1071. </tr>
  1072. </tbody>
  1073. </table>
  1074. <h5 class="overrides">Overrides</h5>
  1075. <div><a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ProcessKey_Terminal_Gui_KeyEvent_">View.ProcessKey(KeyEvent)</a></div>
  1076. <h5 id="Terminal_Gui_Button_ProcessKey_Terminal_Gui_KeyEvent__remarks">Remarks</h5>
  1077. <div class="markdown level1 remarks"><p>
  1078. Views can override this method if they are
  1079. interested in processing the given keystroke.
  1080. If they consume the keystroke, they must
  1081. return true to stop the keystroke from being
  1082. processed by other widgets or consumed by the
  1083. widget engine. If they return false, the
  1084. keystroke will be passed using the ProcessColdKey
  1085. method to other views to process.
  1086. </p>
  1087. <p>
  1088. The View implementation does nothing but return false,
  1089. so it is not necessary to call base.ProcessKey if you
  1090. derive directly from View, but you should if you derive
  1091. other View subclasses.
  1092. </p></div>
  1093. <span class="small pull-right mobile-hide">
  1094. <span class="divider">|</span>
  1095. <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/docfx/overrides/new?filename=Terminal_Gui_Button_UpdateTextFormatterText.md&amp;value=---%0Auid%3A%20Terminal.Gui.Button.UpdateTextFormatterText%0Asummary%3A%20&#39;*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax&#39;%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Edit this page</a>
  1096. </span>
  1097. <span class="small pull-right mobile-hide">
  1098. <a href="tig:tig/Terminal.Gui/blob/v2_develop/Terminal.Gui/Views/Button.cs/#L162">View Source</a>
  1099. </span>
  1100. <a id="Terminal_Gui_Button_UpdateTextFormatterText_" data-uid="Terminal.Gui.Button.UpdateTextFormatterText*"></a>
  1101. <h4 id="Terminal_Gui_Button_UpdateTextFormatterText" data-uid="Terminal.Gui.Button.UpdateTextFormatterText">UpdateTextFormatterText()</h4>
  1102. <div class="markdown level1 summary">Can be overridden if the <a class="xref" href="Terminal.Gui.TextFormatter.html#Terminal_Gui_TextFormatter_Text">Text</a> has
  1103. different format than the default.</div>
  1104. <div class="markdown level1 conceptual"></div>
  1105. <h5 class="declaration">Declaration</h5>
  1106. <div class="codewrapper">
  1107. <pre><code class="lang-csharp hljs">protected override void UpdateTextFormatterText()</code></pre>
  1108. </div>
  1109. <h5 class="overrides">Overrides</h5>
  1110. <div><a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_UpdateTextFormatterText">View.UpdateTextFormatterText()</a></div>
  1111. <h3 id="events">Events
  1112. </h3>
  1113. <span class="small pull-right mobile-hide">
  1114. <span class="divider">|</span>
  1115. <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/docfx/overrides/new?filename=Terminal_Gui_Button_Clicked.md&amp;value=---%0Auid%3A%20Terminal.Gui.Button.Clicked%0Asummary%3A%20&#39;*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax&#39;%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Edit this page</a>
  1116. </span>
  1117. <span class="small pull-right mobile-hide">
  1118. <a href="tig:tig/Terminal.Gui/blob/v2_develop/Terminal.Gui/Views/Button.cs/#L246">View Source</a>
  1119. </span>
  1120. <h4 id="Terminal_Gui_Button_Clicked" data-uid="Terminal.Gui.Button.Clicked">Clicked</h4>
  1121. <div class="markdown level1 summary">Clicked <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.action">Action</a>, raised when the user clicks the primary mouse button within the Bounds of this <a class="xref" href="Terminal.Gui.View.html">View</a>
  1122. or if the user presses the action key while this view is focused. (TODO: IsDefault)</div>
  1123. <div class="markdown level1 conceptual"></div>
  1124. <h5 class="declaration">Declaration</h5>
  1125. <div class="codewrapper">
  1126. <pre><code class="lang-csharp hljs">public event Action Clicked</code></pre>
  1127. </div>
  1128. <h5 class="eventType">Event Type</h5>
  1129. <table class="table table-bordered table-condensed">
  1130. <thead>
  1131. <tr>
  1132. <th>Type</th>
  1133. <th>Description</th>
  1134. </tr>
  1135. </thead>
  1136. <tbody>
  1137. <tr>
  1138. <td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.action">Action</a></td>
  1139. <td></td>
  1140. </tr>
  1141. </tbody>
  1142. </table>
  1143. <h5 id="Terminal_Gui_Button_Clicked_remarks">Remarks</h5>
  1144. <div class="markdown level1 remarks">Client code can hook up to this event, it is
  1145. raised when the button is activated either with
  1146. the mouse or the keyboard.</div>
  1147. <h3 id="implements">Implements</h3>
  1148. <div>
  1149. <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.idisposable">IDisposable</a>
  1150. </div>
  1151. <div>
  1152. <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.componentmodel.isupportinitializenotification">ISupportInitializeNotification</a>
  1153. </div>
  1154. <div>
  1155. <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.componentmodel.isupportinitialize">ISupportInitialize</a>
  1156. </div>
  1157. </article>
  1158. </div>
  1159. <div class="hidden-sm col-md-2" role="complementary">
  1160. <div class="sideaffix">
  1161. <div class="contribution">
  1162. <ul class="nav">
  1163. <li>
  1164. <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/docfx/overrides/new?filename=Terminal_Gui_Button.md&amp;value=---%0Auid%3A%20Terminal.Gui.Button%0Asummary%3A%20&#39;*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax&#39;%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A" class="contribution-link">Edit this page</a>
  1165. </li>
  1166. <li>
  1167. <a href="tig:tig/Terminal.Gui/blob/v2_develop/Terminal.Gui/Views/Button.cs/#L33" class="contribution-link">View Source</a>
  1168. </li>
  1169. </ul>
  1170. </div>
  1171. <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
  1172. <h5>In this article</h5>
  1173. <div></div>
  1174. </nav>
  1175. </div>
  1176. </div>
  1177. </div>
  1178. </div>
  1179. <footer>
  1180. <div class="grad-bottom"></div>
  1181. <div class="footer">
  1182. <div class="container">
  1183. <span class="pull-right">
  1184. <a href="#top">Back to top</a>
  1185. </span>
  1186. <span>Generated by <strong>DocFX</strong></span>
  1187. </div>
  1188. </div>
  1189. </footer>
  1190. </div>
  1191. <script type="text/javascript" src="../../styles/docfx.vendor.min.js"></script>
  1192. <script type="text/javascript" src="../../styles/docfx.js"></script>
  1193. <script type="text/javascript" src="../../styles/main.js"></script>
  1194. </body>
  1195. </html>