Terminal.Gui.CheckBox.html 26 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679
  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.18.2.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="">
  18. <meta property="docfx:tocrel" content="../toc.html">
  19. </head>
  20. <body data-spy="scroll" data-target="#affix">
  21. <div id="wrapper">
  22. <header>
  23. <nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation">
  24. <div class="container">
  25. <div class="navbar-header">
  26. <button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
  27. <span class="sr-only">Toggle navigation</span>
  28. <span class="icon-bar"></span>
  29. <span class="icon-bar"></span>
  30. <span class="icon-bar"></span>
  31. </button>
  32. <a class="navbar-brand" href="../../index.html">
  33. <img id="logo" class="svg" src="../../logo.svg" alt="">
  34. </a>
  35. </div>
  36. <div class="collapse navbar-collapse" id="navbar">
  37. <form class="navbar-form navbar-right" role="search" id="search">
  38. <div class="form-group">
  39. <input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">
  40. </div>
  41. </form>
  42. </div>
  43. </div>
  44. </nav>
  45. <div class="subnav navbar navbar-default">
  46. <div class="container hide-when-search" id="breadcrumb">
  47. <ul class="breadcrumb">
  48. <li></li>
  49. </ul>
  50. </div>
  51. </div>
  52. </header>
  53. <div role="main" class="container body-content hide-when-search">
  54. <div class="sidenav hide-when-search">
  55. <a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
  56. <div class="sidetoggle collapse" id="sidetoggle">
  57. <div id="sidetoc"></div>
  58. </div>
  59. </div>
  60. <div class="article row grid-right">
  61. <div class="col-md-10">
  62. <article class="content wrap" id="_content" data-uid="Terminal.Gui.CheckBox">
  63. <h1 id="Terminal_Gui_CheckBox" data-uid="Terminal.Gui.CheckBox">Class CheckBox
  64. </h1>
  65. <div class="markdown level0 summary"><p>The Checkbox View shows an on/off toggle that the user can set</p>
  66. </div>
  67. <div class="markdown level0 conceptual"></div>
  68. <div class="inheritance">
  69. <h5>Inheritance</h5>
  70. <div class="level0"><span class="xref">System.Object</span></div>
  71. <div class="level1"><a class="xref" href="Terminal.Gui.Responder.html">Responder</a></div>
  72. <div class="level2"><a class="xref" href="Terminal.Gui.View.html">View</a></div>
  73. <div class="level3"><span class="xref">CheckBox</span></div>
  74. </div>
  75. <div class="inheritedMembers">
  76. <h5>Inherited Members</h5>
  77. <div>
  78. <a class="xref" href="Terminal.Gui.Responder.html#Terminal_Gui_Responder_CanFocus">Responder.CanFocus</a>
  79. </div>
  80. <div>
  81. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Add_Terminal_Gui_View_">View.Add(View)</a>
  82. </div>
  83. <div>
  84. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Add_Terminal_Gui_View___">View.Add(View[])</a>
  85. </div>
  86. <div>
  87. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_AddCh_System_Int32_System_Int32_System_Int32_">View.AddCh(Int32, Int32, Int32)</a>
  88. </div>
  89. <div>
  90. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_AddRune_System_Int32_System_Int32_System_Rune_">View.AddRune(Int32, Int32, Rune)</a>
  91. </div>
  92. <div>
  93. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Bounds">View.Bounds</a>
  94. </div>
  95. <div>
  96. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ChildNeedsDisplay">View.ChildNeedsDisplay()</a>
  97. </div>
  98. <div>
  99. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Clear">View.Clear()</a>
  100. </div>
  101. <div>
  102. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Clear_Terminal_Gui_Rect_">View.Clear(Rect)</a>
  103. </div>
  104. <div>
  105. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ClearNeedsDisplay">View.ClearNeedsDisplay()</a>
  106. </div>
  107. <div>
  108. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ClipToBounds">View.ClipToBounds()</a>
  109. </div>
  110. <div>
  111. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ColorScheme">View.ColorScheme</a>
  112. </div>
  113. <div>
  114. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_DrawFrame_Terminal_Gui_Rect_System_Boolean_">View.DrawFrame(Rect, Boolean)</a>
  115. </div>
  116. <div>
  117. <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>
  118. </div>
  119. <div>
  120. <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>
  121. </div>
  122. <div>
  123. <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>
  124. </div>
  125. <div>
  126. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_DrawHotString_System_String_System_Boolean_Terminal_Gui_ColorScheme_">View.DrawHotString(String, Boolean, ColorScheme)</a>
  127. </div>
  128. <div>
  129. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_DrawHotString_System_String_Terminal_Gui_Attribute_Terminal_Gui_Attribute_">View.DrawHotString(String, Attribute, Attribute)</a>
  130. </div>
  131. <div>
  132. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Driver">View.Driver</a>
  133. </div>
  134. <div>
  135. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_EnsureFocus">View.EnsureFocus()</a>
  136. </div>
  137. <div>
  138. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Focused">View.Focused</a>
  139. </div>
  140. <div>
  141. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_FocusFirst">View.FocusFirst()</a>
  142. </div>
  143. <div>
  144. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_FocusLast">View.FocusLast()</a>
  145. </div>
  146. <div>
  147. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_FocusNext">View.FocusNext()</a>
  148. </div>
  149. <div>
  150. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_FocusPrev">View.FocusPrev()</a>
  151. </div>
  152. <div>
  153. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Frame">View.Frame</a>
  154. </div>
  155. <div>
  156. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_GetEnumerator">View.GetEnumerator()</a>
  157. </div>
  158. <div>
  159. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_HasFocus">View.HasFocus</a>
  160. </div>
  161. <div>
  162. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Id">View.Id</a>
  163. </div>
  164. <div>
  165. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_LayoutSubviews">View.LayoutSubviews()</a>
  166. </div>
  167. <div>
  168. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_MostFocused">View.MostFocused</a>
  169. </div>
  170. <div>
  171. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Move_System_Int32_System_Int32_">View.Move(Int32, Int32)</a>
  172. </div>
  173. <div>
  174. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ProcessColdKey_Terminal_Gui_KeyEvent_">View.ProcessColdKey(KeyEvent)</a>
  175. </div>
  176. <div>
  177. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ProcessHotKey_Terminal_Gui_KeyEvent_">View.ProcessHotKey(KeyEvent)</a>
  178. </div>
  179. <div>
  180. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Remove_Terminal_Gui_View_">View.Remove(View)</a>
  181. </div>
  182. <div>
  183. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_RemoveAll">View.RemoveAll()</a>
  184. </div>
  185. <div>
  186. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ScreenToView_System_Int32_System_Int32_">View.ScreenToView(Int32, Int32)</a>
  187. </div>
  188. <div>
  189. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SetClip_Terminal_Gui_Rect_">View.SetClip(Rect)</a>
  190. </div>
  191. <div>
  192. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SetFocus_Terminal_Gui_View_">View.SetFocus(View)</a>
  193. </div>
  194. <div>
  195. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SetNeedsDisplay">View.SetNeedsDisplay()</a>
  196. </div>
  197. <div>
  198. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SetNeedsDisplay_Terminal_Gui_Rect_">View.SetNeedsDisplay(Rect)</a>
  199. </div>
  200. <div>
  201. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Subviews">View.Subviews</a>
  202. </div>
  203. <div>
  204. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SuperView">View.SuperView</a>
  205. </div>
  206. <div>
  207. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ToString">View.ToString()</a>
  208. </div>
  209. <div>
  210. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_WantMousePositionReports">View.WantMousePositionReports</a>
  211. </div>
  212. </div>
  213. <h6><strong>Namespace</strong>: <a class="xref" href="../Terminal.Gui.html">Terminal.Gui</a></h6>
  214. <h6><strong>Assembly</strong>: Terminal.Gui.dll</h6>
  215. <h5 id="Terminal_Gui_CheckBox_syntax">Syntax</h5>
  216. <div class="codewrapper">
  217. <pre><code class="lang-csharp hljs">public class CheckBox : Terminal.Gui.View</code></pre>
  218. </div>
  219. <h3 id="constructors">Constructors
  220. </h3>
  221. <a id="Terminal_Gui_CheckBox__ctor_" data-uid="Terminal.Gui.CheckBox.#ctor*"></a>
  222. <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>
  223. <div class="markdown level1 summary"><p>Public constructor, creates a CheckButton based on
  224. the given text at the given position.</p>
  225. </div>
  226. <div class="markdown level1 conceptual"></div>
  227. <h5 class="decalaration">Declaration</h5>
  228. <div class="codewrapper">
  229. <pre><code class="lang-csharp hljs">public CheckBox (int x, int y, NStack.ustring s);</code></pre>
  230. </div>
  231. <h5 class="parameters">Parameters</h5>
  232. <table class="table table-bordered table-striped table-condensed">
  233. <thead>
  234. <tr>
  235. <th>Type</th>
  236. <th>Name</th>
  237. <th>Description</th>
  238. </tr>
  239. </thead>
  240. <tbody>
  241. <tr>
  242. <td><span class="xref">System.Int32</span></td>
  243. <td><span class="parametername">x</span></td>
  244. <td><p>To be added.</p>
  245. </td>
  246. </tr>
  247. <tr>
  248. <td><span class="xref">System.Int32</span></td>
  249. <td><span class="parametername">y</span></td>
  250. <td><p>To be added.</p>
  251. </td>
  252. </tr>
  253. <tr>
  254. <td><span class="xref">NStack.ustring</span></td>
  255. <td><span class="parametername">s</span></td>
  256. <td><p>To be added.</p>
  257. </td>
  258. </tr>
  259. </tbody>
  260. </table>
  261. <h5 id="Terminal_Gui_CheckBox__ctor_System_Int32_System_Int32_NStack_ustring__remarks">Remarks</h5>
  262. <div class="markdown level1 remarks"><p>The size of CheckButton is computed based on the
  263. text length. This CheckButton is not toggled.</p>
  264. </div>
  265. <a id="Terminal_Gui_CheckBox__ctor_" data-uid="Terminal.Gui.CheckBox.#ctor*"></a>
  266. <h4 id="Terminal_Gui_CheckBox__ctor_System_Int32_System_Int32_System_String_" data-uid="Terminal.Gui.CheckBox.#ctor(System.Int32,System.Int32,System.String)">CheckBox(Int32, Int32, String)</h4>
  267. <div class="markdown level1 summary"><p>Public constructor, creates a CheckButton based on
  268. the given text at the given position.</p>
  269. </div>
  270. <div class="markdown level1 conceptual"></div>
  271. <h5 class="decalaration">Declaration</h5>
  272. <div class="codewrapper">
  273. <pre><code class="lang-csharp hljs">public CheckBox (int x, int y, string s);</code></pre>
  274. </div>
  275. <h5 class="parameters">Parameters</h5>
  276. <table class="table table-bordered table-striped table-condensed">
  277. <thead>
  278. <tr>
  279. <th>Type</th>
  280. <th>Name</th>
  281. <th>Description</th>
  282. </tr>
  283. </thead>
  284. <tbody>
  285. <tr>
  286. <td><span class="xref">System.Int32</span></td>
  287. <td><span class="parametername">x</span></td>
  288. <td><p>To be added.</p>
  289. </td>
  290. </tr>
  291. <tr>
  292. <td><span class="xref">System.Int32</span></td>
  293. <td><span class="parametername">y</span></td>
  294. <td><p>To be added.</p>
  295. </td>
  296. </tr>
  297. <tr>
  298. <td><span class="xref">System.String</span></td>
  299. <td><span class="parametername">s</span></td>
  300. <td><p>To be added.</p>
  301. </td>
  302. </tr>
  303. </tbody>
  304. </table>
  305. <h5 id="Terminal_Gui_CheckBox__ctor_System_Int32_System_Int32_System_String__remarks">Remarks</h5>
  306. <div class="markdown level1 remarks"><p>The size of CheckButton is computed based on the
  307. text length. This CheckButton is not toggled.</p>
  308. </div>
  309. <a id="Terminal_Gui_CheckBox__ctor_" data-uid="Terminal.Gui.CheckBox.#ctor*"></a>
  310. <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>
  311. <div class="markdown level1 summary"><p>Public constructor, creates a CheckButton based on
  312. the given text at the given position and a state.</p>
  313. </div>
  314. <div class="markdown level1 conceptual"></div>
  315. <h5 class="decalaration">Declaration</h5>
  316. <div class="codewrapper">
  317. <pre><code class="lang-csharp hljs">public CheckBox (int x, int y, NStack.ustring s, bool is_checked);</code></pre>
  318. </div>
  319. <h5 class="parameters">Parameters</h5>
  320. <table class="table table-bordered table-striped table-condensed">
  321. <thead>
  322. <tr>
  323. <th>Type</th>
  324. <th>Name</th>
  325. <th>Description</th>
  326. </tr>
  327. </thead>
  328. <tbody>
  329. <tr>
  330. <td><span class="xref">System.Int32</span></td>
  331. <td><span class="parametername">x</span></td>
  332. <td><p>To be added.</p>
  333. </td>
  334. </tr>
  335. <tr>
  336. <td><span class="xref">System.Int32</span></td>
  337. <td><span class="parametername">y</span></td>
  338. <td><p>To be added.</p>
  339. </td>
  340. </tr>
  341. <tr>
  342. <td><span class="xref">NStack.ustring</span></td>
  343. <td><span class="parametername">s</span></td>
  344. <td><p>To be added.</p>
  345. </td>
  346. </tr>
  347. <tr>
  348. <td><span class="xref">System.Boolean</span></td>
  349. <td><span class="parametername">is_checked</span></td>
  350. <td><p>To be added.</p>
  351. </td>
  352. </tr>
  353. </tbody>
  354. </table>
  355. <h5 id="Terminal_Gui_CheckBox__ctor_System_Int32_System_Int32_NStack_ustring_System_Boolean__remarks">Remarks</h5>
  356. <div class="markdown level1 remarks"><p>The size of CheckButton is computed based on the
  357. text length.</p>
  358. </div>
  359. <a id="Terminal_Gui_CheckBox__ctor_" data-uid="Terminal.Gui.CheckBox.#ctor*"></a>
  360. <h4 id="Terminal_Gui_CheckBox__ctor_System_Int32_System_Int32_System_String_System_Boolean_" data-uid="Terminal.Gui.CheckBox.#ctor(System.Int32,System.Int32,System.String,System.Boolean)">CheckBox(Int32, Int32, String, Boolean)</h4>
  361. <div class="markdown level1 summary"><p>Public constructor, creates a CheckButton based on
  362. the given text at the given position and a state.</p>
  363. </div>
  364. <div class="markdown level1 conceptual"></div>
  365. <h5 class="decalaration">Declaration</h5>
  366. <div class="codewrapper">
  367. <pre><code class="lang-csharp hljs">public CheckBox (int x, int y, string s, bool is_checked);</code></pre>
  368. </div>
  369. <h5 class="parameters">Parameters</h5>
  370. <table class="table table-bordered table-striped table-condensed">
  371. <thead>
  372. <tr>
  373. <th>Type</th>
  374. <th>Name</th>
  375. <th>Description</th>
  376. </tr>
  377. </thead>
  378. <tbody>
  379. <tr>
  380. <td><span class="xref">System.Int32</span></td>
  381. <td><span class="parametername">x</span></td>
  382. <td><p>To be added.</p>
  383. </td>
  384. </tr>
  385. <tr>
  386. <td><span class="xref">System.Int32</span></td>
  387. <td><span class="parametername">y</span></td>
  388. <td><p>To be added.</p>
  389. </td>
  390. </tr>
  391. <tr>
  392. <td><span class="xref">System.String</span></td>
  393. <td><span class="parametername">s</span></td>
  394. <td><p>To be added.</p>
  395. </td>
  396. </tr>
  397. <tr>
  398. <td><span class="xref">System.Boolean</span></td>
  399. <td><span class="parametername">is_checked</span></td>
  400. <td><p>To be added.</p>
  401. </td>
  402. </tr>
  403. </tbody>
  404. </table>
  405. <h5 id="Terminal_Gui_CheckBox__ctor_System_Int32_System_Int32_System_String_System_Boolean__remarks">Remarks</h5>
  406. <div class="markdown level1 remarks"><p>The size of CheckButton is computed based on the
  407. text length.</p>
  408. </div>
  409. <h3 id="properties">Properties
  410. </h3>
  411. <a id="Terminal_Gui_CheckBox_Checked_" data-uid="Terminal.Gui.CheckBox.Checked*"></a>
  412. <h4 id="Terminal_Gui_CheckBox_Checked" data-uid="Terminal.Gui.CheckBox.Checked">Checked</h4>
  413. <div class="markdown level1 summary"><p>The state of the checkbox.</p>
  414. </div>
  415. <div class="markdown level1 conceptual"></div>
  416. <h5 class="decalaration">Declaration</h5>
  417. <div class="codewrapper">
  418. <pre><code class="lang-csharp hljs">public bool Checked { get; set; }</code></pre>
  419. </div>
  420. <h5 class="propertyValue">Property Value</h5>
  421. <table class="table table-bordered table-striped table-condensed">
  422. <thead>
  423. <tr>
  424. <th>Type</th>
  425. <th>Description</th>
  426. </tr>
  427. </thead>
  428. <tbody>
  429. <tr>
  430. <td><span class="xref">System.Boolean</span></td>
  431. <td><p>To be added.</p>
  432. </td>
  433. </tr>
  434. </tbody>
  435. </table>
  436. <a id="Terminal_Gui_CheckBox_Text_" data-uid="Terminal.Gui.CheckBox.Text*"></a>
  437. <h4 id="Terminal_Gui_CheckBox_Text" data-uid="Terminal.Gui.CheckBox.Text">Text</h4>
  438. <div class="markdown level1 summary"><p>The text displayed by this widget.</p>
  439. </div>
  440. <div class="markdown level1 conceptual"></div>
  441. <h5 class="decalaration">Declaration</h5>
  442. <div class="codewrapper">
  443. <pre><code class="lang-csharp hljs">public NStack.ustring Text { get; set; }</code></pre>
  444. </div>
  445. <h5 class="propertyValue">Property Value</h5>
  446. <table class="table table-bordered table-striped table-condensed">
  447. <thead>
  448. <tr>
  449. <th>Type</th>
  450. <th>Description</th>
  451. </tr>
  452. </thead>
  453. <tbody>
  454. <tr>
  455. <td><span class="xref">NStack.ustring</span></td>
  456. <td><p>To be added.</p>
  457. </td>
  458. </tr>
  459. </tbody>
  460. </table>
  461. <h3 id="methods">Methods
  462. </h3>
  463. <a id="Terminal_Gui_CheckBox_MouseEvent_" data-uid="Terminal.Gui.CheckBox.MouseEvent*"></a>
  464. <h4 id="Terminal_Gui_CheckBox_MouseEvent_Terminal_Gui_MouseEvent_" data-uid="Terminal.Gui.CheckBox.MouseEvent(Terminal.Gui.MouseEvent)">MouseEvent(MouseEvent)</h4>
  465. <div class="markdown level1 summary"></div>
  466. <div class="markdown level1 conceptual"></div>
  467. <h5 class="decalaration">Declaration</h5>
  468. <div class="codewrapper">
  469. <pre><code class="lang-csharp hljs">public override bool MouseEvent (Terminal.Gui.MouseEvent me);</code></pre>
  470. </div>
  471. <h5 class="parameters">Parameters</h5>
  472. <table class="table table-bordered table-striped table-condensed">
  473. <thead>
  474. <tr>
  475. <th>Type</th>
  476. <th>Name</th>
  477. <th>Description</th>
  478. </tr>
  479. </thead>
  480. <tbody>
  481. <tr>
  482. <td><a class="xref" href="Terminal.Gui.MouseEvent.html">MouseEvent</a></td>
  483. <td><span class="parametername">me</span></td>
  484. <td><p>To be added.</p>
  485. </td>
  486. </tr>
  487. </tbody>
  488. </table>
  489. <h5 class="returns">Returns</h5>
  490. <table class="table table-bordered table-striped table-condensed">
  491. <thead>
  492. <tr>
  493. <th>Type</th>
  494. <th>Description</th>
  495. </tr>
  496. </thead>
  497. <tbody>
  498. <tr>
  499. <td><span class="xref">System.Boolean</span></td>
  500. <td><p>To be added.</p>
  501. </td>
  502. </tr>
  503. </tbody>
  504. </table>
  505. <a id="Terminal_Gui_CheckBox_PositionCursor_" data-uid="Terminal.Gui.CheckBox.PositionCursor*"></a>
  506. <h4 id="Terminal_Gui_CheckBox_PositionCursor" data-uid="Terminal.Gui.CheckBox.PositionCursor">PositionCursor()</h4>
  507. <div class="markdown level1 summary"></div>
  508. <div class="markdown level1 conceptual"></div>
  509. <h5 class="decalaration">Declaration</h5>
  510. <div class="codewrapper">
  511. <pre><code class="lang-csharp hljs">public override void PositionCursor ();</code></pre>
  512. </div>
  513. <a id="Terminal_Gui_CheckBox_ProcessKey_" data-uid="Terminal.Gui.CheckBox.ProcessKey*"></a>
  514. <h4 id="Terminal_Gui_CheckBox_ProcessKey_Terminal_Gui_KeyEvent_" data-uid="Terminal.Gui.CheckBox.ProcessKey(Terminal.Gui.KeyEvent)">ProcessKey(KeyEvent)</h4>
  515. <div class="markdown level1 summary"></div>
  516. <div class="markdown level1 conceptual"></div>
  517. <h5 class="decalaration">Declaration</h5>
  518. <div class="codewrapper">
  519. <pre><code class="lang-csharp hljs">public override bool ProcessKey (Terminal.Gui.KeyEvent kb);</code></pre>
  520. </div>
  521. <h5 class="parameters">Parameters</h5>
  522. <table class="table table-bordered table-striped table-condensed">
  523. <thead>
  524. <tr>
  525. <th>Type</th>
  526. <th>Name</th>
  527. <th>Description</th>
  528. </tr>
  529. </thead>
  530. <tbody>
  531. <tr>
  532. <td><a class="xref" href="Terminal.Gui.KeyEvent.html">KeyEvent</a></td>
  533. <td><span class="parametername">kb</span></td>
  534. <td><p>To be added.</p>
  535. </td>
  536. </tr>
  537. </tbody>
  538. </table>
  539. <h5 class="returns">Returns</h5>
  540. <table class="table table-bordered table-striped table-condensed">
  541. <thead>
  542. <tr>
  543. <th>Type</th>
  544. <th>Description</th>
  545. </tr>
  546. </thead>
  547. <tbody>
  548. <tr>
  549. <td><span class="xref">System.Boolean</span></td>
  550. <td><p>To be added.</p>
  551. </td>
  552. </tr>
  553. </tbody>
  554. </table>
  555. <a id="Terminal_Gui_CheckBox_Redraw_" data-uid="Terminal.Gui.CheckBox.Redraw*"></a>
  556. <h4 id="Terminal_Gui_CheckBox_Redraw_Terminal_Gui_Rect_" data-uid="Terminal.Gui.CheckBox.Redraw(Terminal.Gui.Rect)">Redraw(Rect)</h4>
  557. <div class="markdown level1 summary"></div>
  558. <div class="markdown level1 conceptual"></div>
  559. <h5 class="decalaration">Declaration</h5>
  560. <div class="codewrapper">
  561. <pre><code class="lang-csharp hljs">public override void Redraw (Terminal.Gui.Rect region);</code></pre>
  562. </div>
  563. <h5 class="parameters">Parameters</h5>
  564. <table class="table table-bordered table-striped table-condensed">
  565. <thead>
  566. <tr>
  567. <th>Type</th>
  568. <th>Name</th>
  569. <th>Description</th>
  570. </tr>
  571. </thead>
  572. <tbody>
  573. <tr>
  574. <td><a class="xref" href="Terminal.Gui.Rect.html">Rect</a></td>
  575. <td><span class="parametername">region</span></td>
  576. <td><p>To be added.</p>
  577. </td>
  578. </tr>
  579. </tbody>
  580. </table>
  581. <h3 id="events">Events
  582. </h3>
  583. <h4 id="Terminal_Gui_CheckBox_Toggled" data-uid="Terminal.Gui.CheckBox.Toggled">Toggled</h4>
  584. <div class="markdown level1 summary"><p>Toggled event, raised when the CheckButton is toggled.</p>
  585. </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 event EventHandler Toggled;</code></pre>
  590. </div>
  591. <h5 class="eventType">Event Type</h5>
  592. <table class="table table-bordered table-striped table-condensed">
  593. <thead>
  594. <tr>
  595. <th>Type</th>
  596. <th>Description</th>
  597. </tr>
  598. </thead>
  599. <tbody>
  600. <tr>
  601. <td><span class="xref">System.EventHandler</span></td>
  602. <td><p>To be added.</p>
  603. </td>
  604. </tr>
  605. </tbody>
  606. </table>
  607. <h5 id="Terminal_Gui_CheckBox_Toggled_remarks">Remarks</h5>
  608. <div class="markdown level1 remarks"><p>Client code can hook up to this event, it is
  609. raised when the checkbutton is activated either with
  610. the mouse or the keyboard.</p>
  611. </div>
  612. </article>
  613. </div>
  614. <div class="hidden-sm col-md-2" role="complementary">
  615. <div class="sideaffix">
  616. <div class="contribution">
  617. <ul class="nav">
  618. </ul>
  619. </div>
  620. <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
  621. <!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
  622. </nav>
  623. </div>
  624. </div>
  625. </div>
  626. </div>
  627. <footer>
  628. <div class="grad-bottom"></div>
  629. <div class="footer">
  630. <div class="container">
  631. <span class="pull-right">
  632. <a href="#top">Back to top</a>
  633. </span>
  634. <span>Copyright © 2015-2017 Microsoft<br>Generated by <strong>DocFX</strong></span>
  635. </div>
  636. </div>
  637. </footer>
  638. </div>
  639. <script type="text/javascript" src="../../styles/docfx.vendor.js"></script>
  640. <script type="text/javascript" src="../../styles/docfx.js"></script>
  641. <script type="text/javascript" src="../../styles/main.js"></script>
  642. </body>
  643. </html>