Terminal.Gui.ListView.html 29 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715
  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.18.2.0">
  13. <link rel="shortcut icon" href="../../favicon.ico">
  14. <link rel="stylesheet" href="../../styles/docfx.vendor.css">
  15. <link rel="stylesheet" href="../../styles/docfx.css">
  16. <link rel="stylesheet" href="../../styles/main.css">
  17. <meta property="docfx:navrel" content="">
  18. <meta property="docfx:tocrel" content="../toc.html">
  19. </head>
  20. <body data-spy="scroll" data-target="#affix">
  21. <div id="wrapper">
  22. <header>
  23. <nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation">
  24. <div class="container">
  25. <div class="navbar-header">
  26. <button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
  27. <span class="sr-only">Toggle navigation</span>
  28. <span class="icon-bar"></span>
  29. <span class="icon-bar"></span>
  30. <span class="icon-bar"></span>
  31. </button>
  32. <a class="navbar-brand" href="../../index.html">
  33. <img id="logo" class="svg" src="../../logo.svg" alt="">
  34. </a>
  35. </div>
  36. <div class="collapse navbar-collapse" id="navbar">
  37. <form class="navbar-form navbar-right" role="search" id="search">
  38. <div class="form-group">
  39. <input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">
  40. </div>
  41. </form>
  42. </div>
  43. </div>
  44. </nav>
  45. <div class="subnav navbar navbar-default">
  46. <div class="container hide-when-search" id="breadcrumb">
  47. <ul class="breadcrumb">
  48. <li></li>
  49. </ul>
  50. </div>
  51. </div>
  52. </header>
  53. <div role="main" class="container body-content hide-when-search">
  54. <div class="sidenav hide-when-search">
  55. <a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
  56. <div class="sidetoggle collapse" id="sidetoggle">
  57. <div id="sidetoc"></div>
  58. </div>
  59. </div>
  60. <div class="article row grid-right">
  61. <div class="col-md-10">
  62. <article class="content wrap" id="_content" data-uid="Terminal.Gui.ListView">
  63. <h1 id="Terminal_Gui_ListView" data-uid="Terminal.Gui.ListView">Class ListView
  64. </h1>
  65. <div class="markdown level0 summary"><p>ListView widget renders a list of data.</p>
  66. </div>
  67. <div class="markdown level0 conceptual"></div>
  68. <div class="inheritance">
  69. <h5>Inheritance</h5>
  70. <div class="level0"><span class="xref">System.Object</span></div>
  71. <div class="level1"><a class="xref" href="Terminal.Gui.Responder.html">Responder</a></div>
  72. <div class="level2"><a class="xref" href="Terminal.Gui.View.html">View</a></div>
  73. <div class="level3"><span class="xref">ListView</span></div>
  74. </div>
  75. <div class="inheritedMembers">
  76. <h5>Inherited Members</h5>
  77. <div>
  78. <a class="xref" href="Terminal.Gui.Responder.html#Terminal_Gui_Responder_CanFocus">Responder.CanFocus</a>
  79. </div>
  80. <div>
  81. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Add_Terminal_Gui_View_">View.Add(View)</a>
  82. </div>
  83. <div>
  84. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Add_Terminal_Gui_View___">View.Add(View[])</a>
  85. </div>
  86. <div>
  87. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_AddRune_System_Int32_System_Int32_System_Rune_">View.AddRune(Int32, Int32, Rune)</a>
  88. </div>
  89. <div>
  90. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Bounds">View.Bounds</a>
  91. </div>
  92. <div>
  93. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ChildNeedsDisplay">View.ChildNeedsDisplay()</a>
  94. </div>
  95. <div>
  96. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Clear">View.Clear()</a>
  97. </div>
  98. <div>
  99. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Clear_Terminal_Gui_Rect_">View.Clear(Rect)</a>
  100. </div>
  101. <div>
  102. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ClearNeedsDisplay">View.ClearNeedsDisplay()</a>
  103. </div>
  104. <div>
  105. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ClipToBounds">View.ClipToBounds()</a>
  106. </div>
  107. <div>
  108. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ColorScheme">View.ColorScheme</a>
  109. </div>
  110. <div>
  111. <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>
  112. </div>
  113. <div>
  114. <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>
  115. </div>
  116. <div>
  117. <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>
  118. </div>
  119. <div>
  120. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Driver">View.Driver</a>
  121. </div>
  122. <div>
  123. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_EnsureFocus">View.EnsureFocus()</a>
  124. </div>
  125. <div>
  126. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Focused">View.Focused</a>
  127. </div>
  128. <div>
  129. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_FocusFirst">View.FocusFirst()</a>
  130. </div>
  131. <div>
  132. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_FocusLast">View.FocusLast()</a>
  133. </div>
  134. <div>
  135. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_FocusNext">View.FocusNext()</a>
  136. </div>
  137. <div>
  138. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_FocusPrev">View.FocusPrev()</a>
  139. </div>
  140. <div>
  141. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Frame">View.Frame</a>
  142. </div>
  143. <div>
  144. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_GetEnumerator">View.GetEnumerator()</a>
  145. </div>
  146. <div>
  147. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_HasFocus">View.HasFocus</a>
  148. </div>
  149. <div>
  150. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Height">View.Height</a>
  151. </div>
  152. <div>
  153. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Id">View.Id</a>
  154. </div>
  155. <div>
  156. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_LayoutStyle">View.LayoutStyle</a>
  157. </div>
  158. <div>
  159. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_LayoutSubviews">View.LayoutSubviews()</a>
  160. </div>
  161. <div>
  162. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_MostFocused">View.MostFocused</a>
  163. </div>
  164. <div>
  165. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Move_System_Int32_System_Int32_">View.Move(Int32, Int32)</a>
  166. </div>
  167. <div>
  168. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ProcessColdKey_Terminal_Gui_KeyEvent_">View.ProcessColdKey(KeyEvent)</a>
  169. </div>
  170. <div>
  171. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ProcessHotKey_Terminal_Gui_KeyEvent_">View.ProcessHotKey(KeyEvent)</a>
  172. </div>
  173. <div>
  174. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Remove_Terminal_Gui_View_">View.Remove(View)</a>
  175. </div>
  176. <div>
  177. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_RemoveAll">View.RemoveAll()</a>
  178. </div>
  179. <div>
  180. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ScreenToView_System_Int32_System_Int32_">View.ScreenToView(Int32, Int32)</a>
  181. </div>
  182. <div>
  183. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SetClip_Terminal_Gui_Rect_">View.SetClip(Rect)</a>
  184. </div>
  185. <div>
  186. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SetFocus_Terminal_Gui_View_">View.SetFocus(View)</a>
  187. </div>
  188. <div>
  189. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SetNeedsDisplay">View.SetNeedsDisplay()</a>
  190. </div>
  191. <div>
  192. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SetNeedsDisplay_Terminal_Gui_Rect_">View.SetNeedsDisplay(Rect)</a>
  193. </div>
  194. <div>
  195. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Subviews">View.Subviews</a>
  196. </div>
  197. <div>
  198. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SuperView">View.SuperView</a>
  199. </div>
  200. <div>
  201. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ToString">View.ToString()</a>
  202. </div>
  203. <div>
  204. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_WantMousePositionReports">View.WantMousePositionReports</a>
  205. </div>
  206. <div>
  207. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Width">View.Width</a>
  208. </div>
  209. <div>
  210. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_X">View.X</a>
  211. </div>
  212. <div>
  213. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Y">View.Y</a>
  214. </div>
  215. </div>
  216. <h6><strong>Namespace</strong>: <a class="xref" href="../Terminal.Gui.html">Terminal.Gui</a></h6>
  217. <h6><strong>Assembly</strong>: Terminal.Gui.dll</h6>
  218. <h5 id="Terminal_Gui_ListView_syntax">Syntax</h5>
  219. <div class="codewrapper">
  220. <pre><code class="lang-csharp hljs">public class ListView : Terminal.Gui.View</code></pre>
  221. </div>
  222. <h5 id="Terminal_Gui_ListView_remarks"><strong>Remarks</strong></h5>
  223. <div class="markdown level0 remarks"><p>
  224. The ListView displays lists of data and allows the user to scroll through the data
  225. and optionally mark elements of the list (controlled by the AllowsMark property).<br> </p>
  226. <p>
  227. The ListView can either render an arbitrary IList object (for example, arrays, List<t>
  228. and other collections) which are drawn by drawing the string/ustring contents or the
  229. result of calling ToString(). Alternatively, you can provide you own IListDataSource
  230. object that gives you full control of what is rendered.
  231. <p>
  232. <p>
  233. The ListView can display any object that implements the System.Collection.IList interface,
  234. string values are converted into ustring values before rendering, and other values are
  235. converted into ustrings by calling ToString() and then converting to ustring.
  236. </p>
  237. <p>
  238. If you must change the contents of the ListView, set the Source property (when you are
  239. providing your own rendering via the IListDataSource implementation) or call SetSource
  240. when you are providing an IList.
  241. </p></t></div>
  242. <h3 id="constructors">Constructors
  243. </h3>
  244. <a id="Terminal_Gui_ListView__ctor_" data-uid="Terminal.Gui.ListView.#ctor*"></a>
  245. <h4 id="Terminal_Gui_ListView__ctor_System_Collections_IList_" data-uid="Terminal.Gui.ListView.#ctor(System.Collections.IList)">ListView(IList)</h4>
  246. <div class="markdown level1 summary"><p>Initializes a new ListView that will display the contents of the object implementing the IList interface, with relative positioning</p>
  247. </div>
  248. <div class="markdown level1 conceptual"></div>
  249. <h5 class="decalaration">Declaration</h5>
  250. <div class="codewrapper">
  251. <pre><code class="lang-csharp hljs">public ListView (System.Collections.IList source);</code></pre>
  252. </div>
  253. <h5 class="parameters">Parameters</h5>
  254. <table class="table table-bordered table-striped table-condensed">
  255. <thead>
  256. <tr>
  257. <th>Type</th>
  258. <th>Name</th>
  259. <th>Description</th>
  260. </tr>
  261. </thead>
  262. <tbody>
  263. <tr>
  264. <td><span class="xref">System.Collections.IList</span></td>
  265. <td><span class="parametername">source</span></td>
  266. <td><p>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.</p>
  267. </td>
  268. </tr>
  269. </tbody>
  270. </table>
  271. <a id="Terminal_Gui_ListView__ctor_" data-uid="Terminal.Gui.ListView.#ctor*"></a>
  272. <h4 id="Terminal_Gui_ListView__ctor_Terminal_Gui_IListDataSource_" data-uid="Terminal.Gui.ListView.#ctor(Terminal.Gui.IListDataSource)">ListView(IListDataSource)</h4>
  273. <div class="markdown level1 summary"><p>Initializes a new ListView that will display the provided data source, uses relative positioning.</p>
  274. </div>
  275. <div class="markdown level1 conceptual"></div>
  276. <h5 class="decalaration">Declaration</h5>
  277. <div class="codewrapper">
  278. <pre><code class="lang-csharp hljs">public ListView (Terminal.Gui.IListDataSource source);</code></pre>
  279. </div>
  280. <h5 class="parameters">Parameters</h5>
  281. <table class="table table-bordered table-striped table-condensed">
  282. <thead>
  283. <tr>
  284. <th>Type</th>
  285. <th>Name</th>
  286. <th>Description</th>
  287. </tr>
  288. </thead>
  289. <tbody>
  290. <tr>
  291. <td><a class="xref" href="Terminal.Gui.IListDataSource.html">IListDataSource</a></td>
  292. <td><span class="parametername">source</span></td>
  293. <td><p>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.</p>
  294. </td>
  295. </tr>
  296. </tbody>
  297. </table>
  298. <a id="Terminal_Gui_ListView__ctor_" data-uid="Terminal.Gui.ListView.#ctor*"></a>
  299. <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>
  300. <div class="markdown level1 summary"><p>Initializes a new ListView that will display the contents of the object implementing the IList interface with an absolute position.</p>
  301. </div>
  302. <div class="markdown level1 conceptual"></div>
  303. <h5 class="decalaration">Declaration</h5>
  304. <div class="codewrapper">
  305. <pre><code class="lang-csharp hljs">public ListView (Terminal.Gui.Rect rect, System.Collections.IList source);</code></pre>
  306. </div>
  307. <h5 class="parameters">Parameters</h5>
  308. <table class="table table-bordered table-striped table-condensed">
  309. <thead>
  310. <tr>
  311. <th>Type</th>
  312. <th>Name</th>
  313. <th>Description</th>
  314. </tr>
  315. </thead>
  316. <tbody>
  317. <tr>
  318. <td><a class="xref" href="Terminal.Gui.Rect.html">Rect</a></td>
  319. <td><span class="parametername">rect</span></td>
  320. <td><p>Frame for the listview.</p>
  321. </td>
  322. </tr>
  323. <tr>
  324. <td><span class="xref">System.Collections.IList</span></td>
  325. <td><span class="parametername">source</span></td>
  326. <td><p>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.</p>
  327. </td>
  328. </tr>
  329. </tbody>
  330. </table>
  331. <a id="Terminal_Gui_ListView__ctor_" data-uid="Terminal.Gui.ListView.#ctor*"></a>
  332. <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>
  333. <div class="markdown level1 summary"><p>Initializes a new ListView that will display the provided data source with an absolute position</p>
  334. </div>
  335. <div class="markdown level1 conceptual"></div>
  336. <h5 class="decalaration">Declaration</h5>
  337. <div class="codewrapper">
  338. <pre><code class="lang-csharp hljs">public ListView (Terminal.Gui.Rect rect, Terminal.Gui.IListDataSource source);</code></pre>
  339. </div>
  340. <h5 class="parameters">Parameters</h5>
  341. <table class="table table-bordered table-striped table-condensed">
  342. <thead>
  343. <tr>
  344. <th>Type</th>
  345. <th>Name</th>
  346. <th>Description</th>
  347. </tr>
  348. </thead>
  349. <tbody>
  350. <tr>
  351. <td><a class="xref" href="Terminal.Gui.Rect.html">Rect</a></td>
  352. <td><span class="parametername">rect</span></td>
  353. <td><p>Frame for the listview.</p>
  354. </td>
  355. </tr>
  356. <tr>
  357. <td><a class="xref" href="Terminal.Gui.IListDataSource.html">IListDataSource</a></td>
  358. <td><span class="parametername">source</span></td>
  359. <td><p>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.</p>
  360. </td>
  361. </tr>
  362. </tbody>
  363. </table>
  364. <h3 id="properties">Properties
  365. </h3>
  366. <a id="Terminal_Gui_ListView_AllowsMarking_" data-uid="Terminal.Gui.ListView.AllowsMarking*"></a>
  367. <h4 id="Terminal_Gui_ListView_AllowsMarking" data-uid="Terminal.Gui.ListView.AllowsMarking">AllowsMarking</h4>
  368. <div class="markdown level1 summary"><p>Gets or sets a value indicating whether this <a class="xref" href="Terminal.Gui.ListView.html">ListView</a> allows items to be marked.</p>
  369. </div>
  370. <div class="markdown level1 conceptual"></div>
  371. <h5 class="decalaration">Declaration</h5>
  372. <div class="codewrapper">
  373. <pre><code class="lang-csharp hljs">public bool AllowsMarking { get; set; }</code></pre>
  374. </div>
  375. <h5 class="propertyValue">Property Value</h5>
  376. <table class="table table-bordered table-striped table-condensed">
  377. <thead>
  378. <tr>
  379. <th>Type</th>
  380. <th>Description</th>
  381. </tr>
  382. </thead>
  383. <tbody>
  384. <tr>
  385. <td><span class="xref">System.Boolean</span></td>
  386. <td><p><code>true</code> if allows marking elements of the list; otherwise, <code>false</code>.</p>
  387. </td>
  388. </tr>
  389. </tbody>
  390. </table>
  391. <a id="Terminal_Gui_ListView_SelectedItem_" data-uid="Terminal.Gui.ListView.SelectedItem*"></a>
  392. <h4 id="Terminal_Gui_ListView_SelectedItem" data-uid="Terminal.Gui.ListView.SelectedItem">SelectedItem</h4>
  393. <div class="markdown level1 summary"><p>Gets or sets the currently selecteded item.</p>
  394. </div>
  395. <div class="markdown level1 conceptual"></div>
  396. <h5 class="decalaration">Declaration</h5>
  397. <div class="codewrapper">
  398. <pre><code class="lang-csharp hljs">public int SelectedItem { get; set; }</code></pre>
  399. </div>
  400. <h5 class="propertyValue">Property Value</h5>
  401. <table class="table table-bordered table-striped table-condensed">
  402. <thead>
  403. <tr>
  404. <th>Type</th>
  405. <th>Description</th>
  406. </tr>
  407. </thead>
  408. <tbody>
  409. <tr>
  410. <td><span class="xref">System.Int32</span></td>
  411. <td><p>The selected item.</p>
  412. </td>
  413. </tr>
  414. </tbody>
  415. </table>
  416. <a id="Terminal_Gui_ListView_Source_" data-uid="Terminal.Gui.ListView.Source*"></a>
  417. <h4 id="Terminal_Gui_ListView_Source" data-uid="Terminal.Gui.ListView.Source">Source</h4>
  418. <div class="markdown level1 summary"><p>Gets or sets the IListDataSource backing this view, use SetSource() if you want to set a new IList source.</p>
  419. </div>
  420. <div class="markdown level1 conceptual"></div>
  421. <h5 class="decalaration">Declaration</h5>
  422. <div class="codewrapper">
  423. <pre><code class="lang-csharp hljs">public Terminal.Gui.IListDataSource Source { get; set; }</code></pre>
  424. </div>
  425. <h5 class="propertyValue">Property Value</h5>
  426. <table class="table table-bordered table-striped table-condensed">
  427. <thead>
  428. <tr>
  429. <th>Type</th>
  430. <th>Description</th>
  431. </tr>
  432. </thead>
  433. <tbody>
  434. <tr>
  435. <td><a class="xref" href="Terminal.Gui.IListDataSource.html">IListDataSource</a></td>
  436. <td><p>The source.</p>
  437. </td>
  438. </tr>
  439. </tbody>
  440. </table>
  441. <a id="Terminal_Gui_ListView_TopItem_" data-uid="Terminal.Gui.ListView.TopItem*"></a>
  442. <h4 id="Terminal_Gui_ListView_TopItem" data-uid="Terminal.Gui.ListView.TopItem">TopItem</h4>
  443. <div class="markdown level1 summary"><p>Gets or sets the item that is displayed at the top of the listview</p>
  444. </div>
  445. <div class="markdown level1 conceptual"></div>
  446. <h5 class="decalaration">Declaration</h5>
  447. <div class="codewrapper">
  448. <pre><code class="lang-csharp hljs">public int TopItem { get; set; }</code></pre>
  449. </div>
  450. <h5 class="propertyValue">Property Value</h5>
  451. <table class="table table-bordered table-striped table-condensed">
  452. <thead>
  453. <tr>
  454. <th>Type</th>
  455. <th>Description</th>
  456. </tr>
  457. </thead>
  458. <tbody>
  459. <tr>
  460. <td><span class="xref">System.Int32</span></td>
  461. <td><p>The top item.</p>
  462. </td>
  463. </tr>
  464. </tbody>
  465. </table>
  466. <h3 id="methods">Methods
  467. </h3>
  468. <a id="Terminal_Gui_ListView_MouseEvent_" data-uid="Terminal.Gui.ListView.MouseEvent*"></a>
  469. <h4 id="Terminal_Gui_ListView_MouseEvent_Terminal_Gui_MouseEvent_" data-uid="Terminal.Gui.ListView.MouseEvent(Terminal.Gui.MouseEvent)">MouseEvent(MouseEvent)</h4>
  470. <div class="markdown level1 summary"></div>
  471. <div class="markdown level1 conceptual"></div>
  472. <h5 class="decalaration">Declaration</h5>
  473. <div class="codewrapper">
  474. <pre><code class="lang-csharp hljs">public override bool MouseEvent (Terminal.Gui.MouseEvent me);</code></pre>
  475. </div>
  476. <h5 class="parameters">Parameters</h5>
  477. <table class="table table-bordered table-striped table-condensed">
  478. <thead>
  479. <tr>
  480. <th>Type</th>
  481. <th>Name</th>
  482. <th>Description</th>
  483. </tr>
  484. </thead>
  485. <tbody>
  486. <tr>
  487. <td><a class="xref" href="Terminal.Gui.MouseEvent.html">MouseEvent</a></td>
  488. <td><span class="parametername">me</span></td>
  489. <td><p>To be added.</p>
  490. </td>
  491. </tr>
  492. </tbody>
  493. </table>
  494. <h5 class="returns">Returns</h5>
  495. <table class="table table-bordered table-striped table-condensed">
  496. <thead>
  497. <tr>
  498. <th>Type</th>
  499. <th>Description</th>
  500. </tr>
  501. </thead>
  502. <tbody>
  503. <tr>
  504. <td><span class="xref">System.Boolean</span></td>
  505. <td><p>To be added.</p>
  506. </td>
  507. </tr>
  508. </tbody>
  509. </table>
  510. <a id="Terminal_Gui_ListView_PositionCursor_" data-uid="Terminal.Gui.ListView.PositionCursor*"></a>
  511. <h4 id="Terminal_Gui_ListView_PositionCursor" data-uid="Terminal.Gui.ListView.PositionCursor">PositionCursor()</h4>
  512. <div class="markdown level1 summary"><p>Positions the cursor in this view</p>
  513. </div>
  514. <div class="markdown level1 conceptual"></div>
  515. <h5 class="decalaration">Declaration</h5>
  516. <div class="codewrapper">
  517. <pre><code class="lang-csharp hljs">public override void PositionCursor ();</code></pre>
  518. </div>
  519. <a id="Terminal_Gui_ListView_ProcessKey_" data-uid="Terminal.Gui.ListView.ProcessKey*"></a>
  520. <h4 id="Terminal_Gui_ListView_ProcessKey_Terminal_Gui_KeyEvent_" data-uid="Terminal.Gui.ListView.ProcessKey(Terminal.Gui.KeyEvent)">ProcessKey(KeyEvent)</h4>
  521. <div class="markdown level1 summary"><p>Handles cursor movement for this view, passes all other events.</p>
  522. </div>
  523. <div class="markdown level1 conceptual"></div>
  524. <h5 class="decalaration">Declaration</h5>
  525. <div class="codewrapper">
  526. <pre><code class="lang-csharp hljs">public override bool ProcessKey (Terminal.Gui.KeyEvent kb);</code></pre>
  527. </div>
  528. <h5 class="parameters">Parameters</h5>
  529. <table class="table table-bordered table-striped table-condensed">
  530. <thead>
  531. <tr>
  532. <th>Type</th>
  533. <th>Name</th>
  534. <th>Description</th>
  535. </tr>
  536. </thead>
  537. <tbody>
  538. <tr>
  539. <td><a class="xref" href="Terminal.Gui.KeyEvent.html">KeyEvent</a></td>
  540. <td><span class="parametername">kb</span></td>
  541. <td><p>Keyboard event.</p>
  542. </td>
  543. </tr>
  544. </tbody>
  545. </table>
  546. <h5 class="returns">Returns</h5>
  547. <table class="table table-bordered table-striped table-condensed">
  548. <thead>
  549. <tr>
  550. <th>Type</th>
  551. <th>Description</th>
  552. </tr>
  553. </thead>
  554. <tbody>
  555. <tr>
  556. <td><span class="xref">System.Boolean</span></td>
  557. <td><p><code>true</code>, if key was processed, <code>false</code> otherwise.</p>
  558. </td>
  559. </tr>
  560. </tbody>
  561. </table>
  562. <a id="Terminal_Gui_ListView_Redraw_" data-uid="Terminal.Gui.ListView.Redraw*"></a>
  563. <h4 id="Terminal_Gui_ListView_Redraw_Terminal_Gui_Rect_" data-uid="Terminal.Gui.ListView.Redraw(Terminal.Gui.Rect)">Redraw(Rect)</h4>
  564. <div class="markdown level1 summary"><p>Redraws the ListView</p>
  565. </div>
  566. <div class="markdown level1 conceptual"></div>
  567. <h5 class="decalaration">Declaration</h5>
  568. <div class="codewrapper">
  569. <pre><code class="lang-csharp hljs">public override void Redraw (Terminal.Gui.Rect region);</code></pre>
  570. </div>
  571. <h5 class="parameters">Parameters</h5>
  572. <table class="table table-bordered table-striped table-condensed">
  573. <thead>
  574. <tr>
  575. <th>Type</th>
  576. <th>Name</th>
  577. <th>Description</th>
  578. </tr>
  579. </thead>
  580. <tbody>
  581. <tr>
  582. <td><a class="xref" href="Terminal.Gui.Rect.html">Rect</a></td>
  583. <td><span class="parametername">region</span></td>
  584. <td><p>Region.</p>
  585. </td>
  586. </tr>
  587. </tbody>
  588. </table>
  589. <a id="Terminal_Gui_ListView_SetSource_" data-uid="Terminal.Gui.ListView.SetSource*"></a>
  590. <h4 id="Terminal_Gui_ListView_SetSource_System_Collections_IList_" data-uid="Terminal.Gui.ListView.SetSource(System.Collections.IList)">SetSource(IList)</h4>
  591. <div class="markdown level1 summary"><p>Sets the source to an IList value, if you want to set a full IListDataSource, use the Source property.</p>
  592. </div>
  593. <div class="markdown level1 conceptual"></div>
  594. <h5 class="decalaration">Declaration</h5>
  595. <div class="codewrapper">
  596. <pre><code class="lang-csharp hljs">public void SetSource (System.Collections.IList source);</code></pre>
  597. </div>
  598. <h5 class="parameters">Parameters</h5>
  599. <table class="table table-bordered table-striped table-condensed">
  600. <thead>
  601. <tr>
  602. <th>Type</th>
  603. <th>Name</th>
  604. <th>Description</th>
  605. </tr>
  606. </thead>
  607. <tbody>
  608. <tr>
  609. <td><span class="xref">System.Collections.IList</span></td>
  610. <td><span class="parametername">source</span></td>
  611. <td><p>To be added.</p>
  612. </td>
  613. </tr>
  614. </tbody>
  615. </table>
  616. <h3 id="events">Events
  617. </h3>
  618. <h4 id="Terminal_Gui_ListView_SelectedChanged" data-uid="Terminal.Gui.ListView.SelectedChanged">SelectedChanged</h4>
  619. <div class="markdown level1 summary"><p>This event is raised when the cursor selection has changed.</p>
  620. </div>
  621. <div class="markdown level1 conceptual"></div>
  622. <h5 class="decalaration">Declaration</h5>
  623. <div class="codewrapper">
  624. <pre><code class="lang-csharp hljs">public event Action SelectedChanged;</code></pre>
  625. </div>
  626. <h5 class="eventType">Event Type</h5>
  627. <table class="table table-bordered table-striped table-condensed">
  628. <thead>
  629. <tr>
  630. <th>Type</th>
  631. <th>Description</th>
  632. </tr>
  633. </thead>
  634. <tbody>
  635. <tr>
  636. <td><span class="xref">System.Action</span></td>
  637. <td><p>To be added.</p>
  638. </td>
  639. </tr>
  640. </tbody>
  641. </table>
  642. </article>
  643. </div>
  644. <div class="hidden-sm col-md-2" role="complementary">
  645. <div class="sideaffix">
  646. <div class="contribution">
  647. <ul class="nav">
  648. </ul>
  649. </div>
  650. <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
  651. <!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
  652. </nav>
  653. </div>
  654. </div>
  655. </div>
  656. </div>
  657. <footer>
  658. <div class="grad-bottom"></div>
  659. <div class="footer">
  660. <div class="container">
  661. <span class="pull-right">
  662. <a href="#top">Back to top</a>
  663. </span>
  664. <span>Copyright © 2015-2017 Microsoft<br>Generated by <strong>DocFX</strong></span>
  665. </div>
  666. </div>
  667. </footer>
  668. </div>
  669. <script type="text/javascript" src="../../styles/docfx.vendor.js"></script>
  670. <script type="text/javascript" src="../../styles/docfx.js"></script>
  671. <script type="text/javascript" src="../../styles/main.js"></script>
  672. </body>
  673. </html>