Terminal.Gui.ListView.html 46 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163
  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 ListView
  8. </title>
  9. <meta name="viewport" content="width=device-width">
  10. <meta name="title" content="Class ListView
  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.ListView">
  73. <h1 id="Terminal_Gui_ListView" data-uid="Terminal.Gui.ListView" class="text-break">Class ListView
  74. </h1>
  75. <div class="markdown level0 summary">
  76. ListView <a class="xref" href="Terminal.Gui.View.html">View</a> renders a scrollable list of data where each item can be activated to perform an action.
  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">ListView</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_ListView_syntax">Syntax</h5>
  309. <div class="codewrapper">
  310. <pre><code class="lang-csharp hljs">public class ListView : View, IEnumerable</code></pre>
  311. </div>
  312. <h5 id="Terminal_Gui_ListView_remarks"><strong>Remarks</strong></h5>
  313. <div class="markdown level0 remarks">
  314. <p>
  315. The <a class="xref" href="Terminal.Gui.ListView.html">ListView</a> displays lists of data and allows the user to scroll through the data.
  316. Items in the can be activated firing an event (with the ENTER key or a mouse double-click).
  317. If the <a class="xref" href="Terminal.Gui.ListView.html#Terminal_Gui_ListView_AllowsMarking">AllowsMarking</a> property is true, elements of the list can be marked by the user.
  318. </p>
  319. <p>
  320. By default <a class="xref" href="Terminal.Gui.ListView.html">ListView</a> uses <span class="xref">System.Object.ToString()</span> to render the items of any
  321. <span class="xref">System.Collections.IList</span> object (e.g. arrays, <span class="xref">System.Collections.Generic.List&lt;T&gt;</span>,
  322. and other collections). Alternatively, an object that implements the <a class="xref" href="Terminal.Gui.IListDataSource.html">IListDataSource</a>
  323. interface can be provided giving full control of what is rendered.
  324. </p>
  325. <p>
  326. <a class="xref" href="Terminal.Gui.ListView.html">ListView</a> can display any object that implements the <span class="xref">System.Collections.IList</span> interface.
  327. <span class="xref">System.String</span> values are converted into <span class="xref">NStack.ustring</span> values before rendering, and other values are
  328. converted into <span class="xref">System.String</span> by calling <span class="xref">System.Object.ToString()</span> and then converting to <span class="xref">NStack.ustring</span> .
  329. </p>
  330. <p>
  331. To change the contents of the ListView, set the <a class="xref" href="Terminal.Gui.ListView.html#Terminal_Gui_ListView_Source">Source</a> property (when
  332. providing custom rendering via <a class="xref" href="Terminal.Gui.IListDataSource.html">IListDataSource</a>) or call <a class="xref" href="Terminal.Gui.ListView.html#Terminal_Gui_ListView_SetSource_System_Collections_IList_">SetSource(IList)</a>
  333. an <span class="xref">System.Collections.IList</span> is being used.
  334. </p>
  335. <p>
  336. When <a class="xref" href="Terminal.Gui.ListView.html#Terminal_Gui_ListView_AllowsMarking">AllowsMarking</a> is set to true the rendering will prefix the rendered items with
  337. [x] or [ ] and bind the SPACE key to toggle the selection. To implement a different
  338. marking style set <a class="xref" href="Terminal.Gui.ListView.html#Terminal_Gui_ListView_AllowsMarking">AllowsMarking</a> to false and implement custom rendering.
  339. </p>
  340. </div>
  341. <h3 id="constructors">Constructors
  342. </h3>
  343. <a id="Terminal_Gui_ListView__ctor_" data-uid="Terminal.Gui.ListView.#ctor*"></a>
  344. <h4 id="Terminal_Gui_ListView__ctor" data-uid="Terminal.Gui.ListView.#ctor">ListView()</h4>
  345. <div class="markdown level1 summary">
  346. Initializes a new instance of <a class="xref" href="Terminal.Gui.ListView.html">ListView</a>. Set the <a class="xref" href="Terminal.Gui.ListView.html#Terminal_Gui_ListView_Source">Source</a> property to display something.
  347. </div>
  348. <div class="markdown level1 conceptual"></div>
  349. <h5 class="decalaration">Declaration</h5>
  350. <div class="codewrapper">
  351. <pre><code class="lang-csharp hljs">public ListView()</code></pre>
  352. </div>
  353. <a id="Terminal_Gui_ListView__ctor_" data-uid="Terminal.Gui.ListView.#ctor*"></a>
  354. <h4 id="Terminal_Gui_ListView__ctor_System_Collections_IList_" data-uid="Terminal.Gui.ListView.#ctor(System.Collections.IList)">ListView(IList)</h4>
  355. <div class="markdown level1 summary">
  356. Initializes a new instance of <a class="xref" href="Terminal.Gui.ListView.html">ListView</a> that will display the contents of the object implementing the <span class="xref">System.Collections.IList</span> interface,
  357. with relative positioning.
  358. </div>
  359. <div class="markdown level1 conceptual"></div>
  360. <h5 class="decalaration">Declaration</h5>
  361. <div class="codewrapper">
  362. <pre><code class="lang-csharp hljs">public ListView(IList source)</code></pre>
  363. </div>
  364. <h5 class="parameters">Parameters</h5>
  365. <table class="table table-bordered table-striped table-condensed">
  366. <thead>
  367. <tr>
  368. <th>Type</th>
  369. <th>Name</th>
  370. <th>Description</th>
  371. </tr>
  372. </thead>
  373. <tbody>
  374. <tr>
  375. <td><span class="xref">System.Collections.IList</span></td>
  376. <td><span class="parametername">source</span></td>
  377. <td>An <span class="xref">System.Collections.IList</span> data source, if the elements are strings or ustrings, the string is rendered, otherwise the ToString() method is invoked on the result.</td>
  378. </tr>
  379. </tbody>
  380. </table>
  381. <a id="Terminal_Gui_ListView__ctor_" data-uid="Terminal.Gui.ListView.#ctor*"></a>
  382. <h4 id="Terminal_Gui_ListView__ctor_Terminal_Gui_IListDataSource_" data-uid="Terminal.Gui.ListView.#ctor(Terminal.Gui.IListDataSource)">ListView(IListDataSource)</h4>
  383. <div class="markdown level1 summary">
  384. Initializes a new instance of <a class="xref" href="Terminal.Gui.ListView.html">ListView</a> that will display the provided data source, using relative positioning.
  385. </div>
  386. <div class="markdown level1 conceptual"></div>
  387. <h5 class="decalaration">Declaration</h5>
  388. <div class="codewrapper">
  389. <pre><code class="lang-csharp hljs">public ListView(IListDataSource source)</code></pre>
  390. </div>
  391. <h5 class="parameters">Parameters</h5>
  392. <table class="table table-bordered table-striped table-condensed">
  393. <thead>
  394. <tr>
  395. <th>Type</th>
  396. <th>Name</th>
  397. <th>Description</th>
  398. </tr>
  399. </thead>
  400. <tbody>
  401. <tr>
  402. <td><a class="xref" href="Terminal.Gui.IListDataSource.html">IListDataSource</a></td>
  403. <td><span class="parametername">source</span></td>
  404. <td><a class="xref" href="Terminal.Gui.IListDataSource.html">IListDataSource</a> object that provides a mechanism to render the data.
  405. The number of elements on the collection should not change, if you must change, set
  406. the &quot;Source&quot; property to reset the internal settings of the ListView.</td>
  407. </tr>
  408. </tbody>
  409. </table>
  410. <a id="Terminal_Gui_ListView__ctor_" data-uid="Terminal.Gui.ListView.#ctor*"></a>
  411. <h4 id="Terminal_Gui_ListView__ctor_Terminal_Gui_Rect_System_Collections_IList_" data-uid="Terminal.Gui.ListView.#ctor(Terminal.Gui.Rect,System.Collections.IList)">ListView(Rect, IList)</h4>
  412. <div class="markdown level1 summary">
  413. Initializes a new instance of <a class="xref" href="Terminal.Gui.ListView.html">ListView</a> that will display the contents of the object implementing the <span class="xref">System.Collections.IList</span> interface with an absolute position.
  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 ListView(Rect rect, IList source)</code></pre>
  419. </div>
  420. <h5 class="parameters">Parameters</h5>
  421. <table class="table table-bordered table-striped table-condensed">
  422. <thead>
  423. <tr>
  424. <th>Type</th>
  425. <th>Name</th>
  426. <th>Description</th>
  427. </tr>
  428. </thead>
  429. <tbody>
  430. <tr>
  431. <td><a class="xref" href="Terminal.Gui.Rect.html">Rect</a></td>
  432. <td><span class="parametername">rect</span></td>
  433. <td>Frame for the listview.</td>
  434. </tr>
  435. <tr>
  436. <td><span class="xref">System.Collections.IList</span></td>
  437. <td><span class="parametername">source</span></td>
  438. <td>An IList data source, if the elements of the IList are strings or ustrings, the string is rendered, otherwise the ToString() method is invoked on the result.</td>
  439. </tr>
  440. </tbody>
  441. </table>
  442. <a id="Terminal_Gui_ListView__ctor_" data-uid="Terminal.Gui.ListView.#ctor*"></a>
  443. <h4 id="Terminal_Gui_ListView__ctor_Terminal_Gui_Rect_Terminal_Gui_IListDataSource_" data-uid="Terminal.Gui.ListView.#ctor(Terminal.Gui.Rect,Terminal.Gui.IListDataSource)">ListView(Rect, IListDataSource)</h4>
  444. <div class="markdown level1 summary">
  445. Initializes a new instance of <a class="xref" href="Terminal.Gui.ListView.html">ListView</a> with the provided data source and an absolute position
  446. </div>
  447. <div class="markdown level1 conceptual"></div>
  448. <h5 class="decalaration">Declaration</h5>
  449. <div class="codewrapper">
  450. <pre><code class="lang-csharp hljs">public ListView(Rect rect, IListDataSource source)</code></pre>
  451. </div>
  452. <h5 class="parameters">Parameters</h5>
  453. <table class="table table-bordered table-striped table-condensed">
  454. <thead>
  455. <tr>
  456. <th>Type</th>
  457. <th>Name</th>
  458. <th>Description</th>
  459. </tr>
  460. </thead>
  461. <tbody>
  462. <tr>
  463. <td><a class="xref" href="Terminal.Gui.Rect.html">Rect</a></td>
  464. <td><span class="parametername">rect</span></td>
  465. <td>Frame for the listview.</td>
  466. </tr>
  467. <tr>
  468. <td><a class="xref" href="Terminal.Gui.IListDataSource.html">IListDataSource</a></td>
  469. <td><span class="parametername">source</span></td>
  470. <td>IListDataSource object that provides a mechanism to render the data. The number of elements on the collection should not change, if you must change, set the &quot;Source&quot; property to reset the internal settings of the ListView.</td>
  471. </tr>
  472. </tbody>
  473. </table>
  474. <h3 id="properties">Properties
  475. </h3>
  476. <a id="Terminal_Gui_ListView_AllowsMarking_" data-uid="Terminal.Gui.ListView.AllowsMarking*"></a>
  477. <h4 id="Terminal_Gui_ListView_AllowsMarking" data-uid="Terminal.Gui.ListView.AllowsMarking">AllowsMarking</h4>
  478. <div class="markdown level1 summary">
  479. Gets or sets whether this <a class="xref" href="Terminal.Gui.ListView.html">ListView</a> allows items to be marked.
  480. </div>
  481. <div class="markdown level1 conceptual"></div>
  482. <h5 class="decalaration">Declaration</h5>
  483. <div class="codewrapper">
  484. <pre><code class="lang-csharp hljs">public bool AllowsMarking { get; set; }</code></pre>
  485. </div>
  486. <h5 class="propertyValue">Property Value</h5>
  487. <table class="table table-bordered table-striped table-condensed">
  488. <thead>
  489. <tr>
  490. <th>Type</th>
  491. <th>Description</th>
  492. </tr>
  493. </thead>
  494. <tbody>
  495. <tr>
  496. <td><span class="xref">System.Boolean</span></td>
  497. <td><code>true</code> if allows marking elements of the list; otherwise, <code>false</code>.
  498. </td>
  499. </tr>
  500. </tbody>
  501. </table>
  502. <h5 id="Terminal_Gui_ListView_AllowsMarking_remarks">Remarks</h5>
  503. <div class="markdown level1 remarks">
  504. If set to true, <a class="xref" href="Terminal.Gui.ListView.html">ListView</a> will render items marked items with &quot;[x]&quot;, and unmarked items with &quot;[ ]&quot;
  505. spaces. SPACE key will toggle marking.
  506. </div>
  507. <a id="Terminal_Gui_ListView_AllowsMultipleSelection_" data-uid="Terminal.Gui.ListView.AllowsMultipleSelection*"></a>
  508. <h4 id="Terminal_Gui_ListView_AllowsMultipleSelection" data-uid="Terminal.Gui.ListView.AllowsMultipleSelection">AllowsMultipleSelection</h4>
  509. <div class="markdown level1 summary">
  510. If set to true allows more than one item to be selected. If false only allow one item selected.
  511. </div>
  512. <div class="markdown level1 conceptual"></div>
  513. <h5 class="decalaration">Declaration</h5>
  514. <div class="codewrapper">
  515. <pre><code class="lang-csharp hljs">public bool AllowsMultipleSelection { get; set; }</code></pre>
  516. </div>
  517. <h5 class="propertyValue">Property Value</h5>
  518. <table class="table table-bordered table-striped table-condensed">
  519. <thead>
  520. <tr>
  521. <th>Type</th>
  522. <th>Description</th>
  523. </tr>
  524. </thead>
  525. <tbody>
  526. <tr>
  527. <td><span class="xref">System.Boolean</span></td>
  528. <td></td>
  529. </tr>
  530. </tbody>
  531. </table>
  532. <a id="Terminal_Gui_ListView_SelectedItem_" data-uid="Terminal.Gui.ListView.SelectedItem*"></a>
  533. <h4 id="Terminal_Gui_ListView_SelectedItem" data-uid="Terminal.Gui.ListView.SelectedItem">SelectedItem</h4>
  534. <div class="markdown level1 summary">
  535. Gets or sets the index of the currently selected item.
  536. </div>
  537. <div class="markdown level1 conceptual"></div>
  538. <h5 class="decalaration">Declaration</h5>
  539. <div class="codewrapper">
  540. <pre><code class="lang-csharp hljs">public int SelectedItem { get; set; }</code></pre>
  541. </div>
  542. <h5 class="propertyValue">Property Value</h5>
  543. <table class="table table-bordered table-striped table-condensed">
  544. <thead>
  545. <tr>
  546. <th>Type</th>
  547. <th>Description</th>
  548. </tr>
  549. </thead>
  550. <tbody>
  551. <tr>
  552. <td><span class="xref">System.Int32</span></td>
  553. <td>The selected item.</td>
  554. </tr>
  555. </tbody>
  556. </table>
  557. <a id="Terminal_Gui_ListView_Source_" data-uid="Terminal.Gui.ListView.Source*"></a>
  558. <h4 id="Terminal_Gui_ListView_Source" data-uid="Terminal.Gui.ListView.Source">Source</h4>
  559. <div class="markdown level1 summary">
  560. Gets or sets the <a class="xref" href="Terminal.Gui.IListDataSource.html">IListDataSource</a> backing this <a class="xref" href="Terminal.Gui.ListView.html">ListView</a>, enabling custom rendering.
  561. </div>
  562. <div class="markdown level1 conceptual"></div>
  563. <h5 class="decalaration">Declaration</h5>
  564. <div class="codewrapper">
  565. <pre><code class="lang-csharp hljs">public IListDataSource Source { get; set; }</code></pre>
  566. </div>
  567. <h5 class="propertyValue">Property Value</h5>
  568. <table class="table table-bordered table-striped table-condensed">
  569. <thead>
  570. <tr>
  571. <th>Type</th>
  572. <th>Description</th>
  573. </tr>
  574. </thead>
  575. <tbody>
  576. <tr>
  577. <td><a class="xref" href="Terminal.Gui.IListDataSource.html">IListDataSource</a></td>
  578. <td>The source.</td>
  579. </tr>
  580. </tbody>
  581. </table>
  582. <h5 id="Terminal_Gui_ListView_Source_remarks">Remarks</h5>
  583. <div class="markdown level1 remarks">
  584. Use <a class="xref" href="Terminal.Gui.ListView.html#Terminal_Gui_ListView_SetSource_System_Collections_IList_">SetSource(IList)</a> to set a new <span class="xref">System.Collections.IList</span> source.
  585. </div>
  586. <a id="Terminal_Gui_ListView_TopItem_" data-uid="Terminal.Gui.ListView.TopItem*"></a>
  587. <h4 id="Terminal_Gui_ListView_TopItem" data-uid="Terminal.Gui.ListView.TopItem">TopItem</h4>
  588. <div class="markdown level1 summary">
  589. Gets or sets the item that is displayed at the top of the <a class="xref" href="Terminal.Gui.ListView.html">ListView</a>.
  590. </div>
  591. <div class="markdown level1 conceptual"></div>
  592. <h5 class="decalaration">Declaration</h5>
  593. <div class="codewrapper">
  594. <pre><code class="lang-csharp hljs">public int TopItem { get; set; }</code></pre>
  595. </div>
  596. <h5 class="propertyValue">Property Value</h5>
  597. <table class="table table-bordered table-striped table-condensed">
  598. <thead>
  599. <tr>
  600. <th>Type</th>
  601. <th>Description</th>
  602. </tr>
  603. </thead>
  604. <tbody>
  605. <tr>
  606. <td><span class="xref">System.Int32</span></td>
  607. <td>The top item.</td>
  608. </tr>
  609. </tbody>
  610. </table>
  611. <h3 id="methods">Methods
  612. </h3>
  613. <a id="Terminal_Gui_ListView_AllowsAll_" data-uid="Terminal.Gui.ListView.AllowsAll*"></a>
  614. <h4 id="Terminal_Gui_ListView_AllowsAll" data-uid="Terminal.Gui.ListView.AllowsAll">AllowsAll()</h4>
  615. <div class="markdown level1 summary">
  616. Prevents marking if it&apos;s not allowed mark and if it&apos;s not allows multiple selection.
  617. </div>
  618. <div class="markdown level1 conceptual"></div>
  619. <h5 class="decalaration">Declaration</h5>
  620. <div class="codewrapper">
  621. <pre><code class="lang-csharp hljs">public virtual bool AllowsAll()</code></pre>
  622. </div>
  623. <h5 class="returns">Returns</h5>
  624. <table class="table table-bordered table-striped table-condensed">
  625. <thead>
  626. <tr>
  627. <th>Type</th>
  628. <th>Description</th>
  629. </tr>
  630. </thead>
  631. <tbody>
  632. <tr>
  633. <td><span class="xref">System.Boolean</span></td>
  634. <td></td>
  635. </tr>
  636. </tbody>
  637. </table>
  638. <a id="Terminal_Gui_ListView_MarkUnmarkRow_" data-uid="Terminal.Gui.ListView.MarkUnmarkRow*"></a>
  639. <h4 id="Terminal_Gui_ListView_MarkUnmarkRow" data-uid="Terminal.Gui.ListView.MarkUnmarkRow">MarkUnmarkRow()</h4>
  640. <div class="markdown level1 summary">
  641. Marks an unmarked row.
  642. </div>
  643. <div class="markdown level1 conceptual"></div>
  644. <h5 class="decalaration">Declaration</h5>
  645. <div class="codewrapper">
  646. <pre><code class="lang-csharp hljs">public virtual bool MarkUnmarkRow()</code></pre>
  647. </div>
  648. <h5 class="returns">Returns</h5>
  649. <table class="table table-bordered table-striped table-condensed">
  650. <thead>
  651. <tr>
  652. <th>Type</th>
  653. <th>Description</th>
  654. </tr>
  655. </thead>
  656. <tbody>
  657. <tr>
  658. <td><span class="xref">System.Boolean</span></td>
  659. <td></td>
  660. </tr>
  661. </tbody>
  662. </table>
  663. <a id="Terminal_Gui_ListView_MouseEvent_" data-uid="Terminal.Gui.ListView.MouseEvent*"></a>
  664. <h4 id="Terminal_Gui_ListView_MouseEvent_Terminal_Gui_MouseEvent_" data-uid="Terminal.Gui.ListView.MouseEvent(Terminal.Gui.MouseEvent)">MouseEvent(MouseEvent)</h4>
  665. <div class="markdown level1 summary"></div>
  666. <div class="markdown level1 conceptual"></div>
  667. <h5 class="decalaration">Declaration</h5>
  668. <div class="codewrapper">
  669. <pre><code class="lang-csharp hljs">public override bool MouseEvent(MouseEvent me)</code></pre>
  670. </div>
  671. <h5 class="parameters">Parameters</h5>
  672. <table class="table table-bordered table-striped table-condensed">
  673. <thead>
  674. <tr>
  675. <th>Type</th>
  676. <th>Name</th>
  677. <th>Description</th>
  678. </tr>
  679. </thead>
  680. <tbody>
  681. <tr>
  682. <td><a class="xref" href="Terminal.Gui.MouseEvent.html">MouseEvent</a></td>
  683. <td><span class="parametername">me</span></td>
  684. <td></td>
  685. </tr>
  686. </tbody>
  687. </table>
  688. <h5 class="returns">Returns</h5>
  689. <table class="table table-bordered table-striped table-condensed">
  690. <thead>
  691. <tr>
  692. <th>Type</th>
  693. <th>Description</th>
  694. </tr>
  695. </thead>
  696. <tbody>
  697. <tr>
  698. <td><span class="xref">System.Boolean</span></td>
  699. <td></td>
  700. </tr>
  701. </tbody>
  702. </table>
  703. <h5 class="overrides">Overrides</h5>
  704. <div><a class="xref" href="Terminal.Gui.Responder.html#Terminal_Gui_Responder_MouseEvent_Terminal_Gui_MouseEvent_">Responder.MouseEvent(MouseEvent)</a></div>
  705. <a id="Terminal_Gui_ListView_MoveDown_" data-uid="Terminal.Gui.ListView.MoveDown*"></a>
  706. <h4 id="Terminal_Gui_ListView_MoveDown" data-uid="Terminal.Gui.ListView.MoveDown">MoveDown()</h4>
  707. <div class="markdown level1 summary">
  708. Moves the selected item index to the next row.
  709. </div>
  710. <div class="markdown level1 conceptual"></div>
  711. <h5 class="decalaration">Declaration</h5>
  712. <div class="codewrapper">
  713. <pre><code class="lang-csharp hljs">public virtual bool MoveDown()</code></pre>
  714. </div>
  715. <h5 class="returns">Returns</h5>
  716. <table class="table table-bordered table-striped table-condensed">
  717. <thead>
  718. <tr>
  719. <th>Type</th>
  720. <th>Description</th>
  721. </tr>
  722. </thead>
  723. <tbody>
  724. <tr>
  725. <td><span class="xref">System.Boolean</span></td>
  726. <td></td>
  727. </tr>
  728. </tbody>
  729. </table>
  730. <a id="Terminal_Gui_ListView_MovePageDown_" data-uid="Terminal.Gui.ListView.MovePageDown*"></a>
  731. <h4 id="Terminal_Gui_ListView_MovePageDown" data-uid="Terminal.Gui.ListView.MovePageDown">MovePageDown()</h4>
  732. <div class="markdown level1 summary">
  733. Moves the selected item index to the previous page.
  734. </div>
  735. <div class="markdown level1 conceptual"></div>
  736. <h5 class="decalaration">Declaration</h5>
  737. <div class="codewrapper">
  738. <pre><code class="lang-csharp hljs">public virtual bool MovePageDown()</code></pre>
  739. </div>
  740. <h5 class="returns">Returns</h5>
  741. <table class="table table-bordered table-striped table-condensed">
  742. <thead>
  743. <tr>
  744. <th>Type</th>
  745. <th>Description</th>
  746. </tr>
  747. </thead>
  748. <tbody>
  749. <tr>
  750. <td><span class="xref">System.Boolean</span></td>
  751. <td></td>
  752. </tr>
  753. </tbody>
  754. </table>
  755. <a id="Terminal_Gui_ListView_MovePageUp_" data-uid="Terminal.Gui.ListView.MovePageUp*"></a>
  756. <h4 id="Terminal_Gui_ListView_MovePageUp" data-uid="Terminal.Gui.ListView.MovePageUp">MovePageUp()</h4>
  757. <div class="markdown level1 summary">
  758. Moves the selected item index to the next page.
  759. </div>
  760. <div class="markdown level1 conceptual"></div>
  761. <h5 class="decalaration">Declaration</h5>
  762. <div class="codewrapper">
  763. <pre><code class="lang-csharp hljs">public virtual bool MovePageUp()</code></pre>
  764. </div>
  765. <h5 class="returns">Returns</h5>
  766. <table class="table table-bordered table-striped table-condensed">
  767. <thead>
  768. <tr>
  769. <th>Type</th>
  770. <th>Description</th>
  771. </tr>
  772. </thead>
  773. <tbody>
  774. <tr>
  775. <td><span class="xref">System.Boolean</span></td>
  776. <td></td>
  777. </tr>
  778. </tbody>
  779. </table>
  780. <a id="Terminal_Gui_ListView_MoveUp_" data-uid="Terminal.Gui.ListView.MoveUp*"></a>
  781. <h4 id="Terminal_Gui_ListView_MoveUp" data-uid="Terminal.Gui.ListView.MoveUp">MoveUp()</h4>
  782. <div class="markdown level1 summary">
  783. Moves the selected item index to the previous row.
  784. </div>
  785. <div class="markdown level1 conceptual"></div>
  786. <h5 class="decalaration">Declaration</h5>
  787. <div class="codewrapper">
  788. <pre><code class="lang-csharp hljs">public virtual bool MoveUp()</code></pre>
  789. </div>
  790. <h5 class="returns">Returns</h5>
  791. <table class="table table-bordered table-striped table-condensed">
  792. <thead>
  793. <tr>
  794. <th>Type</th>
  795. <th>Description</th>
  796. </tr>
  797. </thead>
  798. <tbody>
  799. <tr>
  800. <td><span class="xref">System.Boolean</span></td>
  801. <td></td>
  802. </tr>
  803. </tbody>
  804. </table>
  805. <a id="Terminal_Gui_ListView_OnOpenSelectedItem_" data-uid="Terminal.Gui.ListView.OnOpenSelectedItem*"></a>
  806. <h4 id="Terminal_Gui_ListView_OnOpenSelectedItem" data-uid="Terminal.Gui.ListView.OnOpenSelectedItem">OnOpenSelectedItem()</h4>
  807. <div class="markdown level1 summary">
  808. Invokes the OnOpenSelectedItem event if it is defined.
  809. </div>
  810. <div class="markdown level1 conceptual"></div>
  811. <h5 class="decalaration">Declaration</h5>
  812. <div class="codewrapper">
  813. <pre><code class="lang-csharp hljs">public virtual bool OnOpenSelectedItem()</code></pre>
  814. </div>
  815. <h5 class="returns">Returns</h5>
  816. <table class="table table-bordered table-striped table-condensed">
  817. <thead>
  818. <tr>
  819. <th>Type</th>
  820. <th>Description</th>
  821. </tr>
  822. </thead>
  823. <tbody>
  824. <tr>
  825. <td><span class="xref">System.Boolean</span></td>
  826. <td></td>
  827. </tr>
  828. </tbody>
  829. </table>
  830. <a id="Terminal_Gui_ListView_OnSelectedChanged_" data-uid="Terminal.Gui.ListView.OnSelectedChanged*"></a>
  831. <h4 id="Terminal_Gui_ListView_OnSelectedChanged" data-uid="Terminal.Gui.ListView.OnSelectedChanged">OnSelectedChanged()</h4>
  832. <div class="markdown level1 summary">
  833. Invokes the SelectedChanged event if it is defined.
  834. </div>
  835. <div class="markdown level1 conceptual"></div>
  836. <h5 class="decalaration">Declaration</h5>
  837. <div class="codewrapper">
  838. <pre><code class="lang-csharp hljs">public virtual bool OnSelectedChanged()</code></pre>
  839. </div>
  840. <h5 class="returns">Returns</h5>
  841. <table class="table table-bordered table-striped table-condensed">
  842. <thead>
  843. <tr>
  844. <th>Type</th>
  845. <th>Description</th>
  846. </tr>
  847. </thead>
  848. <tbody>
  849. <tr>
  850. <td><span class="xref">System.Boolean</span></td>
  851. <td></td>
  852. </tr>
  853. </tbody>
  854. </table>
  855. <a id="Terminal_Gui_ListView_PositionCursor_" data-uid="Terminal.Gui.ListView.PositionCursor*"></a>
  856. <h4 id="Terminal_Gui_ListView_PositionCursor" data-uid="Terminal.Gui.ListView.PositionCursor">PositionCursor()</h4>
  857. <div class="markdown level1 summary"></div>
  858. <div class="markdown level1 conceptual"></div>
  859. <h5 class="decalaration">Declaration</h5>
  860. <div class="codewrapper">
  861. <pre><code class="lang-csharp hljs">public override void PositionCursor()</code></pre>
  862. </div>
  863. <h5 class="overrides">Overrides</h5>
  864. <div><a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_PositionCursor">View.PositionCursor()</a></div>
  865. <a id="Terminal_Gui_ListView_ProcessKey_" data-uid="Terminal.Gui.ListView.ProcessKey*"></a>
  866. <h4 id="Terminal_Gui_ListView_ProcessKey_Terminal_Gui_KeyEvent_" data-uid="Terminal.Gui.ListView.ProcessKey(Terminal.Gui.KeyEvent)">ProcessKey(KeyEvent)</h4>
  867. <div class="markdown level1 summary"></div>
  868. <div class="markdown level1 conceptual"></div>
  869. <h5 class="decalaration">Declaration</h5>
  870. <div class="codewrapper">
  871. <pre><code class="lang-csharp hljs">public override bool ProcessKey(KeyEvent kb)</code></pre>
  872. </div>
  873. <h5 class="parameters">Parameters</h5>
  874. <table class="table table-bordered table-striped table-condensed">
  875. <thead>
  876. <tr>
  877. <th>Type</th>
  878. <th>Name</th>
  879. <th>Description</th>
  880. </tr>
  881. </thead>
  882. <tbody>
  883. <tr>
  884. <td><a class="xref" href="Terminal.Gui.KeyEvent.html">KeyEvent</a></td>
  885. <td><span class="parametername">kb</span></td>
  886. <td></td>
  887. </tr>
  888. </tbody>
  889. </table>
  890. <h5 class="returns">Returns</h5>
  891. <table class="table table-bordered table-striped table-condensed">
  892. <thead>
  893. <tr>
  894. <th>Type</th>
  895. <th>Description</th>
  896. </tr>
  897. </thead>
  898. <tbody>
  899. <tr>
  900. <td><span class="xref">System.Boolean</span></td>
  901. <td></td>
  902. </tr>
  903. </tbody>
  904. </table>
  905. <h5 class="overrides">Overrides</h5>
  906. <div><a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ProcessKey_Terminal_Gui_KeyEvent_">View.ProcessKey(KeyEvent)</a></div>
  907. <a id="Terminal_Gui_ListView_Redraw_" data-uid="Terminal.Gui.ListView.Redraw*"></a>
  908. <h4 id="Terminal_Gui_ListView_Redraw_Terminal_Gui_Rect_" data-uid="Terminal.Gui.ListView.Redraw(Terminal.Gui.Rect)">Redraw(Rect)</h4>
  909. <div class="markdown level1 summary"></div>
  910. <div class="markdown level1 conceptual"></div>
  911. <h5 class="decalaration">Declaration</h5>
  912. <div class="codewrapper">
  913. <pre><code class="lang-csharp hljs">public override void Redraw(Rect region)</code></pre>
  914. </div>
  915. <h5 class="parameters">Parameters</h5>
  916. <table class="table table-bordered table-striped table-condensed">
  917. <thead>
  918. <tr>
  919. <th>Type</th>
  920. <th>Name</th>
  921. <th>Description</th>
  922. </tr>
  923. </thead>
  924. <tbody>
  925. <tr>
  926. <td><a class="xref" href="Terminal.Gui.Rect.html">Rect</a></td>
  927. <td><span class="parametername">region</span></td>
  928. <td></td>
  929. </tr>
  930. </tbody>
  931. </table>
  932. <h5 class="overrides">Overrides</h5>
  933. <div><a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Redraw_Terminal_Gui_Rect_">View.Redraw(Rect)</a></div>
  934. <a id="Terminal_Gui_ListView_SetSource_" data-uid="Terminal.Gui.ListView.SetSource*"></a>
  935. <h4 id="Terminal_Gui_ListView_SetSource_System_Collections_IList_" data-uid="Terminal.Gui.ListView.SetSource(System.Collections.IList)">SetSource(IList)</h4>
  936. <div class="markdown level1 summary">
  937. Sets the source of the <a class="xref" href="Terminal.Gui.ListView.html">ListView</a> to an <span class="xref">System.Collections.IList</span>.
  938. </div>
  939. <div class="markdown level1 conceptual"></div>
  940. <h5 class="decalaration">Declaration</h5>
  941. <div class="codewrapper">
  942. <pre><code class="lang-csharp hljs">public void SetSource(IList source)</code></pre>
  943. </div>
  944. <h5 class="parameters">Parameters</h5>
  945. <table class="table table-bordered table-striped table-condensed">
  946. <thead>
  947. <tr>
  948. <th>Type</th>
  949. <th>Name</th>
  950. <th>Description</th>
  951. </tr>
  952. </thead>
  953. <tbody>
  954. <tr>
  955. <td><span class="xref">System.Collections.IList</span></td>
  956. <td><span class="parametername">source</span></td>
  957. <td></td>
  958. </tr>
  959. </tbody>
  960. </table>
  961. <h5 id="Terminal_Gui_ListView_SetSource_System_Collections_IList__remarks">Remarks</h5>
  962. <div class="markdown level1 remarks">
  963. Use the <a class="xref" href="Terminal.Gui.ListView.html#Terminal_Gui_ListView_Source">Source</a> property to set a new <a class="xref" href="Terminal.Gui.IListDataSource.html">IListDataSource</a> source and use custome rendering.
  964. </div>
  965. <a id="Terminal_Gui_ListView_SetSourceAsync_" data-uid="Terminal.Gui.ListView.SetSourceAsync*"></a>
  966. <h4 id="Terminal_Gui_ListView_SetSourceAsync_System_Collections_IList_" data-uid="Terminal.Gui.ListView.SetSourceAsync(System.Collections.IList)">SetSourceAsync(IList)</h4>
  967. <div class="markdown level1 summary">
  968. Sets the source to an <span class="xref">System.Collections.IList</span> value asynchronously.
  969. </div>
  970. <div class="markdown level1 conceptual"></div>
  971. <h5 class="decalaration">Declaration</h5>
  972. <div class="codewrapper">
  973. <pre><code class="lang-csharp hljs">public Task SetSourceAsync(IList source)</code></pre>
  974. </div>
  975. <h5 class="parameters">Parameters</h5>
  976. <table class="table table-bordered table-striped table-condensed">
  977. <thead>
  978. <tr>
  979. <th>Type</th>
  980. <th>Name</th>
  981. <th>Description</th>
  982. </tr>
  983. </thead>
  984. <tbody>
  985. <tr>
  986. <td><span class="xref">System.Collections.IList</span></td>
  987. <td><span class="parametername">source</span></td>
  988. <td></td>
  989. </tr>
  990. </tbody>
  991. </table>
  992. <h5 class="returns">Returns</h5>
  993. <table class="table table-bordered table-striped table-condensed">
  994. <thead>
  995. <tr>
  996. <th>Type</th>
  997. <th>Description</th>
  998. </tr>
  999. </thead>
  1000. <tbody>
  1001. <tr>
  1002. <td><span class="xref">System.Threading.Tasks.Task</span></td>
  1003. <td>An item implementing the IList interface.</td>
  1004. </tr>
  1005. </tbody>
  1006. </table>
  1007. <h5 id="Terminal_Gui_ListView_SetSourceAsync_System_Collections_IList__remarks">Remarks</h5>
  1008. <div class="markdown level1 remarks">
  1009. Use the <a class="xref" href="Terminal.Gui.ListView.html#Terminal_Gui_ListView_Source">Source</a> property to set a new <a class="xref" href="Terminal.Gui.IListDataSource.html">IListDataSource</a> source and use custome rendering.
  1010. </div>
  1011. <h3 id="events">Events
  1012. </h3>
  1013. <h4 id="Terminal_Gui_ListView_OpenSelectedItem" data-uid="Terminal.Gui.ListView.OpenSelectedItem">OpenSelectedItem</h4>
  1014. <div class="markdown level1 summary">
  1015. This event is raised when the user Double Clicks on an item or presses ENTER to open the selected item.
  1016. </div>
  1017. <div class="markdown level1 conceptual"></div>
  1018. <h5 class="decalaration">Declaration</h5>
  1019. <div class="codewrapper">
  1020. <pre><code class="lang-csharp hljs">public event EventHandler&lt;ListViewItemEventArgs&gt; OpenSelectedItem</code></pre>
  1021. </div>
  1022. <h5 class="eventType">Event Type</h5>
  1023. <table class="table table-bordered table-striped table-condensed">
  1024. <thead>
  1025. <tr>
  1026. <th>Type</th>
  1027. <th>Description</th>
  1028. </tr>
  1029. </thead>
  1030. <tbody>
  1031. <tr>
  1032. <td><span class="xref">System.EventHandler</span>&lt;<a class="xref" href="Terminal.Gui.ListViewItemEventArgs.html">ListViewItemEventArgs</a>&gt;</td>
  1033. <td></td>
  1034. </tr>
  1035. </tbody>
  1036. </table>
  1037. <h4 id="Terminal_Gui_ListView_SelectedChanged" data-uid="Terminal.Gui.ListView.SelectedChanged">SelectedChanged</h4>
  1038. <div class="markdown level1 summary">
  1039. This event is raised when the selected item in the <a class="xref" href="Terminal.Gui.ListView.html">ListView</a> has changed.
  1040. </div>
  1041. <div class="markdown level1 conceptual"></div>
  1042. <h5 class="decalaration">Declaration</h5>
  1043. <div class="codewrapper">
  1044. <pre><code class="lang-csharp hljs">public event EventHandler&lt;ListViewItemEventArgs&gt; SelectedChanged</code></pre>
  1045. </div>
  1046. <h5 class="eventType">Event Type</h5>
  1047. <table class="table table-bordered table-striped table-condensed">
  1048. <thead>
  1049. <tr>
  1050. <th>Type</th>
  1051. <th>Description</th>
  1052. </tr>
  1053. </thead>
  1054. <tbody>
  1055. <tr>
  1056. <td><span class="xref">System.EventHandler</span>&lt;<a class="xref" href="Terminal.Gui.ListViewItemEventArgs.html">ListViewItemEventArgs</a>&gt;</td>
  1057. <td></td>
  1058. </tr>
  1059. </tbody>
  1060. </table>
  1061. <h3 id="implements">Implements</h3>
  1062. <div>
  1063. <span class="xref">System.Collections.IEnumerable</span>
  1064. </div>
  1065. </article>
  1066. </div>
  1067. <div class="hidden-sm col-md-2" role="complementary">
  1068. <div class="sideaffix">
  1069. <div class="contribution">
  1070. <ul class="nav">
  1071. </ul>
  1072. </div>
  1073. <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
  1074. <!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
  1075. </nav>
  1076. </div>
  1077. </div>
  1078. </div>
  1079. </div>
  1080. <footer>
  1081. <div class="grad-bottom"></div>
  1082. <div class="footer">
  1083. <div class="container">
  1084. <span class="pull-right">
  1085. <a href="#top">Back to top</a>
  1086. </span>
  1087. <span>Generated by <strong>DocFX</strong></span>
  1088. </div>
  1089. </div>
  1090. </footer>
  1091. </div>
  1092. <script type="text/javascript" src="../../styles/docfx.vendor.js"></script>
  1093. <script type="text/javascript" src="../../styles/docfx.js"></script>
  1094. <script type="text/javascript" src="../../styles/main.js"></script>
  1095. </body>
  1096. </html>