Terminal.Gui.Button.html 35 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887
  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.56.1.0">
  13. <link rel="shortcut icon" href="../../favicon.ico">
  14. <link rel="stylesheet" href="../../styles/docfx.vendor.css">
  15. <link rel="stylesheet" href="../../styles/docfx.css">
  16. <link rel="stylesheet" href="../../styles/main.css">
  17. <meta property="docfx:navrel" content="../../toc.html">
  18. <meta property="docfx:tocrel" content="toc.html">
  19. <meta property="docfx:rel" content="../../">
  20. </head>
  21. <body data-spy="scroll" data-target="#affix" data-offset="120">
  22. <div id="wrapper">
  23. <header>
  24. <nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation">
  25. <div class="container">
  26. <div class="navbar-header">
  27. <button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
  28. <span class="sr-only">Toggle navigation</span>
  29. <span class="icon-bar"></span>
  30. <span class="icon-bar"></span>
  31. <span class="icon-bar"></span>
  32. </button>
  33. <a class="navbar-brand" href="../../index.html">
  34. <img id="logo" class="svg" src="../../images/logo48.png" alt="">
  35. </a>
  36. </div>
  37. <div class="collapse navbar-collapse" id="navbar">
  38. <form class="navbar-form navbar-right" role="search" id="search">
  39. <div class="form-group">
  40. <input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">
  41. </div>
  42. </form>
  43. </div>
  44. </div>
  45. </nav>
  46. <div class="subnav navbar navbar-default">
  47. <div class="container hide-when-search" id="breadcrumb">
  48. <ul class="breadcrumb">
  49. <li></li>
  50. </ul>
  51. </div>
  52. </div>
  53. </header>
  54. <div class="container body-content">
  55. <div id="search-results">
  56. <div class="search-list"></div>
  57. <div class="sr-items">
  58. <p><i class="glyphicon glyphicon-refresh index-loading"></i></p>
  59. </div>
  60. <ul id="pagination"></ul>
  61. </div>
  62. </div>
  63. <div role="main" class="container body-content hide-when-search">
  64. <div class="sidenav hide-when-search">
  65. <a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
  66. <div class="sidetoggle collapse" id="sidetoggle">
  67. <div id="sidetoc"></div>
  68. </div>
  69. </div>
  70. <div class="article row grid-right">
  71. <div class="col-md-10">
  72. <article class="content wrap" id="_content" data-uid="Terminal.Gui.Button">
  73. <h1 id="Terminal_Gui_Button" data-uid="Terminal.Gui.Button" class="text-break">Class Button
  74. </h1>
  75. <div class="markdown level0 summary">
  76. 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.
  77. </div>
  78. <div class="markdown level0 conceptual"></div>
  79. <div class="inheritance">
  80. <h5>Inheritance</h5>
  81. <div class="level0"><span class="xref">System.Object</span></div>
  82. <div class="level1"><a class="xref" href="Terminal.Gui.Responder.html">Responder</a></div>
  83. <div class="level2"><a class="xref" href="Terminal.Gui.View.html">View</a></div>
  84. <div class="level3"><span class="xref">Button</span></div>
  85. </div>
  86. <div classs="implements">
  87. <h5>Implements</h5>
  88. <div><span class="xref">System.IDisposable</span></div>
  89. <div><span class="xref">System.Collections.IEnumerable</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. <div class="inheritedMembers">
  94. <h5>Inherited Members</h5>
  95. <div>
  96. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Added">View.Added</a>
  97. </div>
  98. <div>
  99. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Removed">View.Removed</a>
  100. </div>
  101. <div>
  102. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Enter">View.Enter</a>
  103. </div>
  104. <div>
  105. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Leave">View.Leave</a>
  106. </div>
  107. <div>
  108. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_MouseEnter">View.MouseEnter</a>
  109. </div>
  110. <div>
  111. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_MouseLeave">View.MouseLeave</a>
  112. </div>
  113. <div>
  114. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_MouseClick">View.MouseClick</a>
  115. </div>
  116. <div>
  117. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_HotKey">View.HotKey</a>
  118. </div>
  119. <div>
  120. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_HotKeySpecifier">View.HotKeySpecifier</a>
  121. </div>
  122. <div>
  123. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Driver">View.Driver</a>
  124. </div>
  125. <div>
  126. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Subviews">View.Subviews</a>
  127. </div>
  128. <div>
  129. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_TabIndexes">View.TabIndexes</a>
  130. </div>
  131. <div>
  132. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_TabIndex">View.TabIndex</a>
  133. </div>
  134. <div>
  135. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_TabStop">View.TabStop</a>
  136. </div>
  137. <div>
  138. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_CanFocus">View.CanFocus</a>
  139. </div>
  140. <div>
  141. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Id">View.Id</a>
  142. </div>
  143. <div>
  144. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_IsCurrentTop">View.IsCurrentTop</a>
  145. </div>
  146. <div>
  147. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_WantMousePositionReports">View.WantMousePositionReports</a>
  148. </div>
  149. <div>
  150. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_WantContinuousButtonPressed">View.WantContinuousButtonPressed</a>
  151. </div>
  152. <div>
  153. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Frame">View.Frame</a>
  154. </div>
  155. <div>
  156. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_GetEnumerator">View.GetEnumerator()</a>
  157. </div>
  158. <div>
  159. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_LayoutStyle">View.LayoutStyle</a>
  160. </div>
  161. <div>
  162. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Bounds">View.Bounds</a>
  163. </div>
  164. <div>
  165. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_X">View.X</a>
  166. </div>
  167. <div>
  168. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Y">View.Y</a>
  169. </div>
  170. <div>
  171. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Width">View.Width</a>
  172. </div>
  173. <div>
  174. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Height">View.Height</a>
  175. </div>
  176. <div>
  177. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SuperView">View.SuperView</a>
  178. </div>
  179. <div>
  180. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SetNeedsDisplay">View.SetNeedsDisplay()</a>
  181. </div>
  182. <div>
  183. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SetNeedsDisplay_Terminal_Gui_Rect_">View.SetNeedsDisplay(Rect)</a>
  184. </div>
  185. <div>
  186. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ChildNeedsDisplay">View.ChildNeedsDisplay()</a>
  187. </div>
  188. <div>
  189. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Add_Terminal_Gui_View_">View.Add(View)</a>
  190. </div>
  191. <div>
  192. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Add_Terminal_Gui_View___">View.Add(View[])</a>
  193. </div>
  194. <div>
  195. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_RemoveAll">View.RemoveAll()</a>
  196. </div>
  197. <div>
  198. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Remove_Terminal_Gui_View_">View.Remove(View)</a>
  199. </div>
  200. <div>
  201. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_BringSubviewToFront_Terminal_Gui_View_">View.BringSubviewToFront(View)</a>
  202. </div>
  203. <div>
  204. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SendSubviewToBack_Terminal_Gui_View_">View.SendSubviewToBack(View)</a>
  205. </div>
  206. <div>
  207. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SendSubviewBackwards_Terminal_Gui_View_">View.SendSubviewBackwards(View)</a>
  208. </div>
  209. <div>
  210. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_BringSubviewForward_Terminal_Gui_View_">View.BringSubviewForward(View)</a>
  211. </div>
  212. <div>
  213. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Clear">View.Clear()</a>
  214. </div>
  215. <div>
  216. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Clear_Terminal_Gui_Rect_">View.Clear(Rect)</a>
  217. </div>
  218. <div>
  219. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ScreenToView_System_Int32_System_Int32_">View.ScreenToView(Int32, Int32)</a>
  220. </div>
  221. <div>
  222. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ClipToBounds">View.ClipToBounds()</a>
  223. </div>
  224. <div>
  225. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SetClip_Terminal_Gui_Rect_">View.SetClip(Rect)</a>
  226. </div>
  227. <div>
  228. <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>
  229. </div>
  230. <div>
  231. <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>
  232. </div>
  233. <div>
  234. <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>
  235. </div>
  236. <div>
  237. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Move_System_Int32_System_Int32_">View.Move(Int32, Int32)</a>
  238. </div>
  239. <div>
  240. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_PositionCursor">View.PositionCursor()</a>
  241. </div>
  242. <div>
  243. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_HasFocus">View.HasFocus</a>
  244. </div>
  245. <div>
  246. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnAdded_Terminal_Gui_View_">View.OnAdded(View)</a>
  247. </div>
  248. <div>
  249. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnRemoved_Terminal_Gui_View_">View.OnRemoved(View)</a>
  250. </div>
  251. <div>
  252. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnEnter_Terminal_Gui_View_">View.OnEnter(View)</a>
  253. </div>
  254. <div>
  255. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnLeave_Terminal_Gui_View_">View.OnLeave(View)</a>
  256. </div>
  257. <div>
  258. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Focused">View.Focused</a>
  259. </div>
  260. <div>
  261. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_MostFocused">View.MostFocused</a>
  262. </div>
  263. <div>
  264. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ColorScheme">View.ColorScheme</a>
  265. </div>
  266. <div>
  267. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_AddRune_System_Int32_System_Int32_System_Rune_">View.AddRune(Int32, Int32, Rune)</a>
  268. </div>
  269. <div>
  270. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ClearNeedsDisplay">View.ClearNeedsDisplay()</a>
  271. </div>
  272. <div>
  273. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Redraw_Terminal_Gui_Rect_">View.Redraw(Rect)</a>
  274. </div>
  275. <div>
  276. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_DrawContent">View.DrawContent</a>
  277. </div>
  278. <div>
  279. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnDrawContent_Terminal_Gui_Rect_">View.OnDrawContent(Rect)</a>
  280. </div>
  281. <div>
  282. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SetFocus_Terminal_Gui_View_">View.SetFocus(View)</a>
  283. </div>
  284. <div>
  285. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_KeyPress">View.KeyPress</a>
  286. </div>
  287. <div>
  288. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_KeyDown">View.KeyDown</a>
  289. </div>
  290. <div>
  291. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnKeyDown_Terminal_Gui_KeyEvent_">View.OnKeyDown(KeyEvent)</a>
  292. </div>
  293. <div>
  294. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_KeyUp">View.KeyUp</a>
  295. </div>
  296. <div>
  297. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnKeyUp_Terminal_Gui_KeyEvent_">View.OnKeyUp(KeyEvent)</a>
  298. </div>
  299. <div>
  300. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_EnsureFocus">View.EnsureFocus()</a>
  301. </div>
  302. <div>
  303. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_FocusFirst">View.FocusFirst()</a>
  304. </div>
  305. <div>
  306. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_FocusLast">View.FocusLast()</a>
  307. </div>
  308. <div>
  309. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_FocusPrev">View.FocusPrev()</a>
  310. </div>
  311. <div>
  312. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_FocusNext">View.FocusNext()</a>
  313. </div>
  314. <div>
  315. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_LayoutStarted">View.LayoutStarted</a>
  316. </div>
  317. <div>
  318. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_LayoutComplete">View.LayoutComplete</a>
  319. </div>
  320. <div>
  321. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Initialized">View.Initialized</a>
  322. </div>
  323. <div>
  324. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_LayoutSubviews">View.LayoutSubviews()</a>
  325. </div>
  326. <div>
  327. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_TextAlignment">View.TextAlignment</a>
  328. </div>
  329. <div>
  330. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_IsInitialized">View.IsInitialized</a>
  331. </div>
  332. <div>
  333. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ToString">View.ToString()</a>
  334. </div>
  335. <div>
  336. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnMouseEnter_Terminal_Gui_MouseEvent_">View.OnMouseEnter(MouseEvent)</a>
  337. </div>
  338. <div>
  339. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnMouseLeave_Terminal_Gui_MouseEvent_">View.OnMouseLeave(MouseEvent)</a>
  340. </div>
  341. <div>
  342. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Dispose_System_Boolean_">View.Dispose(Boolean)</a>
  343. </div>
  344. <div>
  345. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_BeginInit">View.BeginInit()</a>
  346. </div>
  347. <div>
  348. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_EndInit">View.EndInit()</a>
  349. </div>
  350. <div>
  351. <a class="xref" href="Terminal.Gui.Responder.html#Terminal_Gui_Responder_MouseEvent_Terminal_Gui_MouseEvent_">Responder.MouseEvent(MouseEvent)</a>
  352. </div>
  353. <div>
  354. <a class="xref" href="Terminal.Gui.Responder.html#Terminal_Gui_Responder_Dispose">Responder.Dispose()</a>
  355. </div>
  356. <div>
  357. <span class="xref">System.Object.Equals(System.Object)</span>
  358. </div>
  359. <div>
  360. <span class="xref">System.Object.Equals(System.Object, System.Object)</span>
  361. </div>
  362. <div>
  363. <span class="xref">System.Object.GetHashCode()</span>
  364. </div>
  365. <div>
  366. <span class="xref">System.Object.GetType()</span>
  367. </div>
  368. <div>
  369. <span class="xref">System.Object.MemberwiseClone()</span>
  370. </div>
  371. <div>
  372. <span class="xref">System.Object.ReferenceEquals(System.Object, System.Object)</span>
  373. </div>
  374. </div>
  375. <h6><strong>Namespace</strong>: <a class="xref" href="Terminal.Gui.html">Terminal.Gui</a></h6>
  376. <h6><strong>Assembly</strong>: Terminal.Gui.dll</h6>
  377. <h5 id="Terminal_Gui_Button_syntax">Syntax</h5>
  378. <div class="codewrapper">
  379. <pre><code class="lang-csharp hljs">public class Button : View, IDisposable, IEnumerable, ISupportInitializeNotification, ISupportInitialize</code></pre>
  380. </div>
  381. <h5 id="Terminal_Gui_Button_remarks"><strong>Remarks</strong></h5>
  382. <div class="markdown level0 remarks">
  383. <p>
  384. Provides a button showing text invokes an <span class="xref">System.Action</span> when clicked on with a mouse
  385. or when the user presses SPACE, ENTER, or hotkey. The hotkey is the first letter or digit following the first underscore (&apos;_&apos;)
  386. in the button text.
  387. </p>
  388. <p>
  389. 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;).
  390. </p>
  391. <p>
  392. If no hotkey specifier is found, the first uppercase letter encountered will be used as the hotkey.
  393. </p>
  394. <p>
  395. 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
  396. 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
  397. <span class="xref">System.Action</span> will be invoked.
  398. </p>
  399. </div>
  400. <h3 id="constructors">Constructors
  401. </h3>
  402. <a id="Terminal_Gui_Button__ctor_" data-uid="Terminal.Gui.Button.#ctor*"></a>
  403. <h4 id="Terminal_Gui_Button__ctor" data-uid="Terminal.Gui.Button.#ctor">Button()</h4>
  404. <div class="markdown level1 summary">
  405. 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.
  406. </div>
  407. <div class="markdown level1 conceptual"></div>
  408. <h5 class="decalaration">Declaration</h5>
  409. <div class="codewrapper">
  410. <pre><code class="lang-csharp hljs">public Button()</code></pre>
  411. </div>
  412. <h5 id="Terminal_Gui_Button__ctor_remarks">Remarks</h5>
  413. <div class="markdown level1 remarks">
  414. The width of the <a class="xref" href="Terminal.Gui.Button.html">Button</a> is computed based on the
  415. text length. The height will always be 1.
  416. </div>
  417. <a id="Terminal_Gui_Button__ctor_" data-uid="Terminal.Gui.Button.#ctor*"></a>
  418. <h4 id="Terminal_Gui_Button__ctor_NStack_ustring_System_Boolean_" data-uid="Terminal.Gui.Button.#ctor(NStack.ustring,System.Boolean)">Button(ustring, Boolean)</h4>
  419. <div class="markdown level1 summary">
  420. 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.
  421. </div>
  422. <div class="markdown level1 conceptual"></div>
  423. <h5 class="decalaration">Declaration</h5>
  424. <div class="codewrapper">
  425. <pre><code class="lang-csharp hljs">public Button(ustring text, bool is_default = false)</code></pre>
  426. </div>
  427. <h5 class="parameters">Parameters</h5>
  428. <table class="table table-bordered table-striped table-condensed">
  429. <thead>
  430. <tr>
  431. <th>Type</th>
  432. <th>Name</th>
  433. <th>Description</th>
  434. </tr>
  435. </thead>
  436. <tbody>
  437. <tr>
  438. <td><span class="xref">NStack.ustring</span></td>
  439. <td><span class="parametername">text</span></td>
  440. <td>The button&apos;s text</td>
  441. </tr>
  442. <tr>
  443. <td><span class="xref">System.Boolean</span></td>
  444. <td><span class="parametername">is_default</span></td>
  445. <td>
  446. If <code>true</code>, a special decoration is used, and the user pressing the enter key
  447. in a <a class="xref" href="Terminal.Gui.Dialog.html">Dialog</a> will implicitly activate this button.
  448. </td>
  449. </tr>
  450. </tbody>
  451. </table>
  452. <h5 id="Terminal_Gui_Button__ctor_NStack_ustring_System_Boolean__remarks">Remarks</h5>
  453. <div class="markdown level1 remarks">
  454. The width of the <a class="xref" href="Terminal.Gui.Button.html">Button</a> is computed based on the
  455. text length. The height will always be 1.
  456. </div>
  457. <a id="Terminal_Gui_Button__ctor_" data-uid="Terminal.Gui.Button.#ctor*"></a>
  458. <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>
  459. <div class="markdown level1 summary">
  460. 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
  461. </div>
  462. <div class="markdown level1 conceptual"></div>
  463. <h5 class="decalaration">Declaration</h5>
  464. <div class="codewrapper">
  465. <pre><code class="lang-csharp hljs">public Button(int x, int y, ustring text)</code></pre>
  466. </div>
  467. <h5 class="parameters">Parameters</h5>
  468. <table class="table table-bordered table-striped table-condensed">
  469. <thead>
  470. <tr>
  471. <th>Type</th>
  472. <th>Name</th>
  473. <th>Description</th>
  474. </tr>
  475. </thead>
  476. <tbody>
  477. <tr>
  478. <td><span class="xref">System.Int32</span></td>
  479. <td><span class="parametername">x</span></td>
  480. <td>X position where the button will be shown.</td>
  481. </tr>
  482. <tr>
  483. <td><span class="xref">System.Int32</span></td>
  484. <td><span class="parametername">y</span></td>
  485. <td>Y position where the button will be shown.</td>
  486. </tr>
  487. <tr>
  488. <td><span class="xref">NStack.ustring</span></td>
  489. <td><span class="parametername">text</span></td>
  490. <td>The button&apos;s text</td>
  491. </tr>
  492. </tbody>
  493. </table>
  494. <h5 id="Terminal_Gui_Button__ctor_System_Int32_System_Int32_NStack_ustring__remarks">Remarks</h5>
  495. <div class="markdown level1 remarks">
  496. The width of the <a class="xref" href="Terminal.Gui.Button.html">Button</a> is computed based on the
  497. text length. The height will always be 1.
  498. </div>
  499. <a id="Terminal_Gui_Button__ctor_" data-uid="Terminal.Gui.Button.#ctor*"></a>
  500. <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>
  501. <div class="markdown level1 summary">
  502. 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.
  503. </div>
  504. <div class="markdown level1 conceptual"></div>
  505. <h5 class="decalaration">Declaration</h5>
  506. <div class="codewrapper">
  507. <pre><code class="lang-csharp hljs">public Button(int x, int y, ustring text, bool is_default)</code></pre>
  508. </div>
  509. <h5 class="parameters">Parameters</h5>
  510. <table class="table table-bordered table-striped table-condensed">
  511. <thead>
  512. <tr>
  513. <th>Type</th>
  514. <th>Name</th>
  515. <th>Description</th>
  516. </tr>
  517. </thead>
  518. <tbody>
  519. <tr>
  520. <td><span class="xref">System.Int32</span></td>
  521. <td><span class="parametername">x</span></td>
  522. <td>X position where the button will be shown.</td>
  523. </tr>
  524. <tr>
  525. <td><span class="xref">System.Int32</span></td>
  526. <td><span class="parametername">y</span></td>
  527. <td>Y position where the button will be shown.</td>
  528. </tr>
  529. <tr>
  530. <td><span class="xref">NStack.ustring</span></td>
  531. <td><span class="parametername">text</span></td>
  532. <td>The button&apos;s text</td>
  533. </tr>
  534. <tr>
  535. <td><span class="xref">System.Boolean</span></td>
  536. <td><span class="parametername">is_default</span></td>
  537. <td>
  538. If <code>true</code>, a special decoration is used, and the user pressing the enter key
  539. in a <a class="xref" href="Terminal.Gui.Dialog.html">Dialog</a> will implicitly activate this button.
  540. </td>
  541. </tr>
  542. </tbody>
  543. </table>
  544. <h5 id="Terminal_Gui_Button__ctor_System_Int32_System_Int32_NStack_ustring_System_Boolean__remarks">Remarks</h5>
  545. <div class="markdown level1 remarks">
  546. The width of the <a class="xref" href="Terminal.Gui.Button.html">Button</a> is computed based on the
  547. text length. The height will always be 1.
  548. </div>
  549. <h3 id="fields">Fields
  550. </h3>
  551. <h4 id="Terminal_Gui_Button_Clicked" data-uid="Terminal.Gui.Button.Clicked">Clicked</h4>
  552. <div class="markdown level1 summary">
  553. 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>
  554. or if the user presses the action key while this view is focused. (TODO: IsDefault)
  555. </div>
  556. <div class="markdown level1 conceptual"></div>
  557. <h5 class="decalaration">Declaration</h5>
  558. <div class="codewrapper">
  559. <pre><code class="lang-csharp hljs">public Action Clicked</code></pre>
  560. </div>
  561. <h5 class="fieldValue">Field Value</h5>
  562. <table class="table table-bordered table-striped table-condensed">
  563. <thead>
  564. <tr>
  565. <th>Type</th>
  566. <th>Description</th>
  567. </tr>
  568. </thead>
  569. <tbody>
  570. <tr>
  571. <td><span class="xref">System.Action</span></td>
  572. <td></td>
  573. </tr>
  574. </tbody>
  575. </table>
  576. <h5 id="Terminal_Gui_Button_Clicked_remarks">Remarks</h5>
  577. <div class="markdown level1 remarks">
  578. Client code can hook up to this event, it is
  579. raised when the button is activated either with
  580. the mouse or the keyboard.
  581. </div>
  582. <h3 id="properties">Properties
  583. </h3>
  584. <a id="Terminal_Gui_Button_IsDefault_" data-uid="Terminal.Gui.Button.IsDefault*"></a>
  585. <h4 id="Terminal_Gui_Button_IsDefault" data-uid="Terminal.Gui.Button.IsDefault">IsDefault</h4>
  586. <div class="markdown level1 summary">
  587. Gets or sets whether the <a class="xref" href="Terminal.Gui.Button.html">Button</a> is the default action to activate in a dialog.
  588. </div>
  589. <div class="markdown level1 conceptual"></div>
  590. <h5 class="decalaration">Declaration</h5>
  591. <div class="codewrapper">
  592. <pre><code class="lang-csharp hljs">public bool IsDefault { get; set; }</code></pre>
  593. </div>
  594. <h5 class="propertyValue">Property Value</h5>
  595. <table class="table table-bordered table-striped table-condensed">
  596. <thead>
  597. <tr>
  598. <th>Type</th>
  599. <th>Description</th>
  600. </tr>
  601. </thead>
  602. <tbody>
  603. <tr>
  604. <td><span class="xref">System.Boolean</span></td>
  605. <td><code>true</code> if is default; otherwise, <code>false</code>.</td>
  606. </tr>
  607. </tbody>
  608. </table>
  609. <a id="Terminal_Gui_Button_Text_" data-uid="Terminal.Gui.Button.Text*"></a>
  610. <h4 id="Terminal_Gui_Button_Text" data-uid="Terminal.Gui.Button.Text">Text</h4>
  611. <div class="markdown level1 summary">
  612. The text displayed by this <a class="xref" href="Terminal.Gui.Button.html">Button</a>.
  613. </div>
  614. <div class="markdown level1 conceptual"></div>
  615. <h5 class="decalaration">Declaration</h5>
  616. <div class="codewrapper">
  617. <pre><code class="lang-csharp hljs">public ustring Text { get; set; }</code></pre>
  618. </div>
  619. <h5 class="propertyValue">Property Value</h5>
  620. <table class="table table-bordered table-striped table-condensed">
  621. <thead>
  622. <tr>
  623. <th>Type</th>
  624. <th>Description</th>
  625. </tr>
  626. </thead>
  627. <tbody>
  628. <tr>
  629. <td><span class="xref">NStack.ustring</span></td>
  630. <td></td>
  631. </tr>
  632. </tbody>
  633. </table>
  634. <h3 id="methods">Methods
  635. </h3>
  636. <a id="Terminal_Gui_Button_OnMouseEvent_" data-uid="Terminal.Gui.Button.OnMouseEvent*"></a>
  637. <h4 id="Terminal_Gui_Button_OnMouseEvent_Terminal_Gui_MouseEvent_" data-uid="Terminal.Gui.Button.OnMouseEvent(Terminal.Gui.MouseEvent)">OnMouseEvent(MouseEvent)</h4>
  638. <div class="markdown level1 summary">
  639. Method invoked when a mouse event is generated
  640. </div>
  641. <div class="markdown level1 conceptual"></div>
  642. <h5 class="decalaration">Declaration</h5>
  643. <div class="codewrapper">
  644. <pre><code class="lang-csharp hljs">public override bool OnMouseEvent(MouseEvent mouseEvent)</code></pre>
  645. </div>
  646. <h5 class="parameters">Parameters</h5>
  647. <table class="table table-bordered table-striped table-condensed">
  648. <thead>
  649. <tr>
  650. <th>Type</th>
  651. <th>Name</th>
  652. <th>Description</th>
  653. </tr>
  654. </thead>
  655. <tbody>
  656. <tr>
  657. <td><a class="xref" href="Terminal.Gui.MouseEvent.html">MouseEvent</a></td>
  658. <td><span class="parametername">mouseEvent</span></td>
  659. <td></td>
  660. </tr>
  661. </tbody>
  662. </table>
  663. <h5 class="returns">Returns</h5>
  664. <table class="table table-bordered table-striped table-condensed">
  665. <thead>
  666. <tr>
  667. <th>Type</th>
  668. <th>Description</th>
  669. </tr>
  670. </thead>
  671. <tbody>
  672. <tr>
  673. <td><span class="xref">System.Boolean</span></td>
  674. <td><code>true</code>, if the event was handled, <code>false</code> otherwise.</td>
  675. </tr>
  676. </tbody>
  677. </table>
  678. <h5 class="overrides">Overrides</h5>
  679. <div><a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnMouseEvent_Terminal_Gui_MouseEvent_">View.OnMouseEvent(MouseEvent)</a></div>
  680. <a id="Terminal_Gui_Button_ProcessColdKey_" data-uid="Terminal.Gui.Button.ProcessColdKey*"></a>
  681. <h4 id="Terminal_Gui_Button_ProcessColdKey_Terminal_Gui_KeyEvent_" data-uid="Terminal.Gui.Button.ProcessColdKey(Terminal.Gui.KeyEvent)">ProcessColdKey(KeyEvent)</h4>
  682. <div class="markdown level1 summary"></div>
  683. <div class="markdown level1 conceptual"></div>
  684. <h5 class="decalaration">Declaration</h5>
  685. <div class="codewrapper">
  686. <pre><code class="lang-csharp hljs">public override bool ProcessColdKey(KeyEvent kb)</code></pre>
  687. </div>
  688. <h5 class="parameters">Parameters</h5>
  689. <table class="table table-bordered table-striped table-condensed">
  690. <thead>
  691. <tr>
  692. <th>Type</th>
  693. <th>Name</th>
  694. <th>Description</th>
  695. </tr>
  696. </thead>
  697. <tbody>
  698. <tr>
  699. <td><a class="xref" href="Terminal.Gui.KeyEvent.html">KeyEvent</a></td>
  700. <td><span class="parametername">kb</span></td>
  701. <td></td>
  702. </tr>
  703. </tbody>
  704. </table>
  705. <h5 class="returns">Returns</h5>
  706. <table class="table table-bordered table-striped table-condensed">
  707. <thead>
  708. <tr>
  709. <th>Type</th>
  710. <th>Description</th>
  711. </tr>
  712. </thead>
  713. <tbody>
  714. <tr>
  715. <td><span class="xref">System.Boolean</span></td>
  716. <td></td>
  717. </tr>
  718. </tbody>
  719. </table>
  720. <h5 class="overrides">Overrides</h5>
  721. <div><a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ProcessColdKey_Terminal_Gui_KeyEvent_">View.ProcessColdKey(KeyEvent)</a></div>
  722. <a id="Terminal_Gui_Button_ProcessHotKey_" data-uid="Terminal.Gui.Button.ProcessHotKey*"></a>
  723. <h4 id="Terminal_Gui_Button_ProcessHotKey_Terminal_Gui_KeyEvent_" data-uid="Terminal.Gui.Button.ProcessHotKey(Terminal.Gui.KeyEvent)">ProcessHotKey(KeyEvent)</h4>
  724. <div class="markdown level1 summary"></div>
  725. <div class="markdown level1 conceptual"></div>
  726. <h5 class="decalaration">Declaration</h5>
  727. <div class="codewrapper">
  728. <pre><code class="lang-csharp hljs">public override bool ProcessHotKey(KeyEvent kb)</code></pre>
  729. </div>
  730. <h5 class="parameters">Parameters</h5>
  731. <table class="table table-bordered table-striped table-condensed">
  732. <thead>
  733. <tr>
  734. <th>Type</th>
  735. <th>Name</th>
  736. <th>Description</th>
  737. </tr>
  738. </thead>
  739. <tbody>
  740. <tr>
  741. <td><a class="xref" href="Terminal.Gui.KeyEvent.html">KeyEvent</a></td>
  742. <td><span class="parametername">kb</span></td>
  743. <td></td>
  744. </tr>
  745. </tbody>
  746. </table>
  747. <h5 class="returns">Returns</h5>
  748. <table class="table table-bordered table-striped table-condensed">
  749. <thead>
  750. <tr>
  751. <th>Type</th>
  752. <th>Description</th>
  753. </tr>
  754. </thead>
  755. <tbody>
  756. <tr>
  757. <td><span class="xref">System.Boolean</span></td>
  758. <td></td>
  759. </tr>
  760. </tbody>
  761. </table>
  762. <h5 class="overrides">Overrides</h5>
  763. <div><a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ProcessHotKey_Terminal_Gui_KeyEvent_">View.ProcessHotKey(KeyEvent)</a></div>
  764. <a id="Terminal_Gui_Button_ProcessKey_" data-uid="Terminal.Gui.Button.ProcessKey*"></a>
  765. <h4 id="Terminal_Gui_Button_ProcessKey_Terminal_Gui_KeyEvent_" data-uid="Terminal.Gui.Button.ProcessKey(Terminal.Gui.KeyEvent)">ProcessKey(KeyEvent)</h4>
  766. <div class="markdown level1 summary"></div>
  767. <div class="markdown level1 conceptual"></div>
  768. <h5 class="decalaration">Declaration</h5>
  769. <div class="codewrapper">
  770. <pre><code class="lang-csharp hljs">public override bool ProcessKey(KeyEvent kb)</code></pre>
  771. </div>
  772. <h5 class="parameters">Parameters</h5>
  773. <table class="table table-bordered table-striped table-condensed">
  774. <thead>
  775. <tr>
  776. <th>Type</th>
  777. <th>Name</th>
  778. <th>Description</th>
  779. </tr>
  780. </thead>
  781. <tbody>
  782. <tr>
  783. <td><a class="xref" href="Terminal.Gui.KeyEvent.html">KeyEvent</a></td>
  784. <td><span class="parametername">kb</span></td>
  785. <td></td>
  786. </tr>
  787. </tbody>
  788. </table>
  789. <h5 class="returns">Returns</h5>
  790. <table class="table table-bordered table-striped table-condensed">
  791. <thead>
  792. <tr>
  793. <th>Type</th>
  794. <th>Description</th>
  795. </tr>
  796. </thead>
  797. <tbody>
  798. <tr>
  799. <td><span class="xref">System.Boolean</span></td>
  800. <td></td>
  801. </tr>
  802. </tbody>
  803. </table>
  804. <h5 class="overrides">Overrides</h5>
  805. <div><a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ProcessKey_Terminal_Gui_KeyEvent_">View.ProcessKey(KeyEvent)</a></div>
  806. <h3 id="implements">Implements</h3>
  807. <div>
  808. <span class="xref">System.IDisposable</span>
  809. </div>
  810. <div>
  811. <span class="xref">System.Collections.IEnumerable</span>
  812. </div>
  813. <div>
  814. <span class="xref">System.ComponentModel.ISupportInitializeNotification</span>
  815. </div>
  816. <div>
  817. <span class="xref">System.ComponentModel.ISupportInitialize</span>
  818. </div>
  819. </article>
  820. </div>
  821. <div class="hidden-sm col-md-2" role="complementary">
  822. <div class="sideaffix">
  823. <div class="contribution">
  824. <ul class="nav">
  825. </ul>
  826. </div>
  827. <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
  828. <!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
  829. </nav>
  830. </div>
  831. </div>
  832. </div>
  833. </div>
  834. <footer>
  835. <div class="grad-bottom"></div>
  836. <div class="footer">
  837. <div class="container">
  838. <span class="pull-right">
  839. <a href="#top">Back to top</a>
  840. </span>
  841. <span>Generated by <strong>DocFX</strong></span>
  842. </div>
  843. </div>
  844. </footer>
  845. </div>
  846. <script type="text/javascript" src="../../styles/docfx.vendor.js"></script>
  847. <script type="text/javascript" src="../../styles/docfx.js"></script>
  848. <script type="text/javascript" src="../../styles/main.js"></script>
  849. </body>
  850. </html>