Terminal.Gui.CheckBox.html 42 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017
  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 CheckBox
  8. </title>
  9. <meta name="viewport" content="width=device-width">
  10. <meta name="title" content="Class CheckBox
  11. ">
  12. <meta name="generator" content="docfx 2.59.3.0">
  13. <link rel="shortcut icon" href="../../favicon.ico">
  14. <link rel="stylesheet" href="../../styles/docfx.vendor.css">
  15. <link rel="stylesheet" href="../../styles/docfx.css">
  16. <link rel="stylesheet" href="../../styles/main.css">
  17. <meta property="docfx:navrel" content="../../toc.html">
  18. <meta property="docfx:tocrel" content="toc.html">
  19. <meta property="docfx:rel" content="../../">
  20. </head>
  21. <body data-spy="scroll" data-target="#affix" data-offset="120">
  22. <div id="wrapper">
  23. <header>
  24. <nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation">
  25. <div class="container">
  26. <div class="navbar-header">
  27. <button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
  28. <span class="sr-only">Toggle navigation</span>
  29. <span class="icon-bar"></span>
  30. <span class="icon-bar"></span>
  31. <span class="icon-bar"></span>
  32. </button>
  33. <a class="navbar-brand" href="../../index.html">
  34. <img id="logo" class="svg" src="../../images/logo48.png" alt="">
  35. </a>
  36. </div>
  37. <div class="collapse navbar-collapse" id="navbar">
  38. <form class="navbar-form navbar-right" role="search" id="search">
  39. <div class="form-group">
  40. <input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">
  41. </div>
  42. </form>
  43. </div>
  44. </div>
  45. </nav>
  46. <div class="subnav navbar navbar-default">
  47. <div class="container hide-when-search" id="breadcrumb">
  48. <ul class="breadcrumb">
  49. <li></li>
  50. </ul>
  51. </div>
  52. </div>
  53. </header>
  54. <div class="container body-content">
  55. <div id="search-results">
  56. <div class="search-list">Search Results for <span></span></div>
  57. <div class="sr-items">
  58. <p><i class="glyphicon glyphicon-refresh index-loading"></i></p>
  59. </div>
  60. <ul id="pagination" data-first="First" data-prev="Previous" data-next="Next" data-last="Last"></ul>
  61. </div>
  62. </div>
  63. <div role="main" class="container body-content hide-when-search">
  64. <div class="sidenav hide-when-search">
  65. <a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
  66. <div class="sidetoggle collapse" id="sidetoggle">
  67. <div id="sidetoc"></div>
  68. </div>
  69. </div>
  70. <div class="article row grid-right">
  71. <div class="col-md-10">
  72. <article class="content wrap" id="_content" data-uid="Terminal.Gui.CheckBox">
  73. <h1 id="Terminal_Gui_CheckBox" data-uid="Terminal.Gui.CheckBox" class="text-break">Class CheckBox
  74. </h1>
  75. <div class="markdown level0 summary">
  76. The <a class="xref" href="Terminal.Gui.CheckBox.html">CheckBox</a> <a class="xref" href="Terminal.Gui.View.html">View</a> shows an on/off toggle that the user can set
  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">CheckBox</span></div>
  85. </div>
  86. <div class="implements">
  87. <h5>Implements</h5>
  88. <div><span class="xref">System.IDisposable</span></div>
  89. <div><span class="xref">System.ComponentModel.ISupportInitializeNotification</span></div>
  90. <div><span class="xref">System.ComponentModel.ISupportInitialize</span></div>
  91. </div>
  92. <div class="inheritedMembers">
  93. <h5>Inherited Members</h5>
  94. <div>
  95. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_GetMinWidthHeight_Terminal_Gui_Size__">View.GetMinWidthHeight(Size)</a>
  96. </div>
  97. <div>
  98. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SetMinWidthHeight">View.SetMinWidthHeight()</a>
  99. </div>
  100. <div>
  101. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ProcessResizeView">View.ProcessResizeView()</a>
  102. </div>
  103. <div>
  104. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SetNeedsDisplay">View.SetNeedsDisplay()</a>
  105. </div>
  106. <div>
  107. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ClearLayoutNeeded">View.ClearLayoutNeeded()</a>
  108. </div>
  109. <div>
  110. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SetNeedsDisplay_Terminal_Gui_Rect_">View.SetNeedsDisplay(Rect)</a>
  111. </div>
  112. <div>
  113. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SetChildNeedsDisplay">View.SetChildNeedsDisplay()</a>
  114. </div>
  115. <div>
  116. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Add_Terminal_Gui_View_">View.Add(View)</a>
  117. </div>
  118. <div>
  119. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Add_Terminal_Gui_View___">View.Add(View[])</a>
  120. </div>
  121. <div>
  122. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_RemoveAll">View.RemoveAll()</a>
  123. </div>
  124. <div>
  125. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Remove_Terminal_Gui_View_">View.Remove(View)</a>
  126. </div>
  127. <div>
  128. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_BringSubviewToFront_Terminal_Gui_View_">View.BringSubviewToFront(View)</a>
  129. </div>
  130. <div>
  131. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SendSubviewToBack_Terminal_Gui_View_">View.SendSubviewToBack(View)</a>
  132. </div>
  133. <div>
  134. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SendSubviewBackwards_Terminal_Gui_View_">View.SendSubviewBackwards(View)</a>
  135. </div>
  136. <div>
  137. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_BringSubviewForward_Terminal_Gui_View_">View.BringSubviewForward(View)</a>
  138. </div>
  139. <div>
  140. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Clear">View.Clear()</a>
  141. </div>
  142. <div>
  143. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Clear_Terminal_Gui_Rect_">View.Clear(Rect)</a>
  144. </div>
  145. <div>
  146. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ScreenToView_System_Int32_System_Int32_">View.ScreenToView(Int32, Int32)</a>
  147. </div>
  148. <div>
  149. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ClipToBounds">View.ClipToBounds()</a>
  150. </div>
  151. <div>
  152. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SetClip_Terminal_Gui_Rect_">View.SetClip(Rect)</a>
  153. </div>
  154. <div>
  155. <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>
  156. </div>
  157. <div>
  158. <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>
  159. </div>
  160. <div>
  161. <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>
  162. </div>
  163. <div>
  164. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Move_System_Int32_System_Int32_System_Boolean_">View.Move(Int32, Int32, Boolean)</a>
  165. </div>
  166. <div>
  167. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnAdded_Terminal_Gui_View_">View.OnAdded(View)</a>
  168. </div>
  169. <div>
  170. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnRemoved_Terminal_Gui_View_">View.OnRemoved(View)</a>
  171. </div>
  172. <div>
  173. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnLeave_Terminal_Gui_View_">View.OnLeave(View)</a>
  174. </div>
  175. <div>
  176. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_AddRune_System_Int32_System_Int32_System_Rune_">View.AddRune(Int32, Int32, Rune)</a>
  177. </div>
  178. <div>
  179. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ClearNeedsDisplay">View.ClearNeedsDisplay()</a>
  180. </div>
  181. <div>
  182. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Redraw_Terminal_Gui_Rect_">View.Redraw(Rect)</a>
  183. </div>
  184. <div>
  185. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnDrawContent_Terminal_Gui_Rect_">View.OnDrawContent(Rect)</a>
  186. </div>
  187. <div>
  188. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnDrawContentComplete_Terminal_Gui_Rect_">View.OnDrawContentComplete(Rect)</a>
  189. </div>
  190. <div>
  191. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SetFocus">View.SetFocus()</a>
  192. </div>
  193. <div>
  194. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_InvokeKeybindings_Terminal_Gui_KeyEvent_">View.InvokeKeybindings(KeyEvent)</a>
  195. </div>
  196. <div>
  197. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_AddKeyBinding_Terminal_Gui_Key_Terminal_Gui_Command_">View.AddKeyBinding(Key, Command)</a>
  198. </div>
  199. <div>
  200. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ReplaceKeyBinding_Terminal_Gui_Key_Terminal_Gui_Key_">View.ReplaceKeyBinding(Key, Key)</a>
  201. </div>
  202. <div>
  203. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ContainsKeyBinding_Terminal_Gui_Key_">View.ContainsKeyBinding(Key)</a>
  204. </div>
  205. <div>
  206. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ClearKeybindings">View.ClearKeybindings()</a>
  207. </div>
  208. <div>
  209. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ClearKeybinding_Terminal_Gui_Key_">View.ClearKeybinding(Key)</a>
  210. </div>
  211. <div>
  212. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ClearKeybinding_Terminal_Gui_Command_">View.ClearKeybinding(Command)</a>
  213. </div>
  214. <div>
  215. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_AddCommand_Terminal_Gui_Command_System_Func_System_Nullable_System_Boolean___">View.AddCommand(Command, Func&lt;Nullable&lt;Boolean&gt;&gt;)</a>
  216. </div>
  217. <div>
  218. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_GetSupportedCommands">View.GetSupportedCommands()</a>
  219. </div>
  220. <div>
  221. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_GetKeyFromCommand_Terminal_Gui_Command_">View.GetKeyFromCommand(Command)</a>
  222. </div>
  223. <div>
  224. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ProcessColdKey_Terminal_Gui_KeyEvent_">View.ProcessColdKey(KeyEvent)</a>
  225. </div>
  226. <div>
  227. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnKeyDown_Terminal_Gui_KeyEvent_">View.OnKeyDown(KeyEvent)</a>
  228. </div>
  229. <div>
  230. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnKeyUp_Terminal_Gui_KeyEvent_">View.OnKeyUp(KeyEvent)</a>
  231. </div>
  232. <div>
  233. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_EnsureFocus">View.EnsureFocus()</a>
  234. </div>
  235. <div>
  236. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_FocusFirst">View.FocusFirst()</a>
  237. </div>
  238. <div>
  239. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_FocusLast">View.FocusLast()</a>
  240. </div>
  241. <div>
  242. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_FocusPrev">View.FocusPrev()</a>
  243. </div>
  244. <div>
  245. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_FocusNext">View.FocusNext()</a>
  246. </div>
  247. <div>
  248. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_LayoutSubviews">View.LayoutSubviews()</a>
  249. </div>
  250. <div>
  251. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ToString">View.ToString()</a>
  252. </div>
  253. <div>
  254. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_GetAutoSize">View.GetAutoSize()</a>
  255. </div>
  256. <div>
  257. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_GetHotKeySpecifierLength_System_Boolean_">View.GetHotKeySpecifierLength(Boolean)</a>
  258. </div>
  259. <div>
  260. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_GetTextFormatterBoundsSize">View.GetTextFormatterBoundsSize()</a>
  261. </div>
  262. <div>
  263. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_GetBoundsTextFormatterSize">View.GetBoundsTextFormatterSize()</a>
  264. </div>
  265. <div>
  266. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnMouseEnter_Terminal_Gui_MouseEvent_">View.OnMouseEnter(MouseEvent)</a>
  267. </div>
  268. <div>
  269. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnMouseLeave_Terminal_Gui_MouseEvent_">View.OnMouseLeave(MouseEvent)</a>
  270. </div>
  271. <div>
  272. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnMouseEvent_Terminal_Gui_MouseEvent_">View.OnMouseEvent(MouseEvent)</a>
  273. </div>
  274. <div>
  275. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnMouseClick_Terminal_Gui_View_MouseEventArgs_">View.OnMouseClick(View.MouseEventArgs)</a>
  276. </div>
  277. <div>
  278. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnCanFocusChanged">View.OnCanFocusChanged()</a>
  279. </div>
  280. <div>
  281. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnEnabledChanged">View.OnEnabledChanged()</a>
  282. </div>
  283. <div>
  284. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnVisibleChanged">View.OnVisibleChanged()</a>
  285. </div>
  286. <div>
  287. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Dispose_System_Boolean_">View.Dispose(Boolean)</a>
  288. </div>
  289. <div>
  290. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_BeginInit">View.BeginInit()</a>
  291. </div>
  292. <div>
  293. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_EndInit">View.EndInit()</a>
  294. </div>
  295. <div>
  296. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SetWidth_System_Int32_System_Int32__">View.SetWidth(Int32, Int32)</a>
  297. </div>
  298. <div>
  299. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SetHeight_System_Int32_System_Int32__">View.SetHeight(Int32, Int32)</a>
  300. </div>
  301. <div>
  302. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_GetCurrentWidth_System_Int32__">View.GetCurrentWidth(Int32)</a>
  303. </div>
  304. <div>
  305. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_GetCurrentHeight_System_Int32__">View.GetCurrentHeight(Int32)</a>
  306. </div>
  307. <div>
  308. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_GetNormalColor">View.GetNormalColor()</a>
  309. </div>
  310. <div>
  311. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_GetTopSuperView">View.GetTopSuperView()</a>
  312. </div>
  313. <div>
  314. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_HotKey">View.HotKey</a>
  315. </div>
  316. <div>
  317. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_HotKeySpecifier">View.HotKeySpecifier</a>
  318. </div>
  319. <div>
  320. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Shortcut">View.Shortcut</a>
  321. </div>
  322. <div>
  323. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ShortcutTag">View.ShortcutTag</a>
  324. </div>
  325. <div>
  326. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ShortcutAction">View.ShortcutAction</a>
  327. </div>
  328. <div>
  329. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Data">View.Data</a>
  330. </div>
  331. <div>
  332. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Driver">View.Driver</a>
  333. </div>
  334. <div>
  335. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Subviews">View.Subviews</a>
  336. </div>
  337. <div>
  338. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_TabIndexes">View.TabIndexes</a>
  339. </div>
  340. <div>
  341. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_TabIndex">View.TabIndex</a>
  342. </div>
  343. <div>
  344. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_TabStop">View.TabStop</a>
  345. </div>
  346. <div>
  347. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_CanFocus">View.CanFocus</a>
  348. </div>
  349. <div>
  350. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Id">View.Id</a>
  351. </div>
  352. <div>
  353. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_IsCurrentTop">View.IsCurrentTop</a>
  354. </div>
  355. <div>
  356. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_WantMousePositionReports">View.WantMousePositionReports</a>
  357. </div>
  358. <div>
  359. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_WantContinuousButtonPressed">View.WantContinuousButtonPressed</a>
  360. </div>
  361. <div>
  362. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Frame">View.Frame</a>
  363. </div>
  364. <div>
  365. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_LayoutStyle">View.LayoutStyle</a>
  366. </div>
  367. <div>
  368. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Bounds">View.Bounds</a>
  369. </div>
  370. <div>
  371. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_X">View.X</a>
  372. </div>
  373. <div>
  374. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Y">View.Y</a>
  375. </div>
  376. <div>
  377. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Width">View.Width</a>
  378. </div>
  379. <div>
  380. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Height">View.Height</a>
  381. </div>
  382. <div>
  383. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ForceValidatePosDim">View.ForceValidatePosDim</a>
  384. </div>
  385. <div>
  386. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_TextFormatter">View.TextFormatter</a>
  387. </div>
  388. <div>
  389. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SuperView">View.SuperView</a>
  390. </div>
  391. <div>
  392. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_HasFocus">View.HasFocus</a>
  393. </div>
  394. <div>
  395. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Focused">View.Focused</a>
  396. </div>
  397. <div>
  398. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_MostFocused">View.MostFocused</a>
  399. </div>
  400. <div>
  401. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ColorScheme">View.ColorScheme</a>
  402. </div>
  403. <div>
  404. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Text">View.Text</a>
  405. </div>
  406. <div>
  407. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_AutoSize">View.AutoSize</a>
  408. </div>
  409. <div>
  410. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_PreserveTrailingSpaces">View.PreserveTrailingSpaces</a>
  411. </div>
  412. <div>
  413. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_TextAlignment">View.TextAlignment</a>
  414. </div>
  415. <div>
  416. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_VerticalTextAlignment">View.VerticalTextAlignment</a>
  417. </div>
  418. <div>
  419. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_TextDirection">View.TextDirection</a>
  420. </div>
  421. <div>
  422. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_IsInitialized">View.IsInitialized</a>
  423. </div>
  424. <div>
  425. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_IsAdded">View.IsAdded</a>
  426. </div>
  427. <div>
  428. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Enabled">View.Enabled</a>
  429. </div>
  430. <div>
  431. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Visible">View.Visible</a>
  432. </div>
  433. <div>
  434. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Border">View.Border</a>
  435. </div>
  436. <div>
  437. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Added">View.Added</a>
  438. </div>
  439. <div>
  440. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Removed">View.Removed</a>
  441. </div>
  442. <div>
  443. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Enter">View.Enter</a>
  444. </div>
  445. <div>
  446. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Leave">View.Leave</a>
  447. </div>
  448. <div>
  449. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_MouseEnter">View.MouseEnter</a>
  450. </div>
  451. <div>
  452. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_MouseLeave">View.MouseLeave</a>
  453. </div>
  454. <div>
  455. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_MouseClick">View.MouseClick</a>
  456. </div>
  457. <div>
  458. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_CanFocusChanged">View.CanFocusChanged</a>
  459. </div>
  460. <div>
  461. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_EnabledChanged">View.EnabledChanged</a>
  462. </div>
  463. <div>
  464. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_VisibleChanged">View.VisibleChanged</a>
  465. </div>
  466. <div>
  467. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_HotKeyChanged">View.HotKeyChanged</a>
  468. </div>
  469. <div>
  470. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_DrawContent">View.DrawContent</a>
  471. </div>
  472. <div>
  473. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_DrawContentComplete">View.DrawContentComplete</a>
  474. </div>
  475. <div>
  476. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_KeyPress">View.KeyPress</a>
  477. </div>
  478. <div>
  479. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_KeyDown">View.KeyDown</a>
  480. </div>
  481. <div>
  482. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_KeyUp">View.KeyUp</a>
  483. </div>
  484. <div>
  485. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_LayoutStarted">View.LayoutStarted</a>
  486. </div>
  487. <div>
  488. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_LayoutComplete">View.LayoutComplete</a>
  489. </div>
  490. <div>
  491. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Initialized">View.Initialized</a>
  492. </div>
  493. <div>
  494. <a class="xref" href="Terminal.Gui.Responder.html#Terminal_Gui_Responder_Dispose">Responder.Dispose()</a>
  495. </div>
  496. </div>
  497. <h6><strong>Namespace</strong>: <a class="xref" href="Terminal.Gui.html">Terminal.Gui</a></h6>
  498. <h6><strong>Assembly</strong>: Terminal.Gui.dll</h6>
  499. <h5 id="Terminal_Gui_CheckBox_syntax">Syntax</h5>
  500. <div class="codewrapper">
  501. <pre><code class="lang-csharp hljs">public class CheckBox : View</code></pre>
  502. </div>
  503. <h3 id="constructors">Constructors
  504. </h3>
  505. <a id="Terminal_Gui_CheckBox__ctor_" data-uid="Terminal.Gui.CheckBox.#ctor*"></a>
  506. <h4 id="Terminal_Gui_CheckBox__ctor" data-uid="Terminal.Gui.CheckBox.#ctor">CheckBox()</h4>
  507. <div class="markdown level1 summary">
  508. Initializes a new instance of <a class="xref" href="Terminal.Gui.CheckBox.html">CheckBox</a> based on the given text, using <a class="xref" href="Terminal.Gui.LayoutStyle.html#Terminal_Gui_LayoutStyle_Computed">Computed</a> layout.
  509. </div>
  510. <div class="markdown level1 conceptual"></div>
  511. <h5 class="decalaration">Declaration</h5>
  512. <div class="codewrapper">
  513. <pre><code class="lang-csharp hljs">public CheckBox()</code></pre>
  514. </div>
  515. <a id="Terminal_Gui_CheckBox__ctor_" data-uid="Terminal.Gui.CheckBox.#ctor*"></a>
  516. <h4 id="Terminal_Gui_CheckBox__ctor_NStack_ustring_System_Boolean_" data-uid="Terminal.Gui.CheckBox.#ctor(NStack.ustring,System.Boolean)">CheckBox(ustring, Boolean)</h4>
  517. <div class="markdown level1 summary">
  518. Initializes a new instance of <a class="xref" href="Terminal.Gui.CheckBox.html">CheckBox</a> based on the given text, using <a class="xref" href="Terminal.Gui.LayoutStyle.html#Terminal_Gui_LayoutStyle_Computed">Computed</a> layout.
  519. </div>
  520. <div class="markdown level1 conceptual"></div>
  521. <h5 class="decalaration">Declaration</h5>
  522. <div class="codewrapper">
  523. <pre><code class="lang-csharp hljs">public CheckBox(ustring s, bool is_checked = false)</code></pre>
  524. </div>
  525. <h5 class="parameters">Parameters</h5>
  526. <table class="table table-bordered table-striped table-condensed">
  527. <thead>
  528. <tr>
  529. <th>Type</th>
  530. <th>Name</th>
  531. <th>Description</th>
  532. </tr>
  533. </thead>
  534. <tbody>
  535. <tr>
  536. <td><span class="xref">NStack.ustring</span></td>
  537. <td><span class="parametername">s</span></td>
  538. <td>S.</td>
  539. </tr>
  540. <tr>
  541. <td><span class="xref">System.Boolean</span></td>
  542. <td><span class="parametername">is_checked</span></td>
  543. <td>If set to <code>true</code> is checked.</td>
  544. </tr>
  545. </tbody>
  546. </table>
  547. <a id="Terminal_Gui_CheckBox__ctor_" data-uid="Terminal.Gui.CheckBox.#ctor*"></a>
  548. <h4 id="Terminal_Gui_CheckBox__ctor_System_Int32_System_Int32_NStack_ustring_" data-uid="Terminal.Gui.CheckBox.#ctor(System.Int32,System.Int32,NStack.ustring)">CheckBox(Int32, Int32, ustring)</h4>
  549. <div class="markdown level1 summary">
  550. Initializes a new instance of <a class="xref" href="Terminal.Gui.CheckBox.html">CheckBox</a> using <a class="xref" href="Terminal.Gui.LayoutStyle.html#Terminal_Gui_LayoutStyle_Absolute">Absolute</a> layout.
  551. </div>
  552. <div class="markdown level1 conceptual"></div>
  553. <h5 class="decalaration">Declaration</h5>
  554. <div class="codewrapper">
  555. <pre><code class="lang-csharp hljs">public CheckBox(int x, int y, ustring s)</code></pre>
  556. </div>
  557. <h5 class="parameters">Parameters</h5>
  558. <table class="table table-bordered table-striped table-condensed">
  559. <thead>
  560. <tr>
  561. <th>Type</th>
  562. <th>Name</th>
  563. <th>Description</th>
  564. </tr>
  565. </thead>
  566. <tbody>
  567. <tr>
  568. <td><span class="xref">System.Int32</span></td>
  569. <td><span class="parametername">x</span></td>
  570. <td></td>
  571. </tr>
  572. <tr>
  573. <td><span class="xref">System.Int32</span></td>
  574. <td><span class="parametername">y</span></td>
  575. <td></td>
  576. </tr>
  577. <tr>
  578. <td><span class="xref">NStack.ustring</span></td>
  579. <td><span class="parametername">s</span></td>
  580. <td></td>
  581. </tr>
  582. </tbody>
  583. </table>
  584. <h5 id="Terminal_Gui_CheckBox__ctor_System_Int32_System_Int32_NStack_ustring__remarks">Remarks</h5>
  585. <div class="markdown level1 remarks">
  586. The size of <a class="xref" href="Terminal.Gui.CheckBox.html">CheckBox</a> is computed based on the
  587. text length. This <a class="xref" href="Terminal.Gui.CheckBox.html">CheckBox</a> is not toggled.
  588. </div>
  589. <a id="Terminal_Gui_CheckBox__ctor_" data-uid="Terminal.Gui.CheckBox.#ctor*"></a>
  590. <h4 id="Terminal_Gui_CheckBox__ctor_System_Int32_System_Int32_NStack_ustring_System_Boolean_" data-uid="Terminal.Gui.CheckBox.#ctor(System.Int32,System.Int32,NStack.ustring,System.Boolean)">CheckBox(Int32, Int32, ustring, Boolean)</h4>
  591. <div class="markdown level1 summary">
  592. Initializes a new instance of <a class="xref" href="Terminal.Gui.CheckBox.html">CheckBox</a> using <a class="xref" href="Terminal.Gui.LayoutStyle.html#Terminal_Gui_LayoutStyle_Absolute">Absolute</a> layout.
  593. </div>
  594. <div class="markdown level1 conceptual"></div>
  595. <h5 class="decalaration">Declaration</h5>
  596. <div class="codewrapper">
  597. <pre><code class="lang-csharp hljs">public CheckBox(int x, int y, ustring s, bool is_checked)</code></pre>
  598. </div>
  599. <h5 class="parameters">Parameters</h5>
  600. <table class="table table-bordered table-striped table-condensed">
  601. <thead>
  602. <tr>
  603. <th>Type</th>
  604. <th>Name</th>
  605. <th>Description</th>
  606. </tr>
  607. </thead>
  608. <tbody>
  609. <tr>
  610. <td><span class="xref">System.Int32</span></td>
  611. <td><span class="parametername">x</span></td>
  612. <td></td>
  613. </tr>
  614. <tr>
  615. <td><span class="xref">System.Int32</span></td>
  616. <td><span class="parametername">y</span></td>
  617. <td></td>
  618. </tr>
  619. <tr>
  620. <td><span class="xref">NStack.ustring</span></td>
  621. <td><span class="parametername">s</span></td>
  622. <td></td>
  623. </tr>
  624. <tr>
  625. <td><span class="xref">System.Boolean</span></td>
  626. <td><span class="parametername">is_checked</span></td>
  627. <td></td>
  628. </tr>
  629. </tbody>
  630. </table>
  631. <h5 id="Terminal_Gui_CheckBox__ctor_System_Int32_System_Int32_NStack_ustring_System_Boolean__remarks">Remarks</h5>
  632. <div class="markdown level1 remarks">
  633. The size of <a class="xref" href="Terminal.Gui.CheckBox.html">CheckBox</a> is computed based on the
  634. text length.
  635. </div>
  636. <h3 id="properties">Properties
  637. </h3>
  638. <a id="Terminal_Gui_CheckBox_Checked_" data-uid="Terminal.Gui.CheckBox.Checked*"></a>
  639. <h4 id="Terminal_Gui_CheckBox_Checked" data-uid="Terminal.Gui.CheckBox.Checked">Checked</h4>
  640. <div class="markdown level1 summary">
  641. The state of the <a class="xref" href="Terminal.Gui.CheckBox.html">CheckBox</a>
  642. </div>
  643. <div class="markdown level1 conceptual"></div>
  644. <h5 class="decalaration">Declaration</h5>
  645. <div class="codewrapper">
  646. <pre><code class="lang-csharp hljs">public bool Checked { get; set; }</code></pre>
  647. </div>
  648. <h5 class="propertyValue">Property Value</h5>
  649. <table class="table table-bordered table-striped table-condensed">
  650. <thead>
  651. <tr>
  652. <th>Type</th>
  653. <th>Description</th>
  654. </tr>
  655. </thead>
  656. <tbody>
  657. <tr>
  658. <td><span class="xref">System.Boolean</span></td>
  659. <td></td>
  660. </tr>
  661. </tbody>
  662. </table>
  663. <h3 id="methods">Methods
  664. </h3>
  665. <a id="Terminal_Gui_CheckBox_MouseEvent_" data-uid="Terminal.Gui.CheckBox.MouseEvent*"></a>
  666. <h4 id="Terminal_Gui_CheckBox_MouseEvent_Terminal_Gui_MouseEvent_" data-uid="Terminal.Gui.CheckBox.MouseEvent(Terminal.Gui.MouseEvent)">MouseEvent(MouseEvent)</h4>
  667. <div class="markdown level1 summary">
  668. Method invoked when a mouse event is generated
  669. </div>
  670. <div class="markdown level1 conceptual"></div>
  671. <h5 class="decalaration">Declaration</h5>
  672. <div class="codewrapper">
  673. <pre><code class="lang-csharp hljs">public override bool MouseEvent(MouseEvent me)</code></pre>
  674. </div>
  675. <h5 class="parameters">Parameters</h5>
  676. <table class="table table-bordered table-striped table-condensed">
  677. <thead>
  678. <tr>
  679. <th>Type</th>
  680. <th>Name</th>
  681. <th>Description</th>
  682. </tr>
  683. </thead>
  684. <tbody>
  685. <tr>
  686. <td><a class="xref" href="Terminal.Gui.MouseEvent.html">MouseEvent</a></td>
  687. <td><span class="parametername">me</span></td>
  688. <td></td>
  689. </tr>
  690. </tbody>
  691. </table>
  692. <h5 class="returns">Returns</h5>
  693. <table class="table table-bordered table-striped table-condensed">
  694. <thead>
  695. <tr>
  696. <th>Type</th>
  697. <th>Description</th>
  698. </tr>
  699. </thead>
  700. <tbody>
  701. <tr>
  702. <td><span class="xref">System.Boolean</span></td>
  703. <td><code>true</code>, if the event was handled, <code>false</code> otherwise.</td>
  704. </tr>
  705. </tbody>
  706. </table>
  707. <h5 class="overrides">Overrides</h5>
  708. <div><a class="xref" href="Terminal.Gui.Responder.html#Terminal_Gui_Responder_MouseEvent_Terminal_Gui_MouseEvent_">Responder.MouseEvent(MouseEvent)</a></div>
  709. <a id="Terminal_Gui_CheckBox_OnEnter_" data-uid="Terminal.Gui.CheckBox.OnEnter*"></a>
  710. <h4 id="Terminal_Gui_CheckBox_OnEnter_Terminal_Gui_View_" data-uid="Terminal.Gui.CheckBox.OnEnter(Terminal.Gui.View)">OnEnter(View)</h4>
  711. <div class="markdown level1 summary">
  712. Method invoked when a view gets focus.
  713. </div>
  714. <div class="markdown level1 conceptual"></div>
  715. <h5 class="decalaration">Declaration</h5>
  716. <div class="codewrapper">
  717. <pre><code class="lang-csharp hljs">public override bool OnEnter(View view)</code></pre>
  718. </div>
  719. <h5 class="parameters">Parameters</h5>
  720. <table class="table table-bordered table-striped table-condensed">
  721. <thead>
  722. <tr>
  723. <th>Type</th>
  724. <th>Name</th>
  725. <th>Description</th>
  726. </tr>
  727. </thead>
  728. <tbody>
  729. <tr>
  730. <td><a class="xref" href="Terminal.Gui.View.html">View</a></td>
  731. <td><span class="parametername">view</span></td>
  732. <td>The view that is losing focus.</td>
  733. </tr>
  734. </tbody>
  735. </table>
  736. <h5 class="returns">Returns</h5>
  737. <table class="table table-bordered table-striped table-condensed">
  738. <thead>
  739. <tr>
  740. <th>Type</th>
  741. <th>Description</th>
  742. </tr>
  743. </thead>
  744. <tbody>
  745. <tr>
  746. <td><span class="xref">System.Boolean</span></td>
  747. <td><code>true</code>, if the event was handled, <code>false</code> otherwise.</td>
  748. </tr>
  749. </tbody>
  750. </table>
  751. <h5 class="overrides">Overrides</h5>
  752. <div><a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnEnter_Terminal_Gui_View_">View.OnEnter(View)</a></div>
  753. <a id="Terminal_Gui_CheckBox_OnToggled_" data-uid="Terminal.Gui.CheckBox.OnToggled*"></a>
  754. <h4 id="Terminal_Gui_CheckBox_OnToggled_System_Boolean_" data-uid="Terminal.Gui.CheckBox.OnToggled(System.Boolean)">OnToggled(Boolean)</h4>
  755. <div class="markdown level1 summary">
  756. Called when the <a class="xref" href="Terminal.Gui.CheckBox.html#Terminal_Gui_CheckBox_Checked">Checked</a> property changes. Invokes the <a class="xref" href="Terminal.Gui.CheckBox.html#Terminal_Gui_CheckBox_Toggled">Toggled</a> event.
  757. </div>
  758. <div class="markdown level1 conceptual"></div>
  759. <h5 class="decalaration">Declaration</h5>
  760. <div class="codewrapper">
  761. <pre><code class="lang-csharp hljs">public virtual void OnToggled(bool previousChecked)</code></pre>
  762. </div>
  763. <h5 class="parameters">Parameters</h5>
  764. <table class="table table-bordered table-striped table-condensed">
  765. <thead>
  766. <tr>
  767. <th>Type</th>
  768. <th>Name</th>
  769. <th>Description</th>
  770. </tr>
  771. </thead>
  772. <tbody>
  773. <tr>
  774. <td><span class="xref">System.Boolean</span></td>
  775. <td><span class="parametername">previousChecked</span></td>
  776. <td></td>
  777. </tr>
  778. </tbody>
  779. </table>
  780. <a id="Terminal_Gui_CheckBox_PositionCursor_" data-uid="Terminal.Gui.CheckBox.PositionCursor*"></a>
  781. <h4 id="Terminal_Gui_CheckBox_PositionCursor" data-uid="Terminal.Gui.CheckBox.PositionCursor">PositionCursor()</h4>
  782. <div class="markdown level1 summary">
  783. Positions the cursor in the right position based on the currently focused view in the chain.
  784. </div>
  785. <div class="markdown level1 conceptual"></div>
  786. <h5 class="decalaration">Declaration</h5>
  787. <div class="codewrapper">
  788. <pre><code class="lang-csharp hljs">public override void PositionCursor()</code></pre>
  789. </div>
  790. <h5 class="overrides">Overrides</h5>
  791. <div><a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_PositionCursor">View.PositionCursor()</a></div>
  792. <a id="Terminal_Gui_CheckBox_ProcessHotKey_" data-uid="Terminal.Gui.CheckBox.ProcessHotKey*"></a>
  793. <h4 id="Terminal_Gui_CheckBox_ProcessHotKey_Terminal_Gui_KeyEvent_" data-uid="Terminal.Gui.CheckBox.ProcessHotKey(Terminal.Gui.KeyEvent)">ProcessHotKey(KeyEvent)</h4>
  794. <div class="markdown level1 summary">
  795. This method can be overwritten by view that
  796. want to provide accelerator functionality
  797. (Alt-key for example).
  798. </div>
  799. <div class="markdown level1 conceptual"></div>
  800. <h5 class="decalaration">Declaration</h5>
  801. <div class="codewrapper">
  802. <pre><code class="lang-csharp hljs">public override bool ProcessHotKey(KeyEvent kb)</code></pre>
  803. </div>
  804. <h5 class="parameters">Parameters</h5>
  805. <table class="table table-bordered table-striped table-condensed">
  806. <thead>
  807. <tr>
  808. <th>Type</th>
  809. <th>Name</th>
  810. <th>Description</th>
  811. </tr>
  812. </thead>
  813. <tbody>
  814. <tr>
  815. <td><a class="xref" href="Terminal.Gui.KeyEvent.html">KeyEvent</a></td>
  816. <td><span class="parametername">kb</span></td>
  817. <td></td>
  818. </tr>
  819. </tbody>
  820. </table>
  821. <h5 class="returns">Returns</h5>
  822. <table class="table table-bordered table-striped table-condensed">
  823. <thead>
  824. <tr>
  825. <th>Type</th>
  826. <th>Description</th>
  827. </tr>
  828. </thead>
  829. <tbody>
  830. <tr>
  831. <td><span class="xref">System.Boolean</span></td>
  832. <td></td>
  833. </tr>
  834. </tbody>
  835. </table>
  836. <h5 class="overrides">Overrides</h5>
  837. <div><a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ProcessHotKey_Terminal_Gui_KeyEvent_">View.ProcessHotKey(KeyEvent)</a></div>
  838. <h5 id="Terminal_Gui_CheckBox_ProcessHotKey_Terminal_Gui_KeyEvent__remarks">Remarks</h5>
  839. <div class="markdown level1 remarks">
  840. <p>
  841. Before keys are sent to the subview on the
  842. current view, all the views are
  843. processed and the key is passed to the widgets
  844. to allow some of them to process the keystroke
  845. as a hot-key. </p>
  846. <p>
  847. For example, if you implement a button that
  848. has a hotkey ok &quot;o&quot;, you would catch the
  849. combination Alt-o here. If the event is
  850. caught, you must return true to stop the
  851. keystroke from being dispatched to other
  852. views.
  853. </p>
  854. </div>
  855. <a id="Terminal_Gui_CheckBox_ProcessKey_" data-uid="Terminal.Gui.CheckBox.ProcessKey*"></a>
  856. <h4 id="Terminal_Gui_CheckBox_ProcessKey_Terminal_Gui_KeyEvent_" data-uid="Terminal.Gui.CheckBox.ProcessKey(Terminal.Gui.KeyEvent)">ProcessKey(KeyEvent)</h4>
  857. <div class="markdown level1 summary">
  858. If the view is focused, gives the view a
  859. chance to process the keystroke.
  860. </div>
  861. <div class="markdown level1 conceptual"></div>
  862. <h5 class="decalaration">Declaration</h5>
  863. <div class="codewrapper">
  864. <pre><code class="lang-csharp hljs">public override bool ProcessKey(KeyEvent kb)</code></pre>
  865. </div>
  866. <h5 class="parameters">Parameters</h5>
  867. <table class="table table-bordered table-striped table-condensed">
  868. <thead>
  869. <tr>
  870. <th>Type</th>
  871. <th>Name</th>
  872. <th>Description</th>
  873. </tr>
  874. </thead>
  875. <tbody>
  876. <tr>
  877. <td><a class="xref" href="Terminal.Gui.KeyEvent.html">KeyEvent</a></td>
  878. <td><span class="parametername">kb</span></td>
  879. <td></td>
  880. </tr>
  881. </tbody>
  882. </table>
  883. <h5 class="returns">Returns</h5>
  884. <table class="table table-bordered table-striped table-condensed">
  885. <thead>
  886. <tr>
  887. <th>Type</th>
  888. <th>Description</th>
  889. </tr>
  890. </thead>
  891. <tbody>
  892. <tr>
  893. <td><span class="xref">System.Boolean</span></td>
  894. <td></td>
  895. </tr>
  896. </tbody>
  897. </table>
  898. <h5 class="overrides">Overrides</h5>
  899. <div><a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ProcessKey_Terminal_Gui_KeyEvent_">View.ProcessKey(KeyEvent)</a></div>
  900. <h5 id="Terminal_Gui_CheckBox_ProcessKey_Terminal_Gui_KeyEvent__remarks">Remarks</h5>
  901. <div class="markdown level1 remarks">
  902. <p>
  903. Views can override this method if they are
  904. interested in processing the given keystroke.
  905. If they consume the keystroke, they must
  906. return true to stop the keystroke from being
  907. processed by other widgets or consumed by the
  908. widget engine. If they return false, the
  909. keystroke will be passed using the ProcessColdKey
  910. method to other views to process.
  911. </p>
  912. <p>
  913. The View implementation does nothing but return false,
  914. so it is not necessary to call base.ProcessKey if you
  915. derive directly from View, but you should if you derive
  916. other View subclasses.
  917. </p>
  918. </div>
  919. <a id="Terminal_Gui_CheckBox_UpdateTextFormatterText_" data-uid="Terminal.Gui.CheckBox.UpdateTextFormatterText*"></a>
  920. <h4 id="Terminal_Gui_CheckBox_UpdateTextFormatterText" data-uid="Terminal.Gui.CheckBox.UpdateTextFormatterText">UpdateTextFormatterText()</h4>
  921. <div class="markdown level1 summary">
  922. Can be overridden if the <a class="xref" href="Terminal.Gui.TextFormatter.html#Terminal_Gui_TextFormatter_Text">Text</a> has
  923. different format than the default.
  924. </div>
  925. <div class="markdown level1 conceptual"></div>
  926. <h5 class="decalaration">Declaration</h5>
  927. <div class="codewrapper">
  928. <pre><code class="lang-csharp hljs">protected override void UpdateTextFormatterText()</code></pre>
  929. </div>
  930. <h5 class="overrides">Overrides</h5>
  931. <div><a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_UpdateTextFormatterText">View.UpdateTextFormatterText()</a></div>
  932. <h3 id="events">Events
  933. </h3>
  934. <h4 id="Terminal_Gui_CheckBox_Toggled" data-uid="Terminal.Gui.CheckBox.Toggled">Toggled</h4>
  935. <div class="markdown level1 summary">
  936. Toggled event, raised when the <a class="xref" href="Terminal.Gui.CheckBox.html">CheckBox</a> is toggled.
  937. </div>
  938. <div class="markdown level1 conceptual"></div>
  939. <h5 class="decalaration">Declaration</h5>
  940. <div class="codewrapper">
  941. <pre><code class="lang-csharp hljs">public event Action&lt;bool&gt; Toggled</code></pre>
  942. </div>
  943. <h5 class="eventType">Event Type</h5>
  944. <table class="table table-bordered table-striped table-condensed">
  945. <thead>
  946. <tr>
  947. <th>Type</th>
  948. <th>Description</th>
  949. </tr>
  950. </thead>
  951. <tbody>
  952. <tr>
  953. <td><span class="xref">System.Action</span>&lt;<span class="xref">System.Boolean</span>&gt;</td>
  954. <td></td>
  955. </tr>
  956. </tbody>
  957. </table>
  958. <h5 id="Terminal_Gui_CheckBox_Toggled_remarks">Remarks</h5>
  959. <div class="markdown level1 remarks">
  960. Client code can hook up to this event, it is
  961. raised when the <a class="xref" href="Terminal.Gui.CheckBox.html">CheckBox</a> is activated either with
  962. the mouse or the keyboard. The passed <code>bool</code> contains the previous state.
  963. </div>
  964. <h3 id="implements">Implements</h3>
  965. <div>
  966. <span class="xref">System.IDisposable</span>
  967. </div>
  968. <div>
  969. <span class="xref">System.ComponentModel.ISupportInitializeNotification</span>
  970. </div>
  971. <div>
  972. <span class="xref">System.ComponentModel.ISupportInitialize</span>
  973. </div>
  974. </article>
  975. </div>
  976. <div class="hidden-sm col-md-2" role="complementary">
  977. <div class="sideaffix">
  978. <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
  979. <h5>In This Article</h5>
  980. <div></div>
  981. </nav>
  982. </div>
  983. </div>
  984. </div>
  985. </div>
  986. <footer>
  987. <div class="grad-bottom"></div>
  988. <div class="footer">
  989. <div class="container">
  990. <span class="pull-right">
  991. <a href="#top">Back to top</a>
  992. </span>
  993. <span>Generated by <strong>DocFX</strong></span>
  994. </div>
  995. </div>
  996. </footer>
  997. </div>
  998. <script type="text/javascript" src="../../styles/docfx.vendor.js"></script>
  999. <script type="text/javascript" src="../../styles/docfx.js"></script>
  1000. <script type="text/javascript" src="../../styles/main.js"></script>
  1001. </body>
  1002. </html>