Terminal.Gui.CheckBox.html 27 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712
  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.54.0.0">
  13. <link rel="shortcut icon" href="../../favicon.ico">
  14. <link rel="stylesheet" href="../../styles/docfx.vendor.css">
  15. <link rel="stylesheet" href="../../styles/docfx.css">
  16. <link rel="stylesheet" href="../../styles/main.css">
  17. <link href="https://fonts.googleapis.com/css?family=Roboto" rel="stylesheet">
  18. <meta property="docfx:navrel" content="../../toc.html">
  19. <meta property="docfx:tocrel" content="toc.html">
  20. <meta property="docfx:rel" content="../../">
  21. </head> <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.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.Collections.IEnumerable</span></div>
  89. </div>
  90. <div class="inheritedMembers">
  91. <h5>Inherited Members</h5>
  92. <div>
  93. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Enter">View.Enter</a>
  94. </div>
  95. <div>
  96. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Leave">View.Leave</a>
  97. </div>
  98. <div>
  99. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_MouseEnter">View.MouseEnter</a>
  100. </div>
  101. <div>
  102. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_MouseLeave">View.MouseLeave</a>
  103. </div>
  104. <div>
  105. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Driver">View.Driver</a>
  106. </div>
  107. <div>
  108. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Subviews">View.Subviews</a>
  109. </div>
  110. <div>
  111. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Id">View.Id</a>
  112. </div>
  113. <div>
  114. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_IsCurrentTop">View.IsCurrentTop</a>
  115. </div>
  116. <div>
  117. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_WantMousePositionReports">View.WantMousePositionReports</a>
  118. </div>
  119. <div>
  120. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_WantContinuousButtonPressed">View.WantContinuousButtonPressed</a>
  121. </div>
  122. <div>
  123. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Frame">View.Frame</a>
  124. </div>
  125. <div>
  126. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_GetEnumerator">View.GetEnumerator()</a>
  127. </div>
  128. <div>
  129. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_LayoutStyle">View.LayoutStyle</a>
  130. </div>
  131. <div>
  132. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Bounds">View.Bounds</a>
  133. </div>
  134. <div>
  135. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_X">View.X</a>
  136. </div>
  137. <div>
  138. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Y">View.Y</a>
  139. </div>
  140. <div>
  141. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Width">View.Width</a>
  142. </div>
  143. <div>
  144. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Height">View.Height</a>
  145. </div>
  146. <div>
  147. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SuperView">View.SuperView</a>
  148. </div>
  149. <div>
  150. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SetNeedsDisplay">View.SetNeedsDisplay()</a>
  151. </div>
  152. <div>
  153. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SetNeedsDisplay_Terminal_Gui_Rect_">View.SetNeedsDisplay(Rect)</a>
  154. </div>
  155. <div>
  156. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ChildNeedsDisplay">View.ChildNeedsDisplay()</a>
  157. </div>
  158. <div>
  159. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Add_Terminal_Gui_View_">View.Add(View)</a>
  160. </div>
  161. <div>
  162. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Add_Terminal_Gui_View___">View.Add(View[])</a>
  163. </div>
  164. <div>
  165. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_RemoveAll">View.RemoveAll()</a>
  166. </div>
  167. <div>
  168. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Remove_Terminal_Gui_View_">View.Remove(View)</a>
  169. </div>
  170. <div>
  171. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_BringSubviewToFront_Terminal_Gui_View_">View.BringSubviewToFront(View)</a>
  172. </div>
  173. <div>
  174. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SendSubviewToBack_Terminal_Gui_View_">View.SendSubviewToBack(View)</a>
  175. </div>
  176. <div>
  177. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SendSubviewBackwards_Terminal_Gui_View_">View.SendSubviewBackwards(View)</a>
  178. </div>
  179. <div>
  180. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_BringSubviewForward_Terminal_Gui_View_">View.BringSubviewForward(View)</a>
  181. </div>
  182. <div>
  183. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Clear">View.Clear()</a>
  184. </div>
  185. <div>
  186. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Clear_Terminal_Gui_Rect_">View.Clear(Rect)</a>
  187. </div>
  188. <div>
  189. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ScreenToView_System_Int32_System_Int32_">View.ScreenToView(Int32, Int32)</a>
  190. </div>
  191. <div>
  192. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ClipToBounds">View.ClipToBounds()</a>
  193. </div>
  194. <div>
  195. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SetClip_Terminal_Gui_Rect_">View.SetClip(Rect)</a>
  196. </div>
  197. <div>
  198. <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>
  199. </div>
  200. <div>
  201. <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>
  202. </div>
  203. <div>
  204. <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>
  205. </div>
  206. <div>
  207. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Move_System_Int32_System_Int32_">View.Move(Int32, Int32)</a>
  208. </div>
  209. <div>
  210. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_HasFocus">View.HasFocus</a>
  211. </div>
  212. <div>
  213. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnEnter">View.OnEnter()</a>
  214. </div>
  215. <div>
  216. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnLeave">View.OnLeave()</a>
  217. </div>
  218. <div>
  219. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Focused">View.Focused</a>
  220. </div>
  221. <div>
  222. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_MostFocused">View.MostFocused</a>
  223. </div>
  224. <div>
  225. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ColorScheme">View.ColorScheme</a>
  226. </div>
  227. <div>
  228. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_AddRune_System_Int32_System_Int32_System_Rune_">View.AddRune(Int32, Int32, Rune)</a>
  229. </div>
  230. <div>
  231. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ClearNeedsDisplay">View.ClearNeedsDisplay()</a>
  232. </div>
  233. <div>
  234. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SetFocus_Terminal_Gui_View_">View.SetFocus(View)</a>
  235. </div>
  236. <div>
  237. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_KeyPress">View.KeyPress</a>
  238. </div>
  239. <div>
  240. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ProcessHotKey_Terminal_Gui_KeyEvent_">View.ProcessHotKey(KeyEvent)</a>
  241. </div>
  242. <div>
  243. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ProcessColdKey_Terminal_Gui_KeyEvent_">View.ProcessColdKey(KeyEvent)</a>
  244. </div>
  245. <div>
  246. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_KeyDown">View.KeyDown</a>
  247. </div>
  248. <div>
  249. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnKeyDown_Terminal_Gui_KeyEvent_">View.OnKeyDown(KeyEvent)</a>
  250. </div>
  251. <div>
  252. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_KeyUp">View.KeyUp</a>
  253. </div>
  254. <div>
  255. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnKeyUp_Terminal_Gui_KeyEvent_">View.OnKeyUp(KeyEvent)</a>
  256. </div>
  257. <div>
  258. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_EnsureFocus">View.EnsureFocus()</a>
  259. </div>
  260. <div>
  261. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_FocusFirst">View.FocusFirst()</a>
  262. </div>
  263. <div>
  264. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_FocusLast">View.FocusLast()</a>
  265. </div>
  266. <div>
  267. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_FocusPrev">View.FocusPrev()</a>
  268. </div>
  269. <div>
  270. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_FocusNext">View.FocusNext()</a>
  271. </div>
  272. <div>
  273. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_LayoutSubviews">View.LayoutSubviews()</a>
  274. </div>
  275. <div>
  276. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ToString">View.ToString()</a>
  277. </div>
  278. <div>
  279. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnMouseEnter_Terminal_Gui_MouseEvent_">View.OnMouseEnter(MouseEvent)</a>
  280. </div>
  281. <div>
  282. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnMouseLeave_Terminal_Gui_MouseEvent_">View.OnMouseLeave(MouseEvent)</a>
  283. </div>
  284. <div>
  285. <a class="xref" href="Terminal.Gui.Responder.html#Terminal_Gui_Responder_CanFocus">Responder.CanFocus</a>
  286. </div>
  287. <div>
  288. <span class="xref">System.Object.Equals(System.Object)</span>
  289. </div>
  290. <div>
  291. <span class="xref">System.Object.Equals(System.Object, System.Object)</span>
  292. </div>
  293. <div>
  294. <span class="xref">System.Object.GetHashCode()</span>
  295. </div>
  296. <div>
  297. <span class="xref">System.Object.GetType()</span>
  298. </div>
  299. <div>
  300. <span class="xref">System.Object.MemberwiseClone()</span>
  301. </div>
  302. <div>
  303. <span class="xref">System.Object.ReferenceEquals(System.Object, System.Object)</span>
  304. </div>
  305. </div>
  306. <h6><strong>Namespace</strong>: <a class="xref" href="Terminal.Gui.html">Terminal.Gui</a></h6>
  307. <h6><strong>Assembly</strong>: Terminal.Gui.dll</h6>
  308. <h5 id="Terminal_Gui_CheckBox_syntax">Syntax</h5>
  309. <div class="codewrapper">
  310. <pre><code class="lang-csharp hljs">public class CheckBox : View, IEnumerable</code></pre>
  311. </div>
  312. <h3 id="constructors">Constructors
  313. </h3>
  314. <a id="Terminal_Gui_CheckBox__ctor_" data-uid="Terminal.Gui.CheckBox.#ctor*"></a>
  315. <h4 id="Terminal_Gui_CheckBox__ctor_NStack_ustring_System_Boolean_" data-uid="Terminal.Gui.CheckBox.#ctor(NStack.ustring,System.Boolean)">CheckBox(ustring, Boolean)</h4>
  316. <div class="markdown level1 summary">
  317. Initializes a new instance of <a class="xref" href="Terminal.Gui.CheckBox.html">CheckBox</a> based on the given text, uses Computed layout and sets the height and width.
  318. </div>
  319. <div class="markdown level1 conceptual"></div>
  320. <h5 class="decalaration">Declaration</h5>
  321. <div class="codewrapper">
  322. <pre><code class="lang-csharp hljs">public CheckBox(ustring s, bool is_checked = false)</code></pre>
  323. </div>
  324. <h5 class="parameters">Parameters</h5>
  325. <table class="table table-bordered table-striped table-condensed">
  326. <thead>
  327. <tr>
  328. <th>Type</th>
  329. <th>Name</th>
  330. <th>Description</th>
  331. </tr>
  332. </thead>
  333. <tbody>
  334. <tr>
  335. <td><span class="xref">NStack.ustring</span></td>
  336. <td><span class="parametername">s</span></td>
  337. <td>S.</td>
  338. </tr>
  339. <tr>
  340. <td><span class="xref">System.Boolean</span></td>
  341. <td><span class="parametername">is_checked</span></td>
  342. <td>If set to <code>true</code> is checked.</td>
  343. </tr>
  344. </tbody>
  345. </table>
  346. <a id="Terminal_Gui_CheckBox__ctor_" data-uid="Terminal.Gui.CheckBox.#ctor*"></a>
  347. <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>
  348. <div class="markdown level1 summary">
  349. Initializes a new instance of <a class="xref" href="Terminal.Gui.CheckBox.html">CheckBox</a> based on the given text at the given position and a state.
  350. </div>
  351. <div class="markdown level1 conceptual"></div>
  352. <h5 class="decalaration">Declaration</h5>
  353. <div class="codewrapper">
  354. <pre><code class="lang-csharp hljs">public CheckBox(int x, int y, ustring s)</code></pre>
  355. </div>
  356. <h5 class="parameters">Parameters</h5>
  357. <table class="table table-bordered table-striped table-condensed">
  358. <thead>
  359. <tr>
  360. <th>Type</th>
  361. <th>Name</th>
  362. <th>Description</th>
  363. </tr>
  364. </thead>
  365. <tbody>
  366. <tr>
  367. <td><span class="xref">System.Int32</span></td>
  368. <td><span class="parametername">x</span></td>
  369. <td></td>
  370. </tr>
  371. <tr>
  372. <td><span class="xref">System.Int32</span></td>
  373. <td><span class="parametername">y</span></td>
  374. <td></td>
  375. </tr>
  376. <tr>
  377. <td><span class="xref">NStack.ustring</span></td>
  378. <td><span class="parametername">s</span></td>
  379. <td></td>
  380. </tr>
  381. </tbody>
  382. </table>
  383. <h5 id="Terminal_Gui_CheckBox__ctor_System_Int32_System_Int32_NStack_ustring__remarks">Remarks</h5>
  384. <div class="markdown level1 remarks">
  385. The size of <a class="xref" href="Terminal.Gui.CheckBox.html">CheckBox</a> is computed based on the
  386. text length. This <a class="xref" href="Terminal.Gui.CheckBox.html">CheckBox</a> is not toggled.
  387. </div>
  388. <a id="Terminal_Gui_CheckBox__ctor_" data-uid="Terminal.Gui.CheckBox.#ctor*"></a>
  389. <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>
  390. <div class="markdown level1 summary">
  391. Initializes a new instance of <a class="xref" href="Terminal.Gui.CheckBox.html">CheckBox</a> based on the given text at the given position and a state.
  392. </div>
  393. <div class="markdown level1 conceptual"></div>
  394. <h5 class="decalaration">Declaration</h5>
  395. <div class="codewrapper">
  396. <pre><code class="lang-csharp hljs">public CheckBox(int x, int y, ustring s, bool is_checked)</code></pre>
  397. </div>
  398. <h5 class="parameters">Parameters</h5>
  399. <table class="table table-bordered table-striped table-condensed">
  400. <thead>
  401. <tr>
  402. <th>Type</th>
  403. <th>Name</th>
  404. <th>Description</th>
  405. </tr>
  406. </thead>
  407. <tbody>
  408. <tr>
  409. <td><span class="xref">System.Int32</span></td>
  410. <td><span class="parametername">x</span></td>
  411. <td></td>
  412. </tr>
  413. <tr>
  414. <td><span class="xref">System.Int32</span></td>
  415. <td><span class="parametername">y</span></td>
  416. <td></td>
  417. </tr>
  418. <tr>
  419. <td><span class="xref">NStack.ustring</span></td>
  420. <td><span class="parametername">s</span></td>
  421. <td></td>
  422. </tr>
  423. <tr>
  424. <td><span class="xref">System.Boolean</span></td>
  425. <td><span class="parametername">is_checked</span></td>
  426. <td></td>
  427. </tr>
  428. </tbody>
  429. </table>
  430. <h5 id="Terminal_Gui_CheckBox__ctor_System_Int32_System_Int32_NStack_ustring_System_Boolean__remarks">Remarks</h5>
  431. <div class="markdown level1 remarks">
  432. The size of <a class="xref" href="Terminal.Gui.CheckBox.html">CheckBox</a> is computed based on the
  433. text length.
  434. </div>
  435. <h3 id="properties">Properties
  436. </h3>
  437. <a id="Terminal_Gui_CheckBox_Checked_" data-uid="Terminal.Gui.CheckBox.Checked*"></a>
  438. <h4 id="Terminal_Gui_CheckBox_Checked" data-uid="Terminal.Gui.CheckBox.Checked">Checked</h4>
  439. <div class="markdown level1 summary">
  440. The state of the <a class="xref" href="Terminal.Gui.CheckBox.html">CheckBox</a>
  441. </div>
  442. <div class="markdown level1 conceptual"></div>
  443. <h5 class="decalaration">Declaration</h5>
  444. <div class="codewrapper">
  445. <pre><code class="lang-csharp hljs">public bool Checked { get; set; }</code></pre>
  446. </div>
  447. <h5 class="propertyValue">Property Value</h5>
  448. <table class="table table-bordered table-striped table-condensed">
  449. <thead>
  450. <tr>
  451. <th>Type</th>
  452. <th>Description</th>
  453. </tr>
  454. </thead>
  455. <tbody>
  456. <tr>
  457. <td><span class="xref">System.Boolean</span></td>
  458. <td></td>
  459. </tr>
  460. </tbody>
  461. </table>
  462. <a id="Terminal_Gui_CheckBox_Text_" data-uid="Terminal.Gui.CheckBox.Text*"></a>
  463. <h4 id="Terminal_Gui_CheckBox_Text" data-uid="Terminal.Gui.CheckBox.Text">Text</h4>
  464. <div class="markdown level1 summary">
  465. The text displayed by this <a class="xref" href="Terminal.Gui.CheckBox.html">CheckBox</a>
  466. </div>
  467. <div class="markdown level1 conceptual"></div>
  468. <h5 class="decalaration">Declaration</h5>
  469. <div class="codewrapper">
  470. <pre><code class="lang-csharp hljs">public ustring Text { get; set; }</code></pre>
  471. </div>
  472. <h5 class="propertyValue">Property Value</h5>
  473. <table class="table table-bordered table-striped table-condensed">
  474. <thead>
  475. <tr>
  476. <th>Type</th>
  477. <th>Description</th>
  478. </tr>
  479. </thead>
  480. <tbody>
  481. <tr>
  482. <td><span class="xref">NStack.ustring</span></td>
  483. <td></td>
  484. </tr>
  485. </tbody>
  486. </table>
  487. <h3 id="methods">Methods
  488. </h3>
  489. <a id="Terminal_Gui_CheckBox_MouseEvent_" data-uid="Terminal.Gui.CheckBox.MouseEvent*"></a>
  490. <h4 id="Terminal_Gui_CheckBox_MouseEvent_Terminal_Gui_MouseEvent_" data-uid="Terminal.Gui.CheckBox.MouseEvent(Terminal.Gui.MouseEvent)">MouseEvent(MouseEvent)</h4>
  491. <div class="markdown level1 summary"></div>
  492. <div class="markdown level1 conceptual"></div>
  493. <h5 class="decalaration">Declaration</h5>
  494. <div class="codewrapper">
  495. <pre><code class="lang-csharp hljs">public override bool MouseEvent(MouseEvent me)</code></pre>
  496. </div>
  497. <h5 class="parameters">Parameters</h5>
  498. <table class="table table-bordered table-striped table-condensed">
  499. <thead>
  500. <tr>
  501. <th>Type</th>
  502. <th>Name</th>
  503. <th>Description</th>
  504. </tr>
  505. </thead>
  506. <tbody>
  507. <tr>
  508. <td><a class="xref" href="Terminal.Gui.MouseEvent.html">MouseEvent</a></td>
  509. <td><span class="parametername">me</span></td>
  510. <td></td>
  511. </tr>
  512. </tbody>
  513. </table>
  514. <h5 class="returns">Returns</h5>
  515. <table class="table table-bordered table-striped table-condensed">
  516. <thead>
  517. <tr>
  518. <th>Type</th>
  519. <th>Description</th>
  520. </tr>
  521. </thead>
  522. <tbody>
  523. <tr>
  524. <td><span class="xref">System.Boolean</span></td>
  525. <td></td>
  526. </tr>
  527. </tbody>
  528. </table>
  529. <h5 class="overrides">Overrides</h5>
  530. <div><a class="xref" href="Terminal.Gui.Responder.html#Terminal_Gui_Responder_MouseEvent_Terminal_Gui_MouseEvent_">Responder.MouseEvent(MouseEvent)</a></div>
  531. <a id="Terminal_Gui_CheckBox_PositionCursor_" data-uid="Terminal.Gui.CheckBox.PositionCursor*"></a>
  532. <h4 id="Terminal_Gui_CheckBox_PositionCursor" data-uid="Terminal.Gui.CheckBox.PositionCursor">PositionCursor()</h4>
  533. <div class="markdown level1 summary"></div>
  534. <div class="markdown level1 conceptual"></div>
  535. <h5 class="decalaration">Declaration</h5>
  536. <div class="codewrapper">
  537. <pre><code class="lang-csharp hljs">public override void PositionCursor()</code></pre>
  538. </div>
  539. <h5 class="overrides">Overrides</h5>
  540. <div><a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_PositionCursor">View.PositionCursor()</a></div>
  541. <a id="Terminal_Gui_CheckBox_ProcessKey_" data-uid="Terminal.Gui.CheckBox.ProcessKey*"></a>
  542. <h4 id="Terminal_Gui_CheckBox_ProcessKey_Terminal_Gui_KeyEvent_" data-uid="Terminal.Gui.CheckBox.ProcessKey(Terminal.Gui.KeyEvent)">ProcessKey(KeyEvent)</h4>
  543. <div class="markdown level1 summary"></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 override bool ProcessKey(KeyEvent kb)</code></pre>
  548. </div>
  549. <h5 class="parameters">Parameters</h5>
  550. <table class="table table-bordered table-striped table-condensed">
  551. <thead>
  552. <tr>
  553. <th>Type</th>
  554. <th>Name</th>
  555. <th>Description</th>
  556. </tr>
  557. </thead>
  558. <tbody>
  559. <tr>
  560. <td><a class="xref" href="Terminal.Gui.KeyEvent.html">KeyEvent</a></td>
  561. <td><span class="parametername">kb</span></td>
  562. <td></td>
  563. </tr>
  564. </tbody>
  565. </table>
  566. <h5 class="returns">Returns</h5>
  567. <table class="table table-bordered table-striped table-condensed">
  568. <thead>
  569. <tr>
  570. <th>Type</th>
  571. <th>Description</th>
  572. </tr>
  573. </thead>
  574. <tbody>
  575. <tr>
  576. <td><span class="xref">System.Boolean</span></td>
  577. <td></td>
  578. </tr>
  579. </tbody>
  580. </table>
  581. <h5 class="overrides">Overrides</h5>
  582. <div><a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ProcessKey_Terminal_Gui_KeyEvent_">View.ProcessKey(KeyEvent)</a></div>
  583. <a id="Terminal_Gui_CheckBox_Redraw_" data-uid="Terminal.Gui.CheckBox.Redraw*"></a>
  584. <h4 id="Terminal_Gui_CheckBox_Redraw_Terminal_Gui_Rect_" data-uid="Terminal.Gui.CheckBox.Redraw(Terminal.Gui.Rect)">Redraw(Rect)</h4>
  585. <div class="markdown level1 summary"></div>
  586. <div class="markdown level1 conceptual"></div>
  587. <h5 class="decalaration">Declaration</h5>
  588. <div class="codewrapper">
  589. <pre><code class="lang-csharp hljs">public override void Redraw(Rect region)</code></pre>
  590. </div>
  591. <h5 class="parameters">Parameters</h5>
  592. <table class="table table-bordered table-striped table-condensed">
  593. <thead>
  594. <tr>
  595. <th>Type</th>
  596. <th>Name</th>
  597. <th>Description</th>
  598. </tr>
  599. </thead>
  600. <tbody>
  601. <tr>
  602. <td><a class="xref" href="Terminal.Gui.Rect.html">Rect</a></td>
  603. <td><span class="parametername">region</span></td>
  604. <td></td>
  605. </tr>
  606. </tbody>
  607. </table>
  608. <h5 class="overrides">Overrides</h5>
  609. <div><a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Redraw_Terminal_Gui_Rect_">View.Redraw(Rect)</a></div>
  610. <h3 id="events">Events
  611. </h3>
  612. <h4 id="Terminal_Gui_CheckBox_Toggled" data-uid="Terminal.Gui.CheckBox.Toggled">Toggled</h4>
  613. <div class="markdown level1 summary">
  614. Toggled event, raised when the <a class="xref" href="Terminal.Gui.CheckBox.html">CheckBox</a> is toggled.
  615. </div>
  616. <div class="markdown level1 conceptual"></div>
  617. <h5 class="decalaration">Declaration</h5>
  618. <div class="codewrapper">
  619. <pre><code class="lang-csharp hljs">public event EventHandler Toggled</code></pre>
  620. </div>
  621. <h5 class="eventType">Event Type</h5>
  622. <table class="table table-bordered table-striped table-condensed">
  623. <thead>
  624. <tr>
  625. <th>Type</th>
  626. <th>Description</th>
  627. </tr>
  628. </thead>
  629. <tbody>
  630. <tr>
  631. <td><span class="xref">System.EventHandler</span></td>
  632. <td></td>
  633. </tr>
  634. </tbody>
  635. </table>
  636. <h5 id="Terminal_Gui_CheckBox_Toggled_remarks">Remarks</h5>
  637. <div class="markdown level1 remarks">
  638. Client code can hook up to this event, it is
  639. raised when the <a class="xref" href="Terminal.Gui.CheckBox.html">CheckBox</a> is activated either with
  640. the mouse or the keyboard.
  641. </div>
  642. <h3 id="implements">Implements</h3>
  643. <div>
  644. <span class="xref">System.Collections.IEnumerable</span>
  645. </div>
  646. </article>
  647. </div>
  648. <div class="hidden-sm col-md-2" role="complementary">
  649. <div class="sideaffix">
  650. <div class="contribution">
  651. <ul class="nav">
  652. </ul>
  653. </div>
  654. <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
  655. <!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
  656. </nav>
  657. </div>
  658. </div>
  659. </div>
  660. </div>
  661. <footer>
  662. <div class="grad-bottom"></div>
  663. <div class="footer">
  664. <div class="container">
  665. <span class="pull-right">
  666. <a href="#top">Back to top</a>
  667. </span>
  668. <span>Generated by <strong>DocFX</strong></span>
  669. </div>
  670. </div>
  671. </footer>
  672. </div>
  673. <script type="text/javascript" src="../../styles/docfx.vendor.js"></script>
  674. <script type="text/javascript" src="../../styles/docfx.js"></script>
  675. <script type="text/javascript" src="../../styles/main.js"></script>
  676. </body>
  677. </html>