Terminal.Gui.ListView.html 47 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160
  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.53.1.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="">
  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_WantMousePositionReports">View.WantMousePositionReports</a>
  115. </div>
  116. <div>
  117. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_WantContinuousButtonPressed">View.WantContinuousButtonPressed</a>
  118. </div>
  119. <div>
  120. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Frame">View.Frame</a>
  121. </div>
  122. <div>
  123. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_GetEnumerator">View.GetEnumerator()</a>
  124. </div>
  125. <div>
  126. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_LayoutStyle">View.LayoutStyle</a>
  127. </div>
  128. <div>
  129. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Bounds">View.Bounds</a>
  130. </div>
  131. <div>
  132. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_X">View.X</a>
  133. </div>
  134. <div>
  135. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Y">View.Y</a>
  136. </div>
  137. <div>
  138. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Width">View.Width</a>
  139. </div>
  140. <div>
  141. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Height">View.Height</a>
  142. </div>
  143. <div>
  144. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SuperView">View.SuperView</a>
  145. </div>
  146. <div>
  147. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SetNeedsDisplay">View.SetNeedsDisplay()</a>
  148. </div>
  149. <div>
  150. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SetNeedsDisplay_Terminal_Gui_Rect_">View.SetNeedsDisplay(Rect)</a>
  151. </div>
  152. <div>
  153. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ChildNeedsDisplay">View.ChildNeedsDisplay()</a>
  154. </div>
  155. <div>
  156. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Add_Terminal_Gui_View_">View.Add(View)</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_RemoveAll">View.RemoveAll()</a>
  163. </div>
  164. <div>
  165. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Remove_Terminal_Gui_View_">View.Remove(View)</a>
  166. </div>
  167. <div>
  168. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_BringSubviewToFront_Terminal_Gui_View_">View.BringSubviewToFront(View)</a>
  169. </div>
  170. <div>
  171. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SendSubviewToBack_Terminal_Gui_View_">View.SendSubviewToBack(View)</a>
  172. </div>
  173. <div>
  174. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SendSubviewBackwards_Terminal_Gui_View_">View.SendSubviewBackwards(View)</a>
  175. </div>
  176. <div>
  177. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_BringSubviewForward_Terminal_Gui_View_">View.BringSubviewForward(View)</a>
  178. </div>
  179. <div>
  180. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Clear">View.Clear()</a>
  181. </div>
  182. <div>
  183. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Clear_Terminal_Gui_Rect_">View.Clear(Rect)</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_ClipToBounds">View.ClipToBounds()</a>
  190. </div>
  191. <div>
  192. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SetClip_Terminal_Gui_Rect_">View.SetClip(Rect)</a>
  193. </div>
  194. <div>
  195. <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>
  196. </div>
  197. <div>
  198. <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>
  199. </div>
  200. <div>
  201. <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>
  202. </div>
  203. <div>
  204. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Move_System_Int32_System_Int32_">View.Move(Int32, Int32)</a>
  205. </div>
  206. <div>
  207. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_HasFocus">View.HasFocus</a>
  208. </div>
  209. <div>
  210. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnEnter">View.OnEnter()</a>
  211. </div>
  212. <div>
  213. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnLeave">View.OnLeave()</a>
  214. </div>
  215. <div>
  216. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Focused">View.Focused</a>
  217. </div>
  218. <div>
  219. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_MostFocused">View.MostFocused</a>
  220. </div>
  221. <div>
  222. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ColorScheme">View.ColorScheme</a>
  223. </div>
  224. <div>
  225. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_AddRune_System_Int32_System_Int32_System_Rune_">View.AddRune(Int32, Int32, Rune)</a>
  226. </div>
  227. <div>
  228. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ClearNeedsDisplay">View.ClearNeedsDisplay()</a>
  229. </div>
  230. <div>
  231. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SetFocus_Terminal_Gui_View_">View.SetFocus(View)</a>
  232. </div>
  233. <div>
  234. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_KeyPress">View.KeyPress</a>
  235. </div>
  236. <div>
  237. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ProcessHotKey_Terminal_Gui_KeyEvent_">View.ProcessHotKey(KeyEvent)</a>
  238. </div>
  239. <div>
  240. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ProcessColdKey_Terminal_Gui_KeyEvent_">View.ProcessColdKey(KeyEvent)</a>
  241. </div>
  242. <div>
  243. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_KeyDown">View.KeyDown</a>
  244. </div>
  245. <div>
  246. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnKeyDown_Terminal_Gui_KeyEvent_">View.OnKeyDown(KeyEvent)</a>
  247. </div>
  248. <div>
  249. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_KeyUp">View.KeyUp</a>
  250. </div>
  251. <div>
  252. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnKeyUp_Terminal_Gui_KeyEvent_">View.OnKeyUp(KeyEvent)</a>
  253. </div>
  254. <div>
  255. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_EnsureFocus">View.EnsureFocus()</a>
  256. </div>
  257. <div>
  258. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_FocusFirst">View.FocusFirst()</a>
  259. </div>
  260. <div>
  261. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_FocusLast">View.FocusLast()</a>
  262. </div>
  263. <div>
  264. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_FocusPrev">View.FocusPrev()</a>
  265. </div>
  266. <div>
  267. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_FocusNext">View.FocusNext()</a>
  268. </div>
  269. <div>
  270. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_LayoutSubviews">View.LayoutSubviews()</a>
  271. </div>
  272. <div>
  273. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ToString">View.ToString()</a>
  274. </div>
  275. <div>
  276. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnMouseEnter_Terminal_Gui_MouseEvent_">View.OnMouseEnter(MouseEvent)</a>
  277. </div>
  278. <div>
  279. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnMouseLeave_Terminal_Gui_MouseEvent_">View.OnMouseLeave(MouseEvent)</a>
  280. </div>
  281. <div>
  282. <a class="xref" href="Terminal.Gui.Responder.html#Terminal_Gui_Responder_CanFocus">Responder.CanFocus</a>
  283. </div>
  284. <div>
  285. <span class="xref">System.Object.Equals(System.Object)</span>
  286. </div>
  287. <div>
  288. <span class="xref">System.Object.Equals(System.Object, System.Object)</span>
  289. </div>
  290. <div>
  291. <span class="xref">System.Object.GetHashCode()</span>
  292. </div>
  293. <div>
  294. <span class="xref">System.Object.GetType()</span>
  295. </div>
  296. <div>
  297. <span class="xref">System.Object.MemberwiseClone()</span>
  298. </div>
  299. <div>
  300. <span class="xref">System.Object.ReferenceEquals(System.Object, System.Object)</span>
  301. </div>
  302. </div>
  303. <h6><strong>Namespace</strong>: <a class="xref" href="Terminal.Gui.html">Terminal.Gui</a></h6>
  304. <h6><strong>Assembly</strong>: Terminal.Gui.dll</h6>
  305. <h5 id="Terminal_Gui_ListView_syntax">Syntax</h5>
  306. <div class="codewrapper">
  307. <pre><code class="lang-csharp hljs">public class ListView : View, IEnumerable</code></pre>
  308. </div>
  309. <h5 id="Terminal_Gui_ListView_remarks"><strong>Remarks</strong></h5>
  310. <div class="markdown level0 remarks">
  311. <p>
  312. The <a class="xref" href="Terminal.Gui.ListView.html">ListView</a> displays lists of data and allows the user to scroll through the data.
  313. Items in the can be activated firing an event (with the ENTER key or a mouse double-click).
  314. 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.
  315. </p>
  316. <p>
  317. 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
  318. <span class="xref">System.Collections.IList</span> object (e.g. arrays, <span class="xref">System.Collections.Generic.List&lt;T&gt;</span>,
  319. and other collections). Alternatively, an object that implements the <a class="xref" href="Terminal.Gui.IListDataSource.html">IListDataSource</a>
  320. interface can be provided giving full control of what is rendered.
  321. </p>
  322. <p>
  323. <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.
  324. <span class="xref">System.String</span> values are converted into <span class="xref">NStack.ustring</span> values before rendering, and other values are
  325. 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> .
  326. </p>
  327. <p>
  328. 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
  329. 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>
  330. an <span class="xref">System.Collections.IList</span> is being used.
  331. </p>
  332. <p>
  333. 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
  334. [x] or [ ] and bind the SPACE key to toggle the selection. To implement a different
  335. marking style set <a class="xref" href="Terminal.Gui.ListView.html#Terminal_Gui_ListView_AllowsMarking">AllowsMarking</a> to false and implement custom rendering.
  336. </p>
  337. </div>
  338. <h3 id="constructors">Constructors
  339. </h3>
  340. <a id="Terminal_Gui_ListView__ctor_" data-uid="Terminal.Gui.ListView.#ctor*"></a>
  341. <h4 id="Terminal_Gui_ListView__ctor" data-uid="Terminal.Gui.ListView.#ctor">ListView()</h4>
  342. <div class="markdown level1 summary">
  343. 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.
  344. </div>
  345. <div class="markdown level1 conceptual"></div>
  346. <h5 class="decalaration">Declaration</h5>
  347. <div class="codewrapper">
  348. <pre><code class="lang-csharp hljs">public ListView()</code></pre>
  349. </div>
  350. <a id="Terminal_Gui_ListView__ctor_" data-uid="Terminal.Gui.ListView.#ctor*"></a>
  351. <h4 id="Terminal_Gui_ListView__ctor_System_Collections_IList_" data-uid="Terminal.Gui.ListView.#ctor(System.Collections.IList)">ListView(IList)</h4>
  352. <div class="markdown level1 summary">
  353. 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,
  354. with relative positioning.
  355. </div>
  356. <div class="markdown level1 conceptual"></div>
  357. <h5 class="decalaration">Declaration</h5>
  358. <div class="codewrapper">
  359. <pre><code class="lang-csharp hljs">public ListView(IList source)</code></pre>
  360. </div>
  361. <h5 class="parameters">Parameters</h5>
  362. <table class="table table-bordered table-striped table-condensed">
  363. <thead>
  364. <tr>
  365. <th>Type</th>
  366. <th>Name</th>
  367. <th>Description</th>
  368. </tr>
  369. </thead>
  370. <tbody>
  371. <tr>
  372. <td><span class="xref">System.Collections.IList</span></td>
  373. <td><span class="parametername">source</span></td>
  374. <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>
  375. </tr>
  376. </tbody>
  377. </table>
  378. <a id="Terminal_Gui_ListView__ctor_" data-uid="Terminal.Gui.ListView.#ctor*"></a>
  379. <h4 id="Terminal_Gui_ListView__ctor_Terminal_Gui_IListDataSource_" data-uid="Terminal.Gui.ListView.#ctor(Terminal.Gui.IListDataSource)">ListView(IListDataSource)</h4>
  380. <div class="markdown level1 summary">
  381. 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.
  382. </div>
  383. <div class="markdown level1 conceptual"></div>
  384. <h5 class="decalaration">Declaration</h5>
  385. <div class="codewrapper">
  386. <pre><code class="lang-csharp hljs">public ListView(IListDataSource source)</code></pre>
  387. </div>
  388. <h5 class="parameters">Parameters</h5>
  389. <table class="table table-bordered table-striped table-condensed">
  390. <thead>
  391. <tr>
  392. <th>Type</th>
  393. <th>Name</th>
  394. <th>Description</th>
  395. </tr>
  396. </thead>
  397. <tbody>
  398. <tr>
  399. <td><a class="xref" href="Terminal.Gui.IListDataSource.html">IListDataSource</a></td>
  400. <td><span class="parametername">source</span></td>
  401. <td><a class="xref" href="Terminal.Gui.IListDataSource.html">IListDataSource</a> object that provides a mechanism to render the data.
  402. The number of elements on the collection should not change, if you must change, set
  403. the &quot;Source&quot; property to reset the internal settings of the ListView.</td>
  404. </tr>
  405. </tbody>
  406. </table>
  407. <a id="Terminal_Gui_ListView__ctor_" data-uid="Terminal.Gui.ListView.#ctor*"></a>
  408. <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>
  409. <div class="markdown level1 summary">
  410. 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.
  411. </div>
  412. <div class="markdown level1 conceptual"></div>
  413. <h5 class="decalaration">Declaration</h5>
  414. <div class="codewrapper">
  415. <pre><code class="lang-csharp hljs">public ListView(Rect rect, IList source)</code></pre>
  416. </div>
  417. <h5 class="parameters">Parameters</h5>
  418. <table class="table table-bordered table-striped table-condensed">
  419. <thead>
  420. <tr>
  421. <th>Type</th>
  422. <th>Name</th>
  423. <th>Description</th>
  424. </tr>
  425. </thead>
  426. <tbody>
  427. <tr>
  428. <td><a class="xref" href="Terminal.Gui.Rect.html">Rect</a></td>
  429. <td><span class="parametername">rect</span></td>
  430. <td>Frame for the listview.</td>
  431. </tr>
  432. <tr>
  433. <td><span class="xref">System.Collections.IList</span></td>
  434. <td><span class="parametername">source</span></td>
  435. <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>
  436. </tr>
  437. </tbody>
  438. </table>
  439. <a id="Terminal_Gui_ListView__ctor_" data-uid="Terminal.Gui.ListView.#ctor*"></a>
  440. <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>
  441. <div class="markdown level1 summary">
  442. Initializes a new instance of <a class="xref" href="Terminal.Gui.ListView.html">ListView</a> with the provided data source and an absolute position
  443. </div>
  444. <div class="markdown level1 conceptual"></div>
  445. <h5 class="decalaration">Declaration</h5>
  446. <div class="codewrapper">
  447. <pre><code class="lang-csharp hljs">public ListView(Rect rect, IListDataSource source)</code></pre>
  448. </div>
  449. <h5 class="parameters">Parameters</h5>
  450. <table class="table table-bordered table-striped table-condensed">
  451. <thead>
  452. <tr>
  453. <th>Type</th>
  454. <th>Name</th>
  455. <th>Description</th>
  456. </tr>
  457. </thead>
  458. <tbody>
  459. <tr>
  460. <td><a class="xref" href="Terminal.Gui.Rect.html">Rect</a></td>
  461. <td><span class="parametername">rect</span></td>
  462. <td>Frame for the listview.</td>
  463. </tr>
  464. <tr>
  465. <td><a class="xref" href="Terminal.Gui.IListDataSource.html">IListDataSource</a></td>
  466. <td><span class="parametername">source</span></td>
  467. <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>
  468. </tr>
  469. </tbody>
  470. </table>
  471. <h3 id="properties">Properties
  472. </h3>
  473. <a id="Terminal_Gui_ListView_AllowsMarking_" data-uid="Terminal.Gui.ListView.AllowsMarking*"></a>
  474. <h4 id="Terminal_Gui_ListView_AllowsMarking" data-uid="Terminal.Gui.ListView.AllowsMarking">AllowsMarking</h4>
  475. <div class="markdown level1 summary">
  476. Gets or sets whether this <a class="xref" href="Terminal.Gui.ListView.html">ListView</a> allows items to be marked.
  477. </div>
  478. <div class="markdown level1 conceptual"></div>
  479. <h5 class="decalaration">Declaration</h5>
  480. <div class="codewrapper">
  481. <pre><code class="lang-csharp hljs">public bool AllowsMarking { get; set; }</code></pre>
  482. </div>
  483. <h5 class="propertyValue">Property Value</h5>
  484. <table class="table table-bordered table-striped table-condensed">
  485. <thead>
  486. <tr>
  487. <th>Type</th>
  488. <th>Description</th>
  489. </tr>
  490. </thead>
  491. <tbody>
  492. <tr>
  493. <td><span class="xref">System.Boolean</span></td>
  494. <td><code>true</code> if allows marking elements of the list; otherwise, <code>false</code>.
  495. </td>
  496. </tr>
  497. </tbody>
  498. </table>
  499. <h5 id="Terminal_Gui_ListView_AllowsMarking_remarks">Remarks</h5>
  500. <div class="markdown level1 remarks">
  501. 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;
  502. spaces. SPACE key will toggle marking.
  503. </div>
  504. <a id="Terminal_Gui_ListView_AllowsMultipleSelection_" data-uid="Terminal.Gui.ListView.AllowsMultipleSelection*"></a>
  505. <h4 id="Terminal_Gui_ListView_AllowsMultipleSelection" data-uid="Terminal.Gui.ListView.AllowsMultipleSelection">AllowsMultipleSelection</h4>
  506. <div class="markdown level1 summary">
  507. If set to true allows more than one item to be selected. If false only allow one item selected.
  508. </div>
  509. <div class="markdown level1 conceptual"></div>
  510. <h5 class="decalaration">Declaration</h5>
  511. <div class="codewrapper">
  512. <pre><code class="lang-csharp hljs">public bool AllowsMultipleSelection { get; set; }</code></pre>
  513. </div>
  514. <h5 class="propertyValue">Property Value</h5>
  515. <table class="table table-bordered table-striped table-condensed">
  516. <thead>
  517. <tr>
  518. <th>Type</th>
  519. <th>Description</th>
  520. </tr>
  521. </thead>
  522. <tbody>
  523. <tr>
  524. <td><span class="xref">System.Boolean</span></td>
  525. <td></td>
  526. </tr>
  527. </tbody>
  528. </table>
  529. <a id="Terminal_Gui_ListView_SelectedItem_" data-uid="Terminal.Gui.ListView.SelectedItem*"></a>
  530. <h4 id="Terminal_Gui_ListView_SelectedItem" data-uid="Terminal.Gui.ListView.SelectedItem">SelectedItem</h4>
  531. <div class="markdown level1 summary">
  532. Gets or sets the index of the currently selected item.
  533. </div>
  534. <div class="markdown level1 conceptual"></div>
  535. <h5 class="decalaration">Declaration</h5>
  536. <div class="codewrapper">
  537. <pre><code class="lang-csharp hljs">public int SelectedItem { get; set; }</code></pre>
  538. </div>
  539. <h5 class="propertyValue">Property Value</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.Int32</span></td>
  550. <td>The selected item.</td>
  551. </tr>
  552. </tbody>
  553. </table>
  554. <a id="Terminal_Gui_ListView_Source_" data-uid="Terminal.Gui.ListView.Source*"></a>
  555. <h4 id="Terminal_Gui_ListView_Source" data-uid="Terminal.Gui.ListView.Source">Source</h4>
  556. <div class="markdown level1 summary">
  557. 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.
  558. </div>
  559. <div class="markdown level1 conceptual"></div>
  560. <h5 class="decalaration">Declaration</h5>
  561. <div class="codewrapper">
  562. <pre><code class="lang-csharp hljs">public IListDataSource Source { get; set; }</code></pre>
  563. </div>
  564. <h5 class="propertyValue">Property Value</h5>
  565. <table class="table table-bordered table-striped table-condensed">
  566. <thead>
  567. <tr>
  568. <th>Type</th>
  569. <th>Description</th>
  570. </tr>
  571. </thead>
  572. <tbody>
  573. <tr>
  574. <td><a class="xref" href="Terminal.Gui.IListDataSource.html">IListDataSource</a></td>
  575. <td>The source.</td>
  576. </tr>
  577. </tbody>
  578. </table>
  579. <h5 id="Terminal_Gui_ListView_Source_remarks">Remarks</h5>
  580. <div class="markdown level1 remarks">
  581. 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.
  582. </div>
  583. <a id="Terminal_Gui_ListView_TopItem_" data-uid="Terminal.Gui.ListView.TopItem*"></a>
  584. <h4 id="Terminal_Gui_ListView_TopItem" data-uid="Terminal.Gui.ListView.TopItem">TopItem</h4>
  585. <div class="markdown level1 summary">
  586. Gets or sets the item that is displayed at the top of the <a class="xref" href="Terminal.Gui.ListView.html">ListView</a>.
  587. </div>
  588. <div class="markdown level1 conceptual"></div>
  589. <h5 class="decalaration">Declaration</h5>
  590. <div class="codewrapper">
  591. <pre><code class="lang-csharp hljs">public int TopItem { get; set; }</code></pre>
  592. </div>
  593. <h5 class="propertyValue">Property Value</h5>
  594. <table class="table table-bordered table-striped table-condensed">
  595. <thead>
  596. <tr>
  597. <th>Type</th>
  598. <th>Description</th>
  599. </tr>
  600. </thead>
  601. <tbody>
  602. <tr>
  603. <td><span class="xref">System.Int32</span></td>
  604. <td>The top item.</td>
  605. </tr>
  606. </tbody>
  607. </table>
  608. <h3 id="methods">Methods
  609. </h3>
  610. <a id="Terminal_Gui_ListView_AllowsAll_" data-uid="Terminal.Gui.ListView.AllowsAll*"></a>
  611. <h4 id="Terminal_Gui_ListView_AllowsAll" data-uid="Terminal.Gui.ListView.AllowsAll">AllowsAll()</h4>
  612. <div class="markdown level1 summary">
  613. Prevents marking if it&apos;s not allowed mark and if it&apos;s not allows multiple selection.
  614. </div>
  615. <div class="markdown level1 conceptual"></div>
  616. <h5 class="decalaration">Declaration</h5>
  617. <div class="codewrapper">
  618. <pre><code class="lang-csharp hljs">public virtual bool AllowsAll()</code></pre>
  619. </div>
  620. <h5 class="returns">Returns</h5>
  621. <table class="table table-bordered table-striped table-condensed">
  622. <thead>
  623. <tr>
  624. <th>Type</th>
  625. <th>Description</th>
  626. </tr>
  627. </thead>
  628. <tbody>
  629. <tr>
  630. <td><span class="xref">System.Boolean</span></td>
  631. <td></td>
  632. </tr>
  633. </tbody>
  634. </table>
  635. <a id="Terminal_Gui_ListView_MarkUnmarkRow_" data-uid="Terminal.Gui.ListView.MarkUnmarkRow*"></a>
  636. <h4 id="Terminal_Gui_ListView_MarkUnmarkRow" data-uid="Terminal.Gui.ListView.MarkUnmarkRow">MarkUnmarkRow()</h4>
  637. <div class="markdown level1 summary">
  638. Marks an unmarked row.
  639. </div>
  640. <div class="markdown level1 conceptual"></div>
  641. <h5 class="decalaration">Declaration</h5>
  642. <div class="codewrapper">
  643. <pre><code class="lang-csharp hljs">public virtual bool MarkUnmarkRow()</code></pre>
  644. </div>
  645. <h5 class="returns">Returns</h5>
  646. <table class="table table-bordered table-striped table-condensed">
  647. <thead>
  648. <tr>
  649. <th>Type</th>
  650. <th>Description</th>
  651. </tr>
  652. </thead>
  653. <tbody>
  654. <tr>
  655. <td><span class="xref">System.Boolean</span></td>
  656. <td></td>
  657. </tr>
  658. </tbody>
  659. </table>
  660. <a id="Terminal_Gui_ListView_MouseEvent_" data-uid="Terminal.Gui.ListView.MouseEvent*"></a>
  661. <h4 id="Terminal_Gui_ListView_MouseEvent_Terminal_Gui_MouseEvent_" data-uid="Terminal.Gui.ListView.MouseEvent(Terminal.Gui.MouseEvent)">MouseEvent(MouseEvent)</h4>
  662. <div class="markdown level1 summary"></div>
  663. <div class="markdown level1 conceptual"></div>
  664. <h5 class="decalaration">Declaration</h5>
  665. <div class="codewrapper">
  666. <pre><code class="lang-csharp hljs">public override bool MouseEvent(MouseEvent me)</code></pre>
  667. </div>
  668. <h5 class="parameters">Parameters</h5>
  669. <table class="table table-bordered table-striped table-condensed">
  670. <thead>
  671. <tr>
  672. <th>Type</th>
  673. <th>Name</th>
  674. <th>Description</th>
  675. </tr>
  676. </thead>
  677. <tbody>
  678. <tr>
  679. <td><a class="xref" href="Terminal.Gui.MouseEvent.html">MouseEvent</a></td>
  680. <td><span class="parametername">me</span></td>
  681. <td></td>
  682. </tr>
  683. </tbody>
  684. </table>
  685. <h5 class="returns">Returns</h5>
  686. <table class="table table-bordered table-striped table-condensed">
  687. <thead>
  688. <tr>
  689. <th>Type</th>
  690. <th>Description</th>
  691. </tr>
  692. </thead>
  693. <tbody>
  694. <tr>
  695. <td><span class="xref">System.Boolean</span></td>
  696. <td></td>
  697. </tr>
  698. </tbody>
  699. </table>
  700. <h5 class="overrides">Overrides</h5>
  701. <div><a class="xref" href="Terminal.Gui.Responder.html#Terminal_Gui_Responder_MouseEvent_Terminal_Gui_MouseEvent_">Responder.MouseEvent(MouseEvent)</a></div>
  702. <a id="Terminal_Gui_ListView_MoveDown_" data-uid="Terminal.Gui.ListView.MoveDown*"></a>
  703. <h4 id="Terminal_Gui_ListView_MoveDown" data-uid="Terminal.Gui.ListView.MoveDown">MoveDown()</h4>
  704. <div class="markdown level1 summary">
  705. Moves the selected item index to the next row.
  706. </div>
  707. <div class="markdown level1 conceptual"></div>
  708. <h5 class="decalaration">Declaration</h5>
  709. <div class="codewrapper">
  710. <pre><code class="lang-csharp hljs">public virtual bool MoveDown()</code></pre>
  711. </div>
  712. <h5 class="returns">Returns</h5>
  713. <table class="table table-bordered table-striped table-condensed">
  714. <thead>
  715. <tr>
  716. <th>Type</th>
  717. <th>Description</th>
  718. </tr>
  719. </thead>
  720. <tbody>
  721. <tr>
  722. <td><span class="xref">System.Boolean</span></td>
  723. <td></td>
  724. </tr>
  725. </tbody>
  726. </table>
  727. <a id="Terminal_Gui_ListView_MovePageDown_" data-uid="Terminal.Gui.ListView.MovePageDown*"></a>
  728. <h4 id="Terminal_Gui_ListView_MovePageDown" data-uid="Terminal.Gui.ListView.MovePageDown">MovePageDown()</h4>
  729. <div class="markdown level1 summary">
  730. Moves the selected item index to the previous page.
  731. </div>
  732. <div class="markdown level1 conceptual"></div>
  733. <h5 class="decalaration">Declaration</h5>
  734. <div class="codewrapper">
  735. <pre><code class="lang-csharp hljs">public virtual bool MovePageDown()</code></pre>
  736. </div>
  737. <h5 class="returns">Returns</h5>
  738. <table class="table table-bordered table-striped table-condensed">
  739. <thead>
  740. <tr>
  741. <th>Type</th>
  742. <th>Description</th>
  743. </tr>
  744. </thead>
  745. <tbody>
  746. <tr>
  747. <td><span class="xref">System.Boolean</span></td>
  748. <td></td>
  749. </tr>
  750. </tbody>
  751. </table>
  752. <a id="Terminal_Gui_ListView_MovePageUp_" data-uid="Terminal.Gui.ListView.MovePageUp*"></a>
  753. <h4 id="Terminal_Gui_ListView_MovePageUp" data-uid="Terminal.Gui.ListView.MovePageUp">MovePageUp()</h4>
  754. <div class="markdown level1 summary">
  755. Moves the selected item index to the next page.
  756. </div>
  757. <div class="markdown level1 conceptual"></div>
  758. <h5 class="decalaration">Declaration</h5>
  759. <div class="codewrapper">
  760. <pre><code class="lang-csharp hljs">public virtual bool MovePageUp()</code></pre>
  761. </div>
  762. <h5 class="returns">Returns</h5>
  763. <table class="table table-bordered table-striped table-condensed">
  764. <thead>
  765. <tr>
  766. <th>Type</th>
  767. <th>Description</th>
  768. </tr>
  769. </thead>
  770. <tbody>
  771. <tr>
  772. <td><span class="xref">System.Boolean</span></td>
  773. <td></td>
  774. </tr>
  775. </tbody>
  776. </table>
  777. <a id="Terminal_Gui_ListView_MoveUp_" data-uid="Terminal.Gui.ListView.MoveUp*"></a>
  778. <h4 id="Terminal_Gui_ListView_MoveUp" data-uid="Terminal.Gui.ListView.MoveUp">MoveUp()</h4>
  779. <div class="markdown level1 summary">
  780. Moves the selected item index to the previous row.
  781. </div>
  782. <div class="markdown level1 conceptual"></div>
  783. <h5 class="decalaration">Declaration</h5>
  784. <div class="codewrapper">
  785. <pre><code class="lang-csharp hljs">public virtual bool MoveUp()</code></pre>
  786. </div>
  787. <h5 class="returns">Returns</h5>
  788. <table class="table table-bordered table-striped table-condensed">
  789. <thead>
  790. <tr>
  791. <th>Type</th>
  792. <th>Description</th>
  793. </tr>
  794. </thead>
  795. <tbody>
  796. <tr>
  797. <td><span class="xref">System.Boolean</span></td>
  798. <td></td>
  799. </tr>
  800. </tbody>
  801. </table>
  802. <a id="Terminal_Gui_ListView_OnOpenSelectedItem_" data-uid="Terminal.Gui.ListView.OnOpenSelectedItem*"></a>
  803. <h4 id="Terminal_Gui_ListView_OnOpenSelectedItem" data-uid="Terminal.Gui.ListView.OnOpenSelectedItem">OnOpenSelectedItem()</h4>
  804. <div class="markdown level1 summary">
  805. Invokes the OnOpenSelectedItem event if it is defined.
  806. </div>
  807. <div class="markdown level1 conceptual"></div>
  808. <h5 class="decalaration">Declaration</h5>
  809. <div class="codewrapper">
  810. <pre><code class="lang-csharp hljs">public virtual bool OnOpenSelectedItem()</code></pre>
  811. </div>
  812. <h5 class="returns">Returns</h5>
  813. <table class="table table-bordered table-striped table-condensed">
  814. <thead>
  815. <tr>
  816. <th>Type</th>
  817. <th>Description</th>
  818. </tr>
  819. </thead>
  820. <tbody>
  821. <tr>
  822. <td><span class="xref">System.Boolean</span></td>
  823. <td></td>
  824. </tr>
  825. </tbody>
  826. </table>
  827. <a id="Terminal_Gui_ListView_OnSelectedChanged_" data-uid="Terminal.Gui.ListView.OnSelectedChanged*"></a>
  828. <h4 id="Terminal_Gui_ListView_OnSelectedChanged" data-uid="Terminal.Gui.ListView.OnSelectedChanged">OnSelectedChanged()</h4>
  829. <div class="markdown level1 summary">
  830. Invokes the SelectedChanged event if it is defined.
  831. </div>
  832. <div class="markdown level1 conceptual"></div>
  833. <h5 class="decalaration">Declaration</h5>
  834. <div class="codewrapper">
  835. <pre><code class="lang-csharp hljs">public virtual bool OnSelectedChanged()</code></pre>
  836. </div>
  837. <h5 class="returns">Returns</h5>
  838. <table class="table table-bordered table-striped table-condensed">
  839. <thead>
  840. <tr>
  841. <th>Type</th>
  842. <th>Description</th>
  843. </tr>
  844. </thead>
  845. <tbody>
  846. <tr>
  847. <td><span class="xref">System.Boolean</span></td>
  848. <td></td>
  849. </tr>
  850. </tbody>
  851. </table>
  852. <a id="Terminal_Gui_ListView_PositionCursor_" data-uid="Terminal.Gui.ListView.PositionCursor*"></a>
  853. <h4 id="Terminal_Gui_ListView_PositionCursor" data-uid="Terminal.Gui.ListView.PositionCursor">PositionCursor()</h4>
  854. <div class="markdown level1 summary"></div>
  855. <div class="markdown level1 conceptual"></div>
  856. <h5 class="decalaration">Declaration</h5>
  857. <div class="codewrapper">
  858. <pre><code class="lang-csharp hljs">public override void PositionCursor()</code></pre>
  859. </div>
  860. <h5 class="overrides">Overrides</h5>
  861. <div><a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_PositionCursor">View.PositionCursor()</a></div>
  862. <a id="Terminal_Gui_ListView_ProcessKey_" data-uid="Terminal.Gui.ListView.ProcessKey*"></a>
  863. <h4 id="Terminal_Gui_ListView_ProcessKey_Terminal_Gui_KeyEvent_" data-uid="Terminal.Gui.ListView.ProcessKey(Terminal.Gui.KeyEvent)">ProcessKey(KeyEvent)</h4>
  864. <div class="markdown level1 summary"></div>
  865. <div class="markdown level1 conceptual"></div>
  866. <h5 class="decalaration">Declaration</h5>
  867. <div class="codewrapper">
  868. <pre><code class="lang-csharp hljs">public override bool ProcessKey(KeyEvent kb)</code></pre>
  869. </div>
  870. <h5 class="parameters">Parameters</h5>
  871. <table class="table table-bordered table-striped table-condensed">
  872. <thead>
  873. <tr>
  874. <th>Type</th>
  875. <th>Name</th>
  876. <th>Description</th>
  877. </tr>
  878. </thead>
  879. <tbody>
  880. <tr>
  881. <td><a class="xref" href="Terminal.Gui.KeyEvent.html">KeyEvent</a></td>
  882. <td><span class="parametername">kb</span></td>
  883. <td></td>
  884. </tr>
  885. </tbody>
  886. </table>
  887. <h5 class="returns">Returns</h5>
  888. <table class="table table-bordered table-striped table-condensed">
  889. <thead>
  890. <tr>
  891. <th>Type</th>
  892. <th>Description</th>
  893. </tr>
  894. </thead>
  895. <tbody>
  896. <tr>
  897. <td><span class="xref">System.Boolean</span></td>
  898. <td></td>
  899. </tr>
  900. </tbody>
  901. </table>
  902. <h5 class="overrides">Overrides</h5>
  903. <div><a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ProcessKey_Terminal_Gui_KeyEvent_">View.ProcessKey(KeyEvent)</a></div>
  904. <a id="Terminal_Gui_ListView_Redraw_" data-uid="Terminal.Gui.ListView.Redraw*"></a>
  905. <h4 id="Terminal_Gui_ListView_Redraw_Terminal_Gui_Rect_" data-uid="Terminal.Gui.ListView.Redraw(Terminal.Gui.Rect)">Redraw(Rect)</h4>
  906. <div class="markdown level1 summary"></div>
  907. <div class="markdown level1 conceptual"></div>
  908. <h5 class="decalaration">Declaration</h5>
  909. <div class="codewrapper">
  910. <pre><code class="lang-csharp hljs">public override void Redraw(Rect region)</code></pre>
  911. </div>
  912. <h5 class="parameters">Parameters</h5>
  913. <table class="table table-bordered table-striped table-condensed">
  914. <thead>
  915. <tr>
  916. <th>Type</th>
  917. <th>Name</th>
  918. <th>Description</th>
  919. </tr>
  920. </thead>
  921. <tbody>
  922. <tr>
  923. <td><a class="xref" href="Terminal.Gui.Rect.html">Rect</a></td>
  924. <td><span class="parametername">region</span></td>
  925. <td></td>
  926. </tr>
  927. </tbody>
  928. </table>
  929. <h5 class="overrides">Overrides</h5>
  930. <div><a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Redraw_Terminal_Gui_Rect_">View.Redraw(Rect)</a></div>
  931. <a id="Terminal_Gui_ListView_SetSource_" data-uid="Terminal.Gui.ListView.SetSource*"></a>
  932. <h4 id="Terminal_Gui_ListView_SetSource_System_Collections_IList_" data-uid="Terminal.Gui.ListView.SetSource(System.Collections.IList)">SetSource(IList)</h4>
  933. <div class="markdown level1 summary">
  934. Sets the source of the <a class="xref" href="Terminal.Gui.ListView.html">ListView</a> to an <span class="xref">System.Collections.IList</span>.
  935. </div>
  936. <div class="markdown level1 conceptual"></div>
  937. <h5 class="decalaration">Declaration</h5>
  938. <div class="codewrapper">
  939. <pre><code class="lang-csharp hljs">public void SetSource(IList source)</code></pre>
  940. </div>
  941. <h5 class="parameters">Parameters</h5>
  942. <table class="table table-bordered table-striped table-condensed">
  943. <thead>
  944. <tr>
  945. <th>Type</th>
  946. <th>Name</th>
  947. <th>Description</th>
  948. </tr>
  949. </thead>
  950. <tbody>
  951. <tr>
  952. <td><span class="xref">System.Collections.IList</span></td>
  953. <td><span class="parametername">source</span></td>
  954. <td></td>
  955. </tr>
  956. </tbody>
  957. </table>
  958. <h5 id="Terminal_Gui_ListView_SetSource_System_Collections_IList__remarks">Remarks</h5>
  959. <div class="markdown level1 remarks">
  960. 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.
  961. </div>
  962. <a id="Terminal_Gui_ListView_SetSourceAsync_" data-uid="Terminal.Gui.ListView.SetSourceAsync*"></a>
  963. <h4 id="Terminal_Gui_ListView_SetSourceAsync_System_Collections_IList_" data-uid="Terminal.Gui.ListView.SetSourceAsync(System.Collections.IList)">SetSourceAsync(IList)</h4>
  964. <div class="markdown level1 summary">
  965. Sets the source to an <span class="xref">System.Collections.IList</span> value asynchronously.
  966. </div>
  967. <div class="markdown level1 conceptual"></div>
  968. <h5 class="decalaration">Declaration</h5>
  969. <div class="codewrapper">
  970. <pre><code class="lang-csharp hljs">public Task SetSourceAsync(IList source)</code></pre>
  971. </div>
  972. <h5 class="parameters">Parameters</h5>
  973. <table class="table table-bordered table-striped table-condensed">
  974. <thead>
  975. <tr>
  976. <th>Type</th>
  977. <th>Name</th>
  978. <th>Description</th>
  979. </tr>
  980. </thead>
  981. <tbody>
  982. <tr>
  983. <td><span class="xref">System.Collections.IList</span></td>
  984. <td><span class="parametername">source</span></td>
  985. <td></td>
  986. </tr>
  987. </tbody>
  988. </table>
  989. <h5 class="returns">Returns</h5>
  990. <table class="table table-bordered table-striped table-condensed">
  991. <thead>
  992. <tr>
  993. <th>Type</th>
  994. <th>Description</th>
  995. </tr>
  996. </thead>
  997. <tbody>
  998. <tr>
  999. <td><span class="xref">System.Threading.Tasks.Task</span></td>
  1000. <td>An item implementing the IList interface.</td>
  1001. </tr>
  1002. </tbody>
  1003. </table>
  1004. <h5 id="Terminal_Gui_ListView_SetSourceAsync_System_Collections_IList__remarks">Remarks</h5>
  1005. <div class="markdown level1 remarks">
  1006. 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.
  1007. </div>
  1008. <h3 id="events">Events
  1009. </h3>
  1010. <h4 id="Terminal_Gui_ListView_OpenSelectedItem" data-uid="Terminal.Gui.ListView.OpenSelectedItem">OpenSelectedItem</h4>
  1011. <div class="markdown level1 summary">
  1012. This event is raised when the user Double Clicks on an item or presses ENTER to open the selected item.
  1013. </div>
  1014. <div class="markdown level1 conceptual"></div>
  1015. <h5 class="decalaration">Declaration</h5>
  1016. <div class="codewrapper">
  1017. <pre><code class="lang-csharp hljs">public event EventHandler&lt;ListViewItemEventArgs&gt; OpenSelectedItem</code></pre>
  1018. </div>
  1019. <h5 class="eventType">Event Type</h5>
  1020. <table class="table table-bordered table-striped table-condensed">
  1021. <thead>
  1022. <tr>
  1023. <th>Type</th>
  1024. <th>Description</th>
  1025. </tr>
  1026. </thead>
  1027. <tbody>
  1028. <tr>
  1029. <td><span class="xref">System.EventHandler</span>&lt;<a class="xref" href="Terminal.Gui.ListViewItemEventArgs.html">ListViewItemEventArgs</a>&gt;</td>
  1030. <td></td>
  1031. </tr>
  1032. </tbody>
  1033. </table>
  1034. <h4 id="Terminal_Gui_ListView_SelectedChanged" data-uid="Terminal.Gui.ListView.SelectedChanged">SelectedChanged</h4>
  1035. <div class="markdown level1 summary">
  1036. This event is raised when the selected item in the <a class="xref" href="Terminal.Gui.ListView.html">ListView</a> has changed.
  1037. </div>
  1038. <div class="markdown level1 conceptual"></div>
  1039. <h5 class="decalaration">Declaration</h5>
  1040. <div class="codewrapper">
  1041. <pre><code class="lang-csharp hljs">public event EventHandler&lt;ListViewItemEventArgs&gt; SelectedChanged</code></pre>
  1042. </div>
  1043. <h5 class="eventType">Event Type</h5>
  1044. <table class="table table-bordered table-striped table-condensed">
  1045. <thead>
  1046. <tr>
  1047. <th>Type</th>
  1048. <th>Description</th>
  1049. </tr>
  1050. </thead>
  1051. <tbody>
  1052. <tr>
  1053. <td><span class="xref">System.EventHandler</span>&lt;<a class="xref" href="Terminal.Gui.ListViewItemEventArgs.html">ListViewItemEventArgs</a>&gt;</td>
  1054. <td></td>
  1055. </tr>
  1056. </tbody>
  1057. </table>
  1058. <h3 id="implements">Implements</h3>
  1059. <div>
  1060. <span class="xref">System.Collections.IEnumerable</span>
  1061. </div>
  1062. </article>
  1063. </div>
  1064. <div class="hidden-sm col-md-2" role="complementary">
  1065. <div class="sideaffix">
  1066. <div class="contribution">
  1067. <ul class="nav">
  1068. </ul>
  1069. </div>
  1070. <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
  1071. <!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
  1072. </nav>
  1073. </div>
  1074. </div>
  1075. </div>
  1076. </div>
  1077. <footer>
  1078. <div class="grad-bottom"></div>
  1079. <div class="footer">
  1080. <div class="container">
  1081. <span class="pull-right">
  1082. <a href="#top">Back to top</a>
  1083. </span>
  1084. <span>Generated by <strong>DocFX</strong></span>
  1085. </div>
  1086. </div>
  1087. </footer>
  1088. </div>
  1089. <script type="text/javascript" src="../../styles/docfx.vendor.js"></script>
  1090. <script type="text/javascript" src="../../styles/docfx.js"></script>
  1091. <script type="text/javascript" src="../../styles/main.js"></script>
  1092. </body>
  1093. </html>