Terminal.Gui.CheckBox.html 35 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896
  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.56.7.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 classs="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_Added">View.Added</a>
  96. </div>
  97. <div>
  98. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Removed">View.Removed</a>
  99. </div>
  100. <div>
  101. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Enter">View.Enter</a>
  102. </div>
  103. <div>
  104. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Leave">View.Leave</a>
  105. </div>
  106. <div>
  107. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_MouseEnter">View.MouseEnter</a>
  108. </div>
  109. <div>
  110. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_MouseLeave">View.MouseLeave</a>
  111. </div>
  112. <div>
  113. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_MouseClick">View.MouseClick</a>
  114. </div>
  115. <div>
  116. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_HotKey">View.HotKey</a>
  117. </div>
  118. <div>
  119. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_HotKeySpecifier">View.HotKeySpecifier</a>
  120. </div>
  121. <div>
  122. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Shortcut">View.Shortcut</a>
  123. </div>
  124. <div>
  125. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ShortcutTag">View.ShortcutTag</a>
  126. </div>
  127. <div>
  128. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ShortcutAction">View.ShortcutAction</a>
  129. </div>
  130. <div>
  131. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Data">View.Data</a>
  132. </div>
  133. <div>
  134. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Driver">View.Driver</a>
  135. </div>
  136. <div>
  137. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Subviews">View.Subviews</a>
  138. </div>
  139. <div>
  140. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_TabIndexes">View.TabIndexes</a>
  141. </div>
  142. <div>
  143. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_TabIndex">View.TabIndex</a>
  144. </div>
  145. <div>
  146. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_TabStop">View.TabStop</a>
  147. </div>
  148. <div>
  149. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_CanFocus">View.CanFocus</a>
  150. </div>
  151. <div>
  152. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Id">View.Id</a>
  153. </div>
  154. <div>
  155. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_IsCurrentTop">View.IsCurrentTop</a>
  156. </div>
  157. <div>
  158. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_WantMousePositionReports">View.WantMousePositionReports</a>
  159. </div>
  160. <div>
  161. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_WantContinuousButtonPressed">View.WantContinuousButtonPressed</a>
  162. </div>
  163. <div>
  164. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Frame">View.Frame</a>
  165. </div>
  166. <div>
  167. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_LayoutStyle">View.LayoutStyle</a>
  168. </div>
  169. <div>
  170. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Bounds">View.Bounds</a>
  171. </div>
  172. <div>
  173. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_X">View.X</a>
  174. </div>
  175. <div>
  176. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Y">View.Y</a>
  177. </div>
  178. <div>
  179. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Width">View.Width</a>
  180. </div>
  181. <div>
  182. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Height">View.Height</a>
  183. </div>
  184. <div>
  185. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SuperView">View.SuperView</a>
  186. </div>
  187. <div>
  188. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SetNeedsDisplay">View.SetNeedsDisplay()</a>
  189. </div>
  190. <div>
  191. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ClearLayoutNeeded">View.ClearLayoutNeeded()</a>
  192. </div>
  193. <div>
  194. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SetNeedsDisplay_Terminal_Gui_Rect_">View.SetNeedsDisplay(Rect)</a>
  195. </div>
  196. <div>
  197. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SetChildNeedsDisplay">View.SetChildNeedsDisplay()</a>
  198. </div>
  199. <div>
  200. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Add_Terminal_Gui_View_">View.Add(View)</a>
  201. </div>
  202. <div>
  203. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Add_Terminal_Gui_View___">View.Add(View[])</a>
  204. </div>
  205. <div>
  206. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_RemoveAll">View.RemoveAll()</a>
  207. </div>
  208. <div>
  209. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Remove_Terminal_Gui_View_">View.Remove(View)</a>
  210. </div>
  211. <div>
  212. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_BringSubviewToFront_Terminal_Gui_View_">View.BringSubviewToFront(View)</a>
  213. </div>
  214. <div>
  215. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SendSubviewToBack_Terminal_Gui_View_">View.SendSubviewToBack(View)</a>
  216. </div>
  217. <div>
  218. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SendSubviewBackwards_Terminal_Gui_View_">View.SendSubviewBackwards(View)</a>
  219. </div>
  220. <div>
  221. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_BringSubviewForward_Terminal_Gui_View_">View.BringSubviewForward(View)</a>
  222. </div>
  223. <div>
  224. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Clear">View.Clear()</a>
  225. </div>
  226. <div>
  227. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Clear_Terminal_Gui_Rect_">View.Clear(Rect)</a>
  228. </div>
  229. <div>
  230. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ScreenToView_System_Int32_System_Int32_">View.ScreenToView(Int32, Int32)</a>
  231. </div>
  232. <div>
  233. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ClipToBounds">View.ClipToBounds()</a>
  234. </div>
  235. <div>
  236. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SetClip_Terminal_Gui_Rect_">View.SetClip(Rect)</a>
  237. </div>
  238. <div>
  239. <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>
  240. </div>
  241. <div>
  242. <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>
  243. </div>
  244. <div>
  245. <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>
  246. </div>
  247. <div>
  248. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Move_System_Int32_System_Int32_">View.Move(Int32, Int32)</a>
  249. </div>
  250. <div>
  251. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_HasFocus">View.HasFocus</a>
  252. </div>
  253. <div>
  254. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnAdded_Terminal_Gui_View_">View.OnAdded(View)</a>
  255. </div>
  256. <div>
  257. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnRemoved_Terminal_Gui_View_">View.OnRemoved(View)</a>
  258. </div>
  259. <div>
  260. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnLeave_Terminal_Gui_View_">View.OnLeave(View)</a>
  261. </div>
  262. <div>
  263. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Focused">View.Focused</a>
  264. </div>
  265. <div>
  266. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_MostFocused">View.MostFocused</a>
  267. </div>
  268. <div>
  269. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ColorScheme">View.ColorScheme</a>
  270. </div>
  271. <div>
  272. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_AddRune_System_Int32_System_Int32_System_Rune_">View.AddRune(Int32, Int32, Rune)</a>
  273. </div>
  274. <div>
  275. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ClearNeedsDisplay">View.ClearNeedsDisplay()</a>
  276. </div>
  277. <div>
  278. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_DrawContent">View.DrawContent</a>
  279. </div>
  280. <div>
  281. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnDrawContent_Terminal_Gui_Rect_">View.OnDrawContent(Rect)</a>
  282. </div>
  283. <div>
  284. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SetFocus">View.SetFocus()</a>
  285. </div>
  286. <div>
  287. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_KeyPress">View.KeyPress</a>
  288. </div>
  289. <div>
  290. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ProcessHotKey_Terminal_Gui_KeyEvent_">View.ProcessHotKey(KeyEvent)</a>
  291. </div>
  292. <div>
  293. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ProcessColdKey_Terminal_Gui_KeyEvent_">View.ProcessColdKey(KeyEvent)</a>
  294. </div>
  295. <div>
  296. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_KeyDown">View.KeyDown</a>
  297. </div>
  298. <div>
  299. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnKeyDown_Terminal_Gui_KeyEvent_">View.OnKeyDown(KeyEvent)</a>
  300. </div>
  301. <div>
  302. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_KeyUp">View.KeyUp</a>
  303. </div>
  304. <div>
  305. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnKeyUp_Terminal_Gui_KeyEvent_">View.OnKeyUp(KeyEvent)</a>
  306. </div>
  307. <div>
  308. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_EnsureFocus">View.EnsureFocus()</a>
  309. </div>
  310. <div>
  311. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_FocusFirst">View.FocusFirst()</a>
  312. </div>
  313. <div>
  314. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_FocusLast">View.FocusLast()</a>
  315. </div>
  316. <div>
  317. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_FocusPrev">View.FocusPrev()</a>
  318. </div>
  319. <div>
  320. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_FocusNext">View.FocusNext()</a>
  321. </div>
  322. <div>
  323. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_LayoutStarted">View.LayoutStarted</a>
  324. </div>
  325. <div>
  326. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_LayoutComplete">View.LayoutComplete</a>
  327. </div>
  328. <div>
  329. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Initialized">View.Initialized</a>
  330. </div>
  331. <div>
  332. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_LayoutSubviews">View.LayoutSubviews()</a>
  333. </div>
  334. <div>
  335. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_AutoSize">View.AutoSize</a>
  336. </div>
  337. <div>
  338. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_TextAlignment">View.TextAlignment</a>
  339. </div>
  340. <div>
  341. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_IsInitialized">View.IsInitialized</a>
  342. </div>
  343. <div>
  344. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ToString">View.ToString()</a>
  345. </div>
  346. <div>
  347. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnMouseEnter_Terminal_Gui_MouseEvent_">View.OnMouseEnter(MouseEvent)</a>
  348. </div>
  349. <div>
  350. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnMouseLeave_Terminal_Gui_MouseEvent_">View.OnMouseLeave(MouseEvent)</a>
  351. </div>
  352. <div>
  353. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnMouseEvent_Terminal_Gui_MouseEvent_">View.OnMouseEvent(MouseEvent)</a>
  354. </div>
  355. <div>
  356. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnMouseClick_Terminal_Gui_View_MouseEventArgs_">View.OnMouseClick(View.MouseEventArgs)</a>
  357. </div>
  358. <div>
  359. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Dispose_System_Boolean_">View.Dispose(Boolean)</a>
  360. </div>
  361. <div>
  362. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_BeginInit">View.BeginInit()</a>
  363. </div>
  364. <div>
  365. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_EndInit">View.EndInit()</a>
  366. </div>
  367. <div>
  368. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Visible">View.Visible</a>
  369. </div>
  370. <div>
  371. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SetWidth_System_Int32_System_Int32__">View.SetWidth(Int32, Int32)</a>
  372. </div>
  373. <div>
  374. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SetHeight_System_Int32_System_Int32__">View.SetHeight(Int32, Int32)</a>
  375. </div>
  376. <div>
  377. <a class="xref" href="Terminal.Gui.Responder.html#Terminal_Gui_Responder_Dispose">Responder.Dispose()</a>
  378. </div>
  379. <div>
  380. <span class="xref">System.Object.Equals(System.Object)</span>
  381. </div>
  382. <div>
  383. <span class="xref">System.Object.Equals(System.Object, System.Object)</span>
  384. </div>
  385. <div>
  386. <span class="xref">System.Object.GetHashCode()</span>
  387. </div>
  388. <div>
  389. <span class="xref">System.Object.GetType()</span>
  390. </div>
  391. <div>
  392. <span class="xref">System.Object.MemberwiseClone()</span>
  393. </div>
  394. <div>
  395. <span class="xref">System.Object.ReferenceEquals(System.Object, System.Object)</span>
  396. </div>
  397. </div>
  398. <h6><strong>Namespace</strong>: <a class="xref" href="Terminal.Gui.html">Terminal.Gui</a></h6>
  399. <h6><strong>Assembly</strong>: Terminal.Gui.dll</h6>
  400. <h5 id="Terminal_Gui_CheckBox_syntax">Syntax</h5>
  401. <div class="codewrapper">
  402. <pre><code class="lang-csharp hljs">public class CheckBox : View, IDisposable, ISupportInitializeNotification, ISupportInitialize</code></pre>
  403. </div>
  404. <h3 id="constructors">Constructors
  405. </h3>
  406. <a id="Terminal_Gui_CheckBox__ctor_" data-uid="Terminal.Gui.CheckBox.#ctor*"></a>
  407. <h4 id="Terminal_Gui_CheckBox__ctor" data-uid="Terminal.Gui.CheckBox.#ctor">CheckBox()</h4>
  408. <div class="markdown level1 summary">
  409. 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.
  410. </div>
  411. <div class="markdown level1 conceptual"></div>
  412. <h5 class="decalaration">Declaration</h5>
  413. <div class="codewrapper">
  414. <pre><code class="lang-csharp hljs">public CheckBox()</code></pre>
  415. </div>
  416. <a id="Terminal_Gui_CheckBox__ctor_" data-uid="Terminal.Gui.CheckBox.#ctor*"></a>
  417. <h4 id="Terminal_Gui_CheckBox__ctor_NStack_ustring_System_Boolean_" data-uid="Terminal.Gui.CheckBox.#ctor(NStack.ustring,System.Boolean)">CheckBox(ustring, Boolean)</h4>
  418. <div class="markdown level1 summary">
  419. 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.
  420. </div>
  421. <div class="markdown level1 conceptual"></div>
  422. <h5 class="decalaration">Declaration</h5>
  423. <div class="codewrapper">
  424. <pre><code class="lang-csharp hljs">public CheckBox(ustring s, bool is_checked = false)</code></pre>
  425. </div>
  426. <h5 class="parameters">Parameters</h5>
  427. <table class="table table-bordered table-striped table-condensed">
  428. <thead>
  429. <tr>
  430. <th>Type</th>
  431. <th>Name</th>
  432. <th>Description</th>
  433. </tr>
  434. </thead>
  435. <tbody>
  436. <tr>
  437. <td><span class="xref">NStack.ustring</span></td>
  438. <td><span class="parametername">s</span></td>
  439. <td>S.</td>
  440. </tr>
  441. <tr>
  442. <td><span class="xref">System.Boolean</span></td>
  443. <td><span class="parametername">is_checked</span></td>
  444. <td>If set to <code>true</code> is checked.</td>
  445. </tr>
  446. </tbody>
  447. </table>
  448. <a id="Terminal_Gui_CheckBox__ctor_" data-uid="Terminal.Gui.CheckBox.#ctor*"></a>
  449. <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>
  450. <div class="markdown level1 summary">
  451. 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.
  452. </div>
  453. <div class="markdown level1 conceptual"></div>
  454. <h5 class="decalaration">Declaration</h5>
  455. <div class="codewrapper">
  456. <pre><code class="lang-csharp hljs">public CheckBox(int x, int y, ustring s)</code></pre>
  457. </div>
  458. <h5 class="parameters">Parameters</h5>
  459. <table class="table table-bordered table-striped table-condensed">
  460. <thead>
  461. <tr>
  462. <th>Type</th>
  463. <th>Name</th>
  464. <th>Description</th>
  465. </tr>
  466. </thead>
  467. <tbody>
  468. <tr>
  469. <td><span class="xref">System.Int32</span></td>
  470. <td><span class="parametername">x</span></td>
  471. <td></td>
  472. </tr>
  473. <tr>
  474. <td><span class="xref">System.Int32</span></td>
  475. <td><span class="parametername">y</span></td>
  476. <td></td>
  477. </tr>
  478. <tr>
  479. <td><span class="xref">NStack.ustring</span></td>
  480. <td><span class="parametername">s</span></td>
  481. <td></td>
  482. </tr>
  483. </tbody>
  484. </table>
  485. <h5 id="Terminal_Gui_CheckBox__ctor_System_Int32_System_Int32_NStack_ustring__remarks">Remarks</h5>
  486. <div class="markdown level1 remarks">
  487. The size of <a class="xref" href="Terminal.Gui.CheckBox.html">CheckBox</a> is computed based on the
  488. text length. This <a class="xref" href="Terminal.Gui.CheckBox.html">CheckBox</a> is not toggled.
  489. </div>
  490. <a id="Terminal_Gui_CheckBox__ctor_" data-uid="Terminal.Gui.CheckBox.#ctor*"></a>
  491. <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>
  492. <div class="markdown level1 summary">
  493. 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.
  494. </div>
  495. <div class="markdown level1 conceptual"></div>
  496. <h5 class="decalaration">Declaration</h5>
  497. <div class="codewrapper">
  498. <pre><code class="lang-csharp hljs">public CheckBox(int x, int y, ustring s, bool is_checked)</code></pre>
  499. </div>
  500. <h5 class="parameters">Parameters</h5>
  501. <table class="table table-bordered table-striped table-condensed">
  502. <thead>
  503. <tr>
  504. <th>Type</th>
  505. <th>Name</th>
  506. <th>Description</th>
  507. </tr>
  508. </thead>
  509. <tbody>
  510. <tr>
  511. <td><span class="xref">System.Int32</span></td>
  512. <td><span class="parametername">x</span></td>
  513. <td></td>
  514. </tr>
  515. <tr>
  516. <td><span class="xref">System.Int32</span></td>
  517. <td><span class="parametername">y</span></td>
  518. <td></td>
  519. </tr>
  520. <tr>
  521. <td><span class="xref">NStack.ustring</span></td>
  522. <td><span class="parametername">s</span></td>
  523. <td></td>
  524. </tr>
  525. <tr>
  526. <td><span class="xref">System.Boolean</span></td>
  527. <td><span class="parametername">is_checked</span></td>
  528. <td></td>
  529. </tr>
  530. </tbody>
  531. </table>
  532. <h5 id="Terminal_Gui_CheckBox__ctor_System_Int32_System_Int32_NStack_ustring_System_Boolean__remarks">Remarks</h5>
  533. <div class="markdown level1 remarks">
  534. The size of <a class="xref" href="Terminal.Gui.CheckBox.html">CheckBox</a> is computed based on the
  535. text length.
  536. </div>
  537. <h3 id="properties">Properties
  538. </h3>
  539. <a id="Terminal_Gui_CheckBox_Checked_" data-uid="Terminal.Gui.CheckBox.Checked*"></a>
  540. <h4 id="Terminal_Gui_CheckBox_Checked" data-uid="Terminal.Gui.CheckBox.Checked">Checked</h4>
  541. <div class="markdown level1 summary">
  542. The state of the <a class="xref" href="Terminal.Gui.CheckBox.html">CheckBox</a>
  543. </div>
  544. <div class="markdown level1 conceptual"></div>
  545. <h5 class="decalaration">Declaration</h5>
  546. <div class="codewrapper">
  547. <pre><code class="lang-csharp hljs">public bool Checked { get; set; }</code></pre>
  548. </div>
  549. <h5 class="propertyValue">Property Value</h5>
  550. <table class="table table-bordered table-striped table-condensed">
  551. <thead>
  552. <tr>
  553. <th>Type</th>
  554. <th>Description</th>
  555. </tr>
  556. </thead>
  557. <tbody>
  558. <tr>
  559. <td><span class="xref">System.Boolean</span></td>
  560. <td></td>
  561. </tr>
  562. </tbody>
  563. </table>
  564. <a id="Terminal_Gui_CheckBox_Text_" data-uid="Terminal.Gui.CheckBox.Text*"></a>
  565. <h4 id="Terminal_Gui_CheckBox_Text" data-uid="Terminal.Gui.CheckBox.Text">Text</h4>
  566. <div class="markdown level1 summary">
  567. The text displayed by this <a class="xref" href="Terminal.Gui.CheckBox.html">CheckBox</a>
  568. </div>
  569. <div class="markdown level1 conceptual"></div>
  570. <h5 class="decalaration">Declaration</h5>
  571. <div class="codewrapper">
  572. <pre><code class="lang-csharp hljs">public ustring Text { get; set; }</code></pre>
  573. </div>
  574. <h5 class="propertyValue">Property Value</h5>
  575. <table class="table table-bordered table-striped table-condensed">
  576. <thead>
  577. <tr>
  578. <th>Type</th>
  579. <th>Description</th>
  580. </tr>
  581. </thead>
  582. <tbody>
  583. <tr>
  584. <td><span class="xref">NStack.ustring</span></td>
  585. <td></td>
  586. </tr>
  587. </tbody>
  588. </table>
  589. <h3 id="methods">Methods
  590. </h3>
  591. <a id="Terminal_Gui_CheckBox_MouseEvent_" data-uid="Terminal.Gui.CheckBox.MouseEvent*"></a>
  592. <h4 id="Terminal_Gui_CheckBox_MouseEvent_Terminal_Gui_MouseEvent_" data-uid="Terminal.Gui.CheckBox.MouseEvent(Terminal.Gui.MouseEvent)">MouseEvent(MouseEvent)</h4>
  593. <div class="markdown level1 summary"></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 override bool MouseEvent(MouseEvent me)</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><a class="xref" href="Terminal.Gui.MouseEvent.html">MouseEvent</a></td>
  611. <td><span class="parametername">me</span></td>
  612. <td></td>
  613. </tr>
  614. </tbody>
  615. </table>
  616. <h5 class="returns">Returns</h5>
  617. <table class="table table-bordered table-striped table-condensed">
  618. <thead>
  619. <tr>
  620. <th>Type</th>
  621. <th>Description</th>
  622. </tr>
  623. </thead>
  624. <tbody>
  625. <tr>
  626. <td><span class="xref">System.Boolean</span></td>
  627. <td></td>
  628. </tr>
  629. </tbody>
  630. </table>
  631. <h5 class="overrides">Overrides</h5>
  632. <div><a class="xref" href="Terminal.Gui.Responder.html#Terminal_Gui_Responder_MouseEvent_Terminal_Gui_MouseEvent_">Responder.MouseEvent(MouseEvent)</a></div>
  633. <a id="Terminal_Gui_CheckBox_OnEnter_" data-uid="Terminal.Gui.CheckBox.OnEnter*"></a>
  634. <h4 id="Terminal_Gui_CheckBox_OnEnter_Terminal_Gui_View_" data-uid="Terminal.Gui.CheckBox.OnEnter(Terminal.Gui.View)">OnEnter(View)</h4>
  635. <div class="markdown level1 summary"></div>
  636. <div class="markdown level1 conceptual"></div>
  637. <h5 class="decalaration">Declaration</h5>
  638. <div class="codewrapper">
  639. <pre><code class="lang-csharp hljs">public override bool OnEnter(View view)</code></pre>
  640. </div>
  641. <h5 class="parameters">Parameters</h5>
  642. <table class="table table-bordered table-striped table-condensed">
  643. <thead>
  644. <tr>
  645. <th>Type</th>
  646. <th>Name</th>
  647. <th>Description</th>
  648. </tr>
  649. </thead>
  650. <tbody>
  651. <tr>
  652. <td><a class="xref" href="Terminal.Gui.View.html">View</a></td>
  653. <td><span class="parametername">view</span></td>
  654. <td></td>
  655. </tr>
  656. </tbody>
  657. </table>
  658. <h5 class="returns">Returns</h5>
  659. <table class="table table-bordered table-striped table-condensed">
  660. <thead>
  661. <tr>
  662. <th>Type</th>
  663. <th>Description</th>
  664. </tr>
  665. </thead>
  666. <tbody>
  667. <tr>
  668. <td><span class="xref">System.Boolean</span></td>
  669. <td></td>
  670. </tr>
  671. </tbody>
  672. </table>
  673. <h5 class="overrides">Overrides</h5>
  674. <div><a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnEnter_Terminal_Gui_View_">View.OnEnter(View)</a></div>
  675. <a id="Terminal_Gui_CheckBox_OnToggled_" data-uid="Terminal.Gui.CheckBox.OnToggled*"></a>
  676. <h4 id="Terminal_Gui_CheckBox_OnToggled_System_Boolean_" data-uid="Terminal.Gui.CheckBox.OnToggled(System.Boolean)">OnToggled(Boolean)</h4>
  677. <div class="markdown level1 summary">
  678. 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.
  679. </div>
  680. <div class="markdown level1 conceptual"></div>
  681. <h5 class="decalaration">Declaration</h5>
  682. <div class="codewrapper">
  683. <pre><code class="lang-csharp hljs">public virtual void OnToggled(bool previousChecked)</code></pre>
  684. </div>
  685. <h5 class="parameters">Parameters</h5>
  686. <table class="table table-bordered table-striped table-condensed">
  687. <thead>
  688. <tr>
  689. <th>Type</th>
  690. <th>Name</th>
  691. <th>Description</th>
  692. </tr>
  693. </thead>
  694. <tbody>
  695. <tr>
  696. <td><span class="xref">System.Boolean</span></td>
  697. <td><span class="parametername">previousChecked</span></td>
  698. <td></td>
  699. </tr>
  700. </tbody>
  701. </table>
  702. <a id="Terminal_Gui_CheckBox_PositionCursor_" data-uid="Terminal.Gui.CheckBox.PositionCursor*"></a>
  703. <h4 id="Terminal_Gui_CheckBox_PositionCursor" data-uid="Terminal.Gui.CheckBox.PositionCursor">PositionCursor()</h4>
  704. <div class="markdown level1 summary"></div>
  705. <div class="markdown level1 conceptual"></div>
  706. <h5 class="decalaration">Declaration</h5>
  707. <div class="codewrapper">
  708. <pre><code class="lang-csharp hljs">public override void PositionCursor()</code></pre>
  709. </div>
  710. <h5 class="overrides">Overrides</h5>
  711. <div><a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_PositionCursor">View.PositionCursor()</a></div>
  712. <a id="Terminal_Gui_CheckBox_ProcessKey_" data-uid="Terminal.Gui.CheckBox.ProcessKey*"></a>
  713. <h4 id="Terminal_Gui_CheckBox_ProcessKey_Terminal_Gui_KeyEvent_" data-uid="Terminal.Gui.CheckBox.ProcessKey(Terminal.Gui.KeyEvent)">ProcessKey(KeyEvent)</h4>
  714. <div class="markdown level1 summary"></div>
  715. <div class="markdown level1 conceptual"></div>
  716. <h5 class="decalaration">Declaration</h5>
  717. <div class="codewrapper">
  718. <pre><code class="lang-csharp hljs">public override bool ProcessKey(KeyEvent kb)</code></pre>
  719. </div>
  720. <h5 class="parameters">Parameters</h5>
  721. <table class="table table-bordered table-striped table-condensed">
  722. <thead>
  723. <tr>
  724. <th>Type</th>
  725. <th>Name</th>
  726. <th>Description</th>
  727. </tr>
  728. </thead>
  729. <tbody>
  730. <tr>
  731. <td><a class="xref" href="Terminal.Gui.KeyEvent.html">KeyEvent</a></td>
  732. <td><span class="parametername">kb</span></td>
  733. <td></td>
  734. </tr>
  735. </tbody>
  736. </table>
  737. <h5 class="returns">Returns</h5>
  738. <table class="table table-bordered table-striped table-condensed">
  739. <thead>
  740. <tr>
  741. <th>Type</th>
  742. <th>Description</th>
  743. </tr>
  744. </thead>
  745. <tbody>
  746. <tr>
  747. <td><span class="xref">System.Boolean</span></td>
  748. <td></td>
  749. </tr>
  750. </tbody>
  751. </table>
  752. <h5 class="overrides">Overrides</h5>
  753. <div><a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ProcessKey_Terminal_Gui_KeyEvent_">View.ProcessKey(KeyEvent)</a></div>
  754. <a id="Terminal_Gui_CheckBox_Redraw_" data-uid="Terminal.Gui.CheckBox.Redraw*"></a>
  755. <h4 id="Terminal_Gui_CheckBox_Redraw_Terminal_Gui_Rect_" data-uid="Terminal.Gui.CheckBox.Redraw(Terminal.Gui.Rect)">Redraw(Rect)</h4>
  756. <div class="markdown level1 summary"></div>
  757. <div class="markdown level1 conceptual"></div>
  758. <h5 class="decalaration">Declaration</h5>
  759. <div class="codewrapper">
  760. <pre><code class="lang-csharp hljs">public override void Redraw(Rect bounds)</code></pre>
  761. </div>
  762. <h5 class="parameters">Parameters</h5>
  763. <table class="table table-bordered table-striped table-condensed">
  764. <thead>
  765. <tr>
  766. <th>Type</th>
  767. <th>Name</th>
  768. <th>Description</th>
  769. </tr>
  770. </thead>
  771. <tbody>
  772. <tr>
  773. <td><a class="xref" href="Terminal.Gui.Rect.html">Rect</a></td>
  774. <td><span class="parametername">bounds</span></td>
  775. <td></td>
  776. </tr>
  777. </tbody>
  778. </table>
  779. <h5 class="overrides">Overrides</h5>
  780. <div><a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Redraw_Terminal_Gui_Rect_">View.Redraw(Rect)</a></div>
  781. <h3 id="events">Events
  782. </h3>
  783. <h4 id="Terminal_Gui_CheckBox_Toggled" data-uid="Terminal.Gui.CheckBox.Toggled">Toggled</h4>
  784. <div class="markdown level1 summary">
  785. Toggled event, raised when the <a class="xref" href="Terminal.Gui.CheckBox.html">CheckBox</a> is toggled.
  786. </div>
  787. <div class="markdown level1 conceptual"></div>
  788. <h5 class="decalaration">Declaration</h5>
  789. <div class="codewrapper">
  790. <pre><code class="lang-csharp hljs">public event Action&lt;bool&gt; Toggled</code></pre>
  791. </div>
  792. <h5 class="eventType">Event Type</h5>
  793. <table class="table table-bordered table-striped table-condensed">
  794. <thead>
  795. <tr>
  796. <th>Type</th>
  797. <th>Description</th>
  798. </tr>
  799. </thead>
  800. <tbody>
  801. <tr>
  802. <td><span class="xref">System.Action</span>&lt;<span class="xref">System.Boolean</span>&gt;</td>
  803. <td></td>
  804. </tr>
  805. </tbody>
  806. </table>
  807. <h5 id="Terminal_Gui_CheckBox_Toggled_remarks">Remarks</h5>
  808. <div class="markdown level1 remarks">
  809. Client code can hook up to this event, it is
  810. raised when the <a class="xref" href="Terminal.Gui.CheckBox.html">CheckBox</a> is activated either with
  811. the mouse or the keyboard. The passed <code>bool</code> contains the previous state.
  812. </div>
  813. <h3 id="implements">Implements</h3>
  814. <div>
  815. <span class="xref">System.IDisposable</span>
  816. </div>
  817. <div>
  818. <span class="xref">System.ComponentModel.ISupportInitializeNotification</span>
  819. </div>
  820. <div>
  821. <span class="xref">System.ComponentModel.ISupportInitialize</span>
  822. </div>
  823. </article>
  824. </div>
  825. <div class="hidden-sm col-md-2" role="complementary">
  826. <div class="sideaffix">
  827. <div class="contribution">
  828. <ul class="nav">
  829. </ul>
  830. </div>
  831. <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
  832. <h5>In This Article</h5>
  833. <div></div>
  834. </nav>
  835. </div>
  836. </div>
  837. </div>
  838. </div>
  839. <footer>
  840. <div class="grad-bottom"></div>
  841. <div class="footer">
  842. <div class="container">
  843. <span class="pull-right">
  844. <a href="#top">Back to top</a>
  845. </span>
  846. <span>Generated by <strong>DocFX</strong></span>
  847. </div>
  848. </div>
  849. </footer>
  850. </div>
  851. <script type="text/javascript" src="../../styles/docfx.vendor.js"></script>
  852. <script type="text/javascript" src="../../styles/docfx.js"></script>
  853. <script type="text/javascript" src="../../styles/main.js"></script>
  854. </body>
  855. </html>