Terminal.Gui.RadioGroup.html 30 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784
  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 RadioGroup
  8. </title>
  9. <meta name="viewport" content="width=device-width">
  10. <meta name="title" content="Class RadioGroup
  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. <meta property="docfx:navrel" content="../../toc.html">
  18. <meta property="docfx:tocrel" content="toc.html">
  19. <meta property="docfx:rel" content="../../">
  20. </head>
  21. <body data-spy="scroll" data-target="#affix" data-offset="120">
  22. <div id="wrapper">
  23. <header>
  24. <nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation">
  25. <div class="container">
  26. <div class="navbar-header">
  27. <button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
  28. <span class="sr-only">Toggle navigation</span>
  29. <span class="icon-bar"></span>
  30. <span class="icon-bar"></span>
  31. <span class="icon-bar"></span>
  32. </button>
  33. <a class="navbar-brand" href="../../index.html">
  34. <img id="logo" class="svg" src="../../images/logo48.png" alt="">
  35. </a>
  36. </div>
  37. <div class="collapse navbar-collapse" id="navbar">
  38. <form class="navbar-form navbar-right" role="search" id="search">
  39. <div class="form-group">
  40. <input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">
  41. </div>
  42. </form>
  43. </div>
  44. </div>
  45. </nav>
  46. <div class="subnav navbar navbar-default">
  47. <div class="container hide-when-search" id="breadcrumb">
  48. <ul class="breadcrumb">
  49. <li></li>
  50. </ul>
  51. </div>
  52. </div>
  53. </header>
  54. <div class="container body-content">
  55. <div id="search-results">
  56. <div class="search-list"></div>
  57. <div class="sr-items">
  58. <p><i class="glyphicon glyphicon-refresh index-loading"></i></p>
  59. </div>
  60. <ul id="pagination"></ul>
  61. </div>
  62. </div>
  63. <div role="main" class="container body-content hide-when-search">
  64. <div class="sidenav hide-when-search">
  65. <a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
  66. <div class="sidetoggle collapse" id="sidetoggle">
  67. <div id="sidetoc"></div>
  68. </div>
  69. </div>
  70. <div class="article row grid-right">
  71. <div class="col-md-10">
  72. <article class="content wrap" id="_content" data-uid="Terminal.Gui.RadioGroup">
  73. <h1 id="Terminal_Gui_RadioGroup" data-uid="Terminal.Gui.RadioGroup" class="text-break">Class RadioGroup
  74. </h1>
  75. <div class="markdown level0 summary">
  76. <a class="xref" href="Terminal.Gui.RadioGroup.html">RadioGroup</a> shows a group of radio labels, only one of those can be selected at a given time
  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">RadioGroup</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_MouseClick">View.MouseClick</a>
  106. </div>
  107. <div>
  108. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Driver">View.Driver</a>
  109. </div>
  110. <div>
  111. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Subviews">View.Subviews</a>
  112. </div>
  113. <div>
  114. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Id">View.Id</a>
  115. </div>
  116. <div>
  117. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_IsCurrentTop">View.IsCurrentTop</a>
  118. </div>
  119. <div>
  120. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_WantMousePositionReports">View.WantMousePositionReports</a>
  121. </div>
  122. <div>
  123. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_WantContinuousButtonPressed">View.WantContinuousButtonPressed</a>
  124. </div>
  125. <div>
  126. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Frame">View.Frame</a>
  127. </div>
  128. <div>
  129. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_GetEnumerator">View.GetEnumerator()</a>
  130. </div>
  131. <div>
  132. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_LayoutStyle">View.LayoutStyle</a>
  133. </div>
  134. <div>
  135. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Bounds">View.Bounds</a>
  136. </div>
  137. <div>
  138. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_X">View.X</a>
  139. </div>
  140. <div>
  141. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Y">View.Y</a>
  142. </div>
  143. <div>
  144. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Width">View.Width</a>
  145. </div>
  146. <div>
  147. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Height">View.Height</a>
  148. </div>
  149. <div>
  150. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SuperView">View.SuperView</a>
  151. </div>
  152. <div>
  153. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SetNeedsDisplay">View.SetNeedsDisplay()</a>
  154. </div>
  155. <div>
  156. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SetNeedsDisplay_Terminal_Gui_Rect_">View.SetNeedsDisplay(Rect)</a>
  157. </div>
  158. <div>
  159. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ChildNeedsDisplay">View.ChildNeedsDisplay()</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_Add_Terminal_Gui_View___">View.Add(View[])</a>
  166. </div>
  167. <div>
  168. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_RemoveAll">View.RemoveAll()</a>
  169. </div>
  170. <div>
  171. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Remove_Terminal_Gui_View_">View.Remove(View)</a>
  172. </div>
  173. <div>
  174. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_BringSubviewToFront_Terminal_Gui_View_">View.BringSubviewToFront(View)</a>
  175. </div>
  176. <div>
  177. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SendSubviewToBack_Terminal_Gui_View_">View.SendSubviewToBack(View)</a>
  178. </div>
  179. <div>
  180. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SendSubviewBackwards_Terminal_Gui_View_">View.SendSubviewBackwards(View)</a>
  181. </div>
  182. <div>
  183. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_BringSubviewForward_Terminal_Gui_View_">View.BringSubviewForward(View)</a>
  184. </div>
  185. <div>
  186. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Clear">View.Clear()</a>
  187. </div>
  188. <div>
  189. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Clear_Terminal_Gui_Rect_">View.Clear(Rect)</a>
  190. </div>
  191. <div>
  192. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ScreenToView_System_Int32_System_Int32_">View.ScreenToView(Int32, Int32)</a>
  193. </div>
  194. <div>
  195. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ClipToBounds">View.ClipToBounds()</a>
  196. </div>
  197. <div>
  198. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SetClip_Terminal_Gui_Rect_">View.SetClip(Rect)</a>
  199. </div>
  200. <div>
  201. <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>
  202. </div>
  203. <div>
  204. <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>
  205. </div>
  206. <div>
  207. <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>
  208. </div>
  209. <div>
  210. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Move_System_Int32_System_Int32_">View.Move(Int32, Int32)</a>
  211. </div>
  212. <div>
  213. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_HasFocus">View.HasFocus</a>
  214. </div>
  215. <div>
  216. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnEnter">View.OnEnter()</a>
  217. </div>
  218. <div>
  219. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnLeave">View.OnLeave()</a>
  220. </div>
  221. <div>
  222. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Focused">View.Focused</a>
  223. </div>
  224. <div>
  225. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_MostFocused">View.MostFocused</a>
  226. </div>
  227. <div>
  228. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ColorScheme">View.ColorScheme</a>
  229. </div>
  230. <div>
  231. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_AddRune_System_Int32_System_Int32_System_Rune_">View.AddRune(Int32, Int32, Rune)</a>
  232. </div>
  233. <div>
  234. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ClearNeedsDisplay">View.ClearNeedsDisplay()</a>
  235. </div>
  236. <div>
  237. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_DrawContent">View.DrawContent</a>
  238. </div>
  239. <div>
  240. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnDrawContent_Terminal_Gui_Rect_">View.OnDrawContent(Rect)</a>
  241. </div>
  242. <div>
  243. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SetFocus_Terminal_Gui_View_">View.SetFocus(View)</a>
  244. </div>
  245. <div>
  246. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_KeyPress">View.KeyPress</a>
  247. </div>
  248. <div>
  249. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ProcessHotKey_Terminal_Gui_KeyEvent_">View.ProcessHotKey(KeyEvent)</a>
  250. </div>
  251. <div>
  252. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_KeyDown">View.KeyDown</a>
  253. </div>
  254. <div>
  255. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnKeyDown_Terminal_Gui_KeyEvent_">View.OnKeyDown(KeyEvent)</a>
  256. </div>
  257. <div>
  258. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_KeyUp">View.KeyUp</a>
  259. </div>
  260. <div>
  261. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnKeyUp_Terminal_Gui_KeyEvent_">View.OnKeyUp(KeyEvent)</a>
  262. </div>
  263. <div>
  264. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_EnsureFocus">View.EnsureFocus()</a>
  265. </div>
  266. <div>
  267. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_FocusFirst">View.FocusFirst()</a>
  268. </div>
  269. <div>
  270. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_FocusLast">View.FocusLast()</a>
  271. </div>
  272. <div>
  273. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_FocusPrev">View.FocusPrev()</a>
  274. </div>
  275. <div>
  276. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_FocusNext">View.FocusNext()</a>
  277. </div>
  278. <div>
  279. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_LayoutComplete">View.LayoutComplete</a>
  280. </div>
  281. <div>
  282. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_LayoutSubviews">View.LayoutSubviews()</a>
  283. </div>
  284. <div>
  285. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ToString">View.ToString()</a>
  286. </div>
  287. <div>
  288. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnMouseEnter_Terminal_Gui_MouseEvent_">View.OnMouseEnter(MouseEvent)</a>
  289. </div>
  290. <div>
  291. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnMouseLeave_Terminal_Gui_MouseEvent_">View.OnMouseLeave(MouseEvent)</a>
  292. </div>
  293. <div>
  294. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnMouseEvent_Terminal_Gui_MouseEvent_">View.OnMouseEvent(MouseEvent)</a>
  295. </div>
  296. <div>
  297. <a class="xref" href="Terminal.Gui.Responder.html#Terminal_Gui_Responder_CanFocus">Responder.CanFocus</a>
  298. </div>
  299. <div>
  300. <span class="xref">System.Object.Equals(System.Object)</span>
  301. </div>
  302. <div>
  303. <span class="xref">System.Object.Equals(System.Object, System.Object)</span>
  304. </div>
  305. <div>
  306. <span class="xref">System.Object.GetHashCode()</span>
  307. </div>
  308. <div>
  309. <span class="xref">System.Object.GetType()</span>
  310. </div>
  311. <div>
  312. <span class="xref">System.Object.MemberwiseClone()</span>
  313. </div>
  314. <div>
  315. <span class="xref">System.Object.ReferenceEquals(System.Object, System.Object)</span>
  316. </div>
  317. </div>
  318. <h6><strong>Namespace</strong>: <a class="xref" href="Terminal.Gui.html">Terminal.Gui</a></h6>
  319. <h6><strong>Assembly</strong>: Terminal.Gui.dll</h6>
  320. <h5 id="Terminal_Gui_RadioGroup_syntax">Syntax</h5>
  321. <div class="codewrapper">
  322. <pre><code class="lang-csharp hljs">public class RadioGroup : View, IEnumerable</code></pre>
  323. </div>
  324. <h3 id="constructors">Constructors
  325. </h3>
  326. <a id="Terminal_Gui_RadioGroup__ctor_" data-uid="Terminal.Gui.RadioGroup.#ctor*"></a>
  327. <h4 id="Terminal_Gui_RadioGroup__ctor_System_Int32_System_Int32_System_String___System_Int32_" data-uid="Terminal.Gui.RadioGroup.#ctor(System.Int32,System.Int32,System.String[],System.Int32)">RadioGroup(Int32, Int32, String[], Int32)</h4>
  328. <div class="markdown level1 summary">
  329. Initializes a new instance of the <a class="xref" href="Terminal.Gui.RadioGroup.html">RadioGroup</a> class
  330. setting up the initial set of radio labels and the item that should be selected.
  331. The <a class="xref" href="Terminal.Gui.View.html">View</a> frame is computed from the provided radio labels.
  332. </div>
  333. <div class="markdown level1 conceptual"></div>
  334. <h5 class="decalaration">Declaration</h5>
  335. <div class="codewrapper">
  336. <pre><code class="lang-csharp hljs">public RadioGroup(int x, int y, string[] radioLabels, int selected = 0)</code></pre>
  337. </div>
  338. <h5 class="parameters">Parameters</h5>
  339. <table class="table table-bordered table-striped table-condensed">
  340. <thead>
  341. <tr>
  342. <th>Type</th>
  343. <th>Name</th>
  344. <th>Description</th>
  345. </tr>
  346. </thead>
  347. <tbody>
  348. <tr>
  349. <td><span class="xref">System.Int32</span></td>
  350. <td><span class="parametername">x</span></td>
  351. <td>The x coordinate.</td>
  352. </tr>
  353. <tr>
  354. <td><span class="xref">System.Int32</span></td>
  355. <td><span class="parametername">y</span></td>
  356. <td>The y coordinate.</td>
  357. </tr>
  358. <tr>
  359. <td><span class="xref">System.String</span>[]</td>
  360. <td><span class="parametername">radioLabels</span></td>
  361. <td>The radio labels; an array of strings that can contain hotkeys using an underscore before the letter.</td>
  362. </tr>
  363. <tr>
  364. <td><span class="xref">System.Int32</span></td>
  365. <td><span class="parametername">selected</span></td>
  366. <td>The item to be selected, the value is clamped to the number of items.</td>
  367. </tr>
  368. </tbody>
  369. </table>
  370. <a id="Terminal_Gui_RadioGroup__ctor_" data-uid="Terminal.Gui.RadioGroup.#ctor*"></a>
  371. <h4 id="Terminal_Gui_RadioGroup__ctor_System_String___System_Int32_" data-uid="Terminal.Gui.RadioGroup.#ctor(System.String[],System.Int32)">RadioGroup(String[], Int32)</h4>
  372. <div class="markdown level1 summary">
  373. Initializes a new instance of the <a class="xref" href="Terminal.Gui.RadioGroup.html">RadioGroup</a> class
  374. setting up the initial set of radio labels and the item that should be selected.
  375. </div>
  376. <div class="markdown level1 conceptual"></div>
  377. <h5 class="decalaration">Declaration</h5>
  378. <div class="codewrapper">
  379. <pre><code class="lang-csharp hljs">public RadioGroup(string[] radioLabels, int selected = 0)</code></pre>
  380. </div>
  381. <h5 class="parameters">Parameters</h5>
  382. <table class="table table-bordered table-striped table-condensed">
  383. <thead>
  384. <tr>
  385. <th>Type</th>
  386. <th>Name</th>
  387. <th>Description</th>
  388. </tr>
  389. </thead>
  390. <tbody>
  391. <tr>
  392. <td><span class="xref">System.String</span>[]</td>
  393. <td><span class="parametername">radioLabels</span></td>
  394. <td>The radio labels; an array of strings that can contain hotkeys using an underscore before the letter.</td>
  395. </tr>
  396. <tr>
  397. <td><span class="xref">System.Int32</span></td>
  398. <td><span class="parametername">selected</span></td>
  399. <td>The index of the item to be selected, the value is clamped to the number of items.</td>
  400. </tr>
  401. </tbody>
  402. </table>
  403. <a id="Terminal_Gui_RadioGroup__ctor_" data-uid="Terminal.Gui.RadioGroup.#ctor*"></a>
  404. <h4 id="Terminal_Gui_RadioGroup__ctor_Terminal_Gui_Rect_System_String___System_Int32_" data-uid="Terminal.Gui.RadioGroup.#ctor(Terminal.Gui.Rect,System.String[],System.Int32)">RadioGroup(Rect, String[], Int32)</h4>
  405. <div class="markdown level1 summary">
  406. Initializes a new instance of the <a class="xref" href="Terminal.Gui.RadioGroup.html">RadioGroup</a> class
  407. setting up the initial set of radio labels and the item that should be selected and uses
  408. an absolute layout for the result.
  409. </div>
  410. <div class="markdown level1 conceptual"></div>
  411. <h5 class="decalaration">Declaration</h5>
  412. <div class="codewrapper">
  413. <pre><code class="lang-csharp hljs">public RadioGroup(Rect rect, string[] radioLabels, int selected = 0)</code></pre>
  414. </div>
  415. <h5 class="parameters">Parameters</h5>
  416. <table class="table table-bordered table-striped table-condensed">
  417. <thead>
  418. <tr>
  419. <th>Type</th>
  420. <th>Name</th>
  421. <th>Description</th>
  422. </tr>
  423. </thead>
  424. <tbody>
  425. <tr>
  426. <td><a class="xref" href="Terminal.Gui.Rect.html">Rect</a></td>
  427. <td><span class="parametername">rect</span></td>
  428. <td>Boundaries for the radio group.</td>
  429. </tr>
  430. <tr>
  431. <td><span class="xref">System.String</span>[]</td>
  432. <td><span class="parametername">radioLabels</span></td>
  433. <td>The radio labels; an array of strings that can contain hotkeys using an underscore before the letter.</td>
  434. </tr>
  435. <tr>
  436. <td><span class="xref">System.Int32</span></td>
  437. <td><span class="parametername">selected</span></td>
  438. <td>The index of item to be selected, the value is clamped to the number of items.</td>
  439. </tr>
  440. </tbody>
  441. </table>
  442. <h3 id="fields">Fields
  443. </h3>
  444. <h4 id="Terminal_Gui_RadioGroup_SelectionChanged" data-uid="Terminal.Gui.RadioGroup.SelectionChanged">SelectionChanged</h4>
  445. <div class="markdown level1 summary">
  446. Invoked when the selected radio label has changed
  447. </div>
  448. <div class="markdown level1 conceptual"></div>
  449. <h5 class="decalaration">Declaration</h5>
  450. <div class="codewrapper">
  451. <pre><code class="lang-csharp hljs">public Action&lt;int&gt; SelectionChanged</code></pre>
  452. </div>
  453. <h5 class="fieldValue">Field Value</h5>
  454. <table class="table table-bordered table-striped table-condensed">
  455. <thead>
  456. <tr>
  457. <th>Type</th>
  458. <th>Description</th>
  459. </tr>
  460. </thead>
  461. <tbody>
  462. <tr>
  463. <td><span class="xref">System.Action</span>&lt;<span class="xref">System.Int32</span>&gt;</td>
  464. <td></td>
  465. </tr>
  466. </tbody>
  467. </table>
  468. <h3 id="properties">Properties
  469. </h3>
  470. <a id="Terminal_Gui_RadioGroup_Cursor_" data-uid="Terminal.Gui.RadioGroup.Cursor*"></a>
  471. <h4 id="Terminal_Gui_RadioGroup_Cursor" data-uid="Terminal.Gui.RadioGroup.Cursor">Cursor</h4>
  472. <div class="markdown level1 summary">
  473. The location of the cursor in the <a class="xref" href="Terminal.Gui.RadioGroup.html">RadioGroup</a>
  474. </div>
  475. <div class="markdown level1 conceptual"></div>
  476. <h5 class="decalaration">Declaration</h5>
  477. <div class="codewrapper">
  478. <pre><code class="lang-csharp hljs">public int Cursor { get; set; }</code></pre>
  479. </div>
  480. <h5 class="propertyValue">Property Value</h5>
  481. <table class="table table-bordered table-striped table-condensed">
  482. <thead>
  483. <tr>
  484. <th>Type</th>
  485. <th>Description</th>
  486. </tr>
  487. </thead>
  488. <tbody>
  489. <tr>
  490. <td><span class="xref">System.Int32</span></td>
  491. <td></td>
  492. </tr>
  493. </tbody>
  494. </table>
  495. <a id="Terminal_Gui_RadioGroup_RadioLabels_" data-uid="Terminal.Gui.RadioGroup.RadioLabels*"></a>
  496. <h4 id="Terminal_Gui_RadioGroup_RadioLabels" data-uid="Terminal.Gui.RadioGroup.RadioLabels">RadioLabels</h4>
  497. <div class="markdown level1 summary">
  498. The radio labels to display
  499. </div>
  500. <div class="markdown level1 conceptual"></div>
  501. <h5 class="decalaration">Declaration</h5>
  502. <div class="codewrapper">
  503. <pre><code class="lang-csharp hljs">public string[] RadioLabels { get; set; }</code></pre>
  504. </div>
  505. <h5 class="propertyValue">Property Value</h5>
  506. <table class="table table-bordered table-striped table-condensed">
  507. <thead>
  508. <tr>
  509. <th>Type</th>
  510. <th>Description</th>
  511. </tr>
  512. </thead>
  513. <tbody>
  514. <tr>
  515. <td><span class="xref">System.String</span>[]</td>
  516. <td>The radio labels.</td>
  517. </tr>
  518. </tbody>
  519. </table>
  520. <a id="Terminal_Gui_RadioGroup_Selected_" data-uid="Terminal.Gui.RadioGroup.Selected*"></a>
  521. <h4 id="Terminal_Gui_RadioGroup_Selected" data-uid="Terminal.Gui.RadioGroup.Selected">Selected</h4>
  522. <div class="markdown level1 summary">
  523. The currently selected item from the list of radio labels
  524. </div>
  525. <div class="markdown level1 conceptual"></div>
  526. <h5 class="decalaration">Declaration</h5>
  527. <div class="codewrapper">
  528. <pre><code class="lang-csharp hljs">public int Selected { get; set; }</code></pre>
  529. </div>
  530. <h5 class="propertyValue">Property Value</h5>
  531. <table class="table table-bordered table-striped table-condensed">
  532. <thead>
  533. <tr>
  534. <th>Type</th>
  535. <th>Description</th>
  536. </tr>
  537. </thead>
  538. <tbody>
  539. <tr>
  540. <td><span class="xref">System.Int32</span></td>
  541. <td>The selected.</td>
  542. </tr>
  543. </tbody>
  544. </table>
  545. <h3 id="methods">Methods
  546. </h3>
  547. <a id="Terminal_Gui_RadioGroup_MouseEvent_" data-uid="Terminal.Gui.RadioGroup.MouseEvent*"></a>
  548. <h4 id="Terminal_Gui_RadioGroup_MouseEvent_Terminal_Gui_MouseEvent_" data-uid="Terminal.Gui.RadioGroup.MouseEvent(Terminal.Gui.MouseEvent)">MouseEvent(MouseEvent)</h4>
  549. <div class="markdown level1 summary"></div>
  550. <div class="markdown level1 conceptual"></div>
  551. <h5 class="decalaration">Declaration</h5>
  552. <div class="codewrapper">
  553. <pre><code class="lang-csharp hljs">public override bool MouseEvent(MouseEvent me)</code></pre>
  554. </div>
  555. <h5 class="parameters">Parameters</h5>
  556. <table class="table table-bordered table-striped table-condensed">
  557. <thead>
  558. <tr>
  559. <th>Type</th>
  560. <th>Name</th>
  561. <th>Description</th>
  562. </tr>
  563. </thead>
  564. <tbody>
  565. <tr>
  566. <td><a class="xref" href="Terminal.Gui.MouseEvent.html">MouseEvent</a></td>
  567. <td><span class="parametername">me</span></td>
  568. <td></td>
  569. </tr>
  570. </tbody>
  571. </table>
  572. <h5 class="returns">Returns</h5>
  573. <table class="table table-bordered table-striped table-condensed">
  574. <thead>
  575. <tr>
  576. <th>Type</th>
  577. <th>Description</th>
  578. </tr>
  579. </thead>
  580. <tbody>
  581. <tr>
  582. <td><span class="xref">System.Boolean</span></td>
  583. <td></td>
  584. </tr>
  585. </tbody>
  586. </table>
  587. <h5 class="overrides">Overrides</h5>
  588. <div><a class="xref" href="Terminal.Gui.Responder.html#Terminal_Gui_Responder_MouseEvent_Terminal_Gui_MouseEvent_">Responder.MouseEvent(MouseEvent)</a></div>
  589. <a id="Terminal_Gui_RadioGroup_PositionCursor_" data-uid="Terminal.Gui.RadioGroup.PositionCursor*"></a>
  590. <h4 id="Terminal_Gui_RadioGroup_PositionCursor" data-uid="Terminal.Gui.RadioGroup.PositionCursor">PositionCursor()</h4>
  591. <div class="markdown level1 summary"></div>
  592. <div class="markdown level1 conceptual"></div>
  593. <h5 class="decalaration">Declaration</h5>
  594. <div class="codewrapper">
  595. <pre><code class="lang-csharp hljs">public override void PositionCursor()</code></pre>
  596. </div>
  597. <h5 class="overrides">Overrides</h5>
  598. <div><a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_PositionCursor">View.PositionCursor()</a></div>
  599. <a id="Terminal_Gui_RadioGroup_ProcessColdKey_" data-uid="Terminal.Gui.RadioGroup.ProcessColdKey*"></a>
  600. <h4 id="Terminal_Gui_RadioGroup_ProcessColdKey_Terminal_Gui_KeyEvent_" data-uid="Terminal.Gui.RadioGroup.ProcessColdKey(Terminal.Gui.KeyEvent)">ProcessColdKey(KeyEvent)</h4>
  601. <div class="markdown level1 summary"></div>
  602. <div class="markdown level1 conceptual"></div>
  603. <h5 class="decalaration">Declaration</h5>
  604. <div class="codewrapper">
  605. <pre><code class="lang-csharp hljs">public override bool ProcessColdKey(KeyEvent kb)</code></pre>
  606. </div>
  607. <h5 class="parameters">Parameters</h5>
  608. <table class="table table-bordered table-striped table-condensed">
  609. <thead>
  610. <tr>
  611. <th>Type</th>
  612. <th>Name</th>
  613. <th>Description</th>
  614. </tr>
  615. </thead>
  616. <tbody>
  617. <tr>
  618. <td><a class="xref" href="Terminal.Gui.KeyEvent.html">KeyEvent</a></td>
  619. <td><span class="parametername">kb</span></td>
  620. <td></td>
  621. </tr>
  622. </tbody>
  623. </table>
  624. <h5 class="returns">Returns</h5>
  625. <table class="table table-bordered table-striped table-condensed">
  626. <thead>
  627. <tr>
  628. <th>Type</th>
  629. <th>Description</th>
  630. </tr>
  631. </thead>
  632. <tbody>
  633. <tr>
  634. <td><span class="xref">System.Boolean</span></td>
  635. <td></td>
  636. </tr>
  637. </tbody>
  638. </table>
  639. <h5 class="overrides">Overrides</h5>
  640. <div><a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ProcessColdKey_Terminal_Gui_KeyEvent_">View.ProcessColdKey(KeyEvent)</a></div>
  641. <a id="Terminal_Gui_RadioGroup_ProcessKey_" data-uid="Terminal.Gui.RadioGroup.ProcessKey*"></a>
  642. <h4 id="Terminal_Gui_RadioGroup_ProcessKey_Terminal_Gui_KeyEvent_" data-uid="Terminal.Gui.RadioGroup.ProcessKey(Terminal.Gui.KeyEvent)">ProcessKey(KeyEvent)</h4>
  643. <div class="markdown level1 summary"></div>
  644. <div class="markdown level1 conceptual"></div>
  645. <h5 class="decalaration">Declaration</h5>
  646. <div class="codewrapper">
  647. <pre><code class="lang-csharp hljs">public override bool ProcessKey(KeyEvent kb)</code></pre>
  648. </div>
  649. <h5 class="parameters">Parameters</h5>
  650. <table class="table table-bordered table-striped table-condensed">
  651. <thead>
  652. <tr>
  653. <th>Type</th>
  654. <th>Name</th>
  655. <th>Description</th>
  656. </tr>
  657. </thead>
  658. <tbody>
  659. <tr>
  660. <td><a class="xref" href="Terminal.Gui.KeyEvent.html">KeyEvent</a></td>
  661. <td><span class="parametername">kb</span></td>
  662. <td></td>
  663. </tr>
  664. </tbody>
  665. </table>
  666. <h5 class="returns">Returns</h5>
  667. <table class="table table-bordered table-striped table-condensed">
  668. <thead>
  669. <tr>
  670. <th>Type</th>
  671. <th>Description</th>
  672. </tr>
  673. </thead>
  674. <tbody>
  675. <tr>
  676. <td><span class="xref">System.Boolean</span></td>
  677. <td></td>
  678. </tr>
  679. </tbody>
  680. </table>
  681. <h5 class="overrides">Overrides</h5>
  682. <div><a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ProcessKey_Terminal_Gui_KeyEvent_">View.ProcessKey(KeyEvent)</a></div>
  683. <a id="Terminal_Gui_RadioGroup_Redraw_" data-uid="Terminal.Gui.RadioGroup.Redraw*"></a>
  684. <h4 id="Terminal_Gui_RadioGroup_Redraw_Terminal_Gui_Rect_" data-uid="Terminal.Gui.RadioGroup.Redraw(Terminal.Gui.Rect)">Redraw(Rect)</h4>
  685. <div class="markdown level1 summary"></div>
  686. <div class="markdown level1 conceptual"></div>
  687. <h5 class="decalaration">Declaration</h5>
  688. <div class="codewrapper">
  689. <pre><code class="lang-csharp hljs">public override void Redraw(Rect bounds)</code></pre>
  690. </div>
  691. <h5 class="parameters">Parameters</h5>
  692. <table class="table table-bordered table-striped table-condensed">
  693. <thead>
  694. <tr>
  695. <th>Type</th>
  696. <th>Name</th>
  697. <th>Description</th>
  698. </tr>
  699. </thead>
  700. <tbody>
  701. <tr>
  702. <td><a class="xref" href="Terminal.Gui.Rect.html">Rect</a></td>
  703. <td><span class="parametername">bounds</span></td>
  704. <td></td>
  705. </tr>
  706. </tbody>
  707. </table>
  708. <h5 class="overrides">Overrides</h5>
  709. <div><a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Redraw_Terminal_Gui_Rect_">View.Redraw(Rect)</a></div>
  710. <h3 id="implements">Implements</h3>
  711. <div>
  712. <span class="xref">System.Collections.IEnumerable</span>
  713. </div>
  714. </article>
  715. </div>
  716. <div class="hidden-sm col-md-2" role="complementary">
  717. <div class="sideaffix">
  718. <div class="contribution">
  719. <ul class="nav">
  720. </ul>
  721. </div>
  722. <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
  723. <!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
  724. </nav>
  725. </div>
  726. </div>
  727. </div>
  728. </div>
  729. <footer>
  730. <div class="grad-bottom"></div>
  731. <div class="footer">
  732. <div class="container">
  733. <span class="pull-right">
  734. <a href="#top">Back to top</a>
  735. </span>
  736. <span>Generated by <strong>DocFX</strong></span>
  737. </div>
  738. </div>
  739. </footer>
  740. </div>
  741. <script type="text/javascript" src="../../styles/docfx.vendor.js"></script>
  742. <script type="text/javascript" src="../../styles/docfx.js"></script>
  743. <script type="text/javascript" src="../../styles/main.js"></script>
  744. </body>
  745. </html>