Terminal.Gui.ListView.html 54 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380
  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.56.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. <meta property="docfx:navrel" content="../../toc.html">
  18. <meta property="docfx:tocrel" content="toc.html">
  19. <meta property="docfx:rel" content="../../">
  20. </head>
  21. <body data-spy="scroll" data-target="#affix" data-offset="120">
  22. <div id="wrapper">
  23. <header>
  24. <nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation">
  25. <div class="container">
  26. <div class="navbar-header">
  27. <button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
  28. <span class="sr-only">Toggle navigation</span>
  29. <span class="icon-bar"></span>
  30. <span class="icon-bar"></span>
  31. <span class="icon-bar"></span>
  32. </button>
  33. <a class="navbar-brand" href="../../index.html">
  34. <img id="logo" class="svg" src="../../images/logo48.png" alt="">
  35. </a>
  36. </div>
  37. <div class="collapse navbar-collapse" id="navbar">
  38. <form class="navbar-form navbar-right" role="search" id="search">
  39. <div class="form-group">
  40. <input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">
  41. </div>
  42. </form>
  43. </div>
  44. </div>
  45. </nav>
  46. <div class="subnav navbar navbar-default">
  47. <div class="container hide-when-search" id="breadcrumb">
  48. <ul class="breadcrumb">
  49. <li></li>
  50. </ul>
  51. </div>
  52. </div>
  53. </header>
  54. <div class="container body-content">
  55. <div id="search-results">
  56. <div class="search-list"></div>
  57. <div class="sr-items">
  58. <p><i class="glyphicon glyphicon-refresh index-loading"></i></p>
  59. </div>
  60. <ul id="pagination"></ul>
  61. </div>
  62. </div>
  63. <div role="main" class="container body-content hide-when-search">
  64. <div class="sidenav hide-when-search">
  65. <a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
  66. <div class="sidetoggle collapse" id="sidetoggle">
  67. <div id="sidetoc"></div>
  68. </div>
  69. </div>
  70. <div class="article row grid-right">
  71. <div class="col-md-10">
  72. <article class="content wrap" id="_content" data-uid="Terminal.Gui.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.IDisposable</span></div>
  89. <div><span class="xref">System.Collections.IEnumerable</span></div>
  90. <div><span class="xref">System.ComponentModel.ISupportInitializeNotification</span></div>
  91. <div><span class="xref">System.ComponentModel.ISupportInitialize</span></div>
  92. </div>
  93. <div class="inheritedMembers">
  94. <h5>Inherited Members</h5>
  95. <div>
  96. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Added">View.Added</a>
  97. </div>
  98. <div>
  99. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Removed">View.Removed</a>
  100. </div>
  101. <div>
  102. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Enter">View.Enter</a>
  103. </div>
  104. <div>
  105. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Leave">View.Leave</a>
  106. </div>
  107. <div>
  108. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_MouseEnter">View.MouseEnter</a>
  109. </div>
  110. <div>
  111. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_MouseLeave">View.MouseLeave</a>
  112. </div>
  113. <div>
  114. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_MouseClick">View.MouseClick</a>
  115. </div>
  116. <div>
  117. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_HotKey">View.HotKey</a>
  118. </div>
  119. <div>
  120. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_HotKeySpecifier">View.HotKeySpecifier</a>
  121. </div>
  122. <div>
  123. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Driver">View.Driver</a>
  124. </div>
  125. <div>
  126. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Subviews">View.Subviews</a>
  127. </div>
  128. <div>
  129. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_TabIndexes">View.TabIndexes</a>
  130. </div>
  131. <div>
  132. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_TabIndex">View.TabIndex</a>
  133. </div>
  134. <div>
  135. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_TabStop">View.TabStop</a>
  136. </div>
  137. <div>
  138. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_CanFocus">View.CanFocus</a>
  139. </div>
  140. <div>
  141. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Id">View.Id</a>
  142. </div>
  143. <div>
  144. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_IsCurrentTop">View.IsCurrentTop</a>
  145. </div>
  146. <div>
  147. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_WantMousePositionReports">View.WantMousePositionReports</a>
  148. </div>
  149. <div>
  150. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_WantContinuousButtonPressed">View.WantContinuousButtonPressed</a>
  151. </div>
  152. <div>
  153. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Frame">View.Frame</a>
  154. </div>
  155. <div>
  156. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_GetEnumerator">View.GetEnumerator()</a>
  157. </div>
  158. <div>
  159. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_LayoutStyle">View.LayoutStyle</a>
  160. </div>
  161. <div>
  162. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Bounds">View.Bounds</a>
  163. </div>
  164. <div>
  165. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_X">View.X</a>
  166. </div>
  167. <div>
  168. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Y">View.Y</a>
  169. </div>
  170. <div>
  171. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Width">View.Width</a>
  172. </div>
  173. <div>
  174. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Height">View.Height</a>
  175. </div>
  176. <div>
  177. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SuperView">View.SuperView</a>
  178. </div>
  179. <div>
  180. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SetNeedsDisplay">View.SetNeedsDisplay()</a>
  181. </div>
  182. <div>
  183. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SetNeedsDisplay_Terminal_Gui_Rect_">View.SetNeedsDisplay(Rect)</a>
  184. </div>
  185. <div>
  186. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ChildNeedsDisplay">View.ChildNeedsDisplay()</a>
  187. </div>
  188. <div>
  189. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Add_Terminal_Gui_View_">View.Add(View)</a>
  190. </div>
  191. <div>
  192. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Add_Terminal_Gui_View___">View.Add(View[])</a>
  193. </div>
  194. <div>
  195. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_RemoveAll">View.RemoveAll()</a>
  196. </div>
  197. <div>
  198. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Remove_Terminal_Gui_View_">View.Remove(View)</a>
  199. </div>
  200. <div>
  201. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_BringSubviewToFront_Terminal_Gui_View_">View.BringSubviewToFront(View)</a>
  202. </div>
  203. <div>
  204. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SendSubviewToBack_Terminal_Gui_View_">View.SendSubviewToBack(View)</a>
  205. </div>
  206. <div>
  207. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SendSubviewBackwards_Terminal_Gui_View_">View.SendSubviewBackwards(View)</a>
  208. </div>
  209. <div>
  210. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_BringSubviewForward_Terminal_Gui_View_">View.BringSubviewForward(View)</a>
  211. </div>
  212. <div>
  213. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Clear">View.Clear()</a>
  214. </div>
  215. <div>
  216. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Clear_Terminal_Gui_Rect_">View.Clear(Rect)</a>
  217. </div>
  218. <div>
  219. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ScreenToView_System_Int32_System_Int32_">View.ScreenToView(Int32, Int32)</a>
  220. </div>
  221. <div>
  222. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ClipToBounds">View.ClipToBounds()</a>
  223. </div>
  224. <div>
  225. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SetClip_Terminal_Gui_Rect_">View.SetClip(Rect)</a>
  226. </div>
  227. <div>
  228. <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>
  229. </div>
  230. <div>
  231. <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>
  232. </div>
  233. <div>
  234. <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>
  235. </div>
  236. <div>
  237. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Move_System_Int32_System_Int32_">View.Move(Int32, Int32)</a>
  238. </div>
  239. <div>
  240. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_HasFocus">View.HasFocus</a>
  241. </div>
  242. <div>
  243. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnAdded_Terminal_Gui_View_">View.OnAdded(View)</a>
  244. </div>
  245. <div>
  246. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnRemoved_Terminal_Gui_View_">View.OnRemoved(View)</a>
  247. </div>
  248. <div>
  249. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnLeave_Terminal_Gui_View_">View.OnLeave(View)</a>
  250. </div>
  251. <div>
  252. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Focused">View.Focused</a>
  253. </div>
  254. <div>
  255. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_MostFocused">View.MostFocused</a>
  256. </div>
  257. <div>
  258. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ColorScheme">View.ColorScheme</a>
  259. </div>
  260. <div>
  261. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_AddRune_System_Int32_System_Int32_System_Rune_">View.AddRune(Int32, Int32, Rune)</a>
  262. </div>
  263. <div>
  264. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ClearNeedsDisplay">View.ClearNeedsDisplay()</a>
  265. </div>
  266. <div>
  267. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_DrawContent">View.DrawContent</a>
  268. </div>
  269. <div>
  270. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnDrawContent_Terminal_Gui_Rect_">View.OnDrawContent(Rect)</a>
  271. </div>
  272. <div>
  273. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SetFocus_Terminal_Gui_View_">View.SetFocus(View)</a>
  274. </div>
  275. <div>
  276. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_KeyPress">View.KeyPress</a>
  277. </div>
  278. <div>
  279. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ProcessHotKey_Terminal_Gui_KeyEvent_">View.ProcessHotKey(KeyEvent)</a>
  280. </div>
  281. <div>
  282. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ProcessColdKey_Terminal_Gui_KeyEvent_">View.ProcessColdKey(KeyEvent)</a>
  283. </div>
  284. <div>
  285. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_KeyDown">View.KeyDown</a>
  286. </div>
  287. <div>
  288. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnKeyDown_Terminal_Gui_KeyEvent_">View.OnKeyDown(KeyEvent)</a>
  289. </div>
  290. <div>
  291. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_KeyUp">View.KeyUp</a>
  292. </div>
  293. <div>
  294. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnKeyUp_Terminal_Gui_KeyEvent_">View.OnKeyUp(KeyEvent)</a>
  295. </div>
  296. <div>
  297. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_EnsureFocus">View.EnsureFocus()</a>
  298. </div>
  299. <div>
  300. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_FocusFirst">View.FocusFirst()</a>
  301. </div>
  302. <div>
  303. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_FocusLast">View.FocusLast()</a>
  304. </div>
  305. <div>
  306. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_FocusPrev">View.FocusPrev()</a>
  307. </div>
  308. <div>
  309. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_FocusNext">View.FocusNext()</a>
  310. </div>
  311. <div>
  312. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_LayoutStarted">View.LayoutStarted</a>
  313. </div>
  314. <div>
  315. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_LayoutComplete">View.LayoutComplete</a>
  316. </div>
  317. <div>
  318. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Initialized">View.Initialized</a>
  319. </div>
  320. <div>
  321. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_LayoutSubviews">View.LayoutSubviews()</a>
  322. </div>
  323. <div>
  324. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Text">View.Text</a>
  325. </div>
  326. <div>
  327. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_TextAlignment">View.TextAlignment</a>
  328. </div>
  329. <div>
  330. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_IsInitialized">View.IsInitialized</a>
  331. </div>
  332. <div>
  333. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ToString">View.ToString()</a>
  334. </div>
  335. <div>
  336. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnMouseLeave_Terminal_Gui_MouseEvent_">View.OnMouseLeave(MouseEvent)</a>
  337. </div>
  338. <div>
  339. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnMouseEvent_Terminal_Gui_MouseEvent_">View.OnMouseEvent(MouseEvent)</a>
  340. </div>
  341. <div>
  342. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Dispose_System_Boolean_">View.Dispose(Boolean)</a>
  343. </div>
  344. <div>
  345. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_BeginInit">View.BeginInit()</a>
  346. </div>
  347. <div>
  348. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_EndInit">View.EndInit()</a>
  349. </div>
  350. <div>
  351. <a class="xref" href="Terminal.Gui.Responder.html#Terminal_Gui_Responder_Dispose">Responder.Dispose()</a>
  352. </div>
  353. <div>
  354. <span class="xref">System.Object.Equals(System.Object)</span>
  355. </div>
  356. <div>
  357. <span class="xref">System.Object.Equals(System.Object, System.Object)</span>
  358. </div>
  359. <div>
  360. <span class="xref">System.Object.GetHashCode()</span>
  361. </div>
  362. <div>
  363. <span class="xref">System.Object.GetType()</span>
  364. </div>
  365. <div>
  366. <span class="xref">System.Object.MemberwiseClone()</span>
  367. </div>
  368. <div>
  369. <span class="xref">System.Object.ReferenceEquals(System.Object, System.Object)</span>
  370. </div>
  371. </div>
  372. <h6><strong>Namespace</strong>: <a class="xref" href="Terminal.Gui.html">Terminal.Gui</a></h6>
  373. <h6><strong>Assembly</strong>: Terminal.Gui.dll</h6>
  374. <h5 id="Terminal_Gui_ListView_syntax">Syntax</h5>
  375. <div class="codewrapper">
  376. <pre><code class="lang-csharp hljs">public class ListView : View, IDisposable, IEnumerable, ISupportInitializeNotification, ISupportInitialize</code></pre>
  377. </div>
  378. <h5 id="Terminal_Gui_ListView_remarks"><strong>Remarks</strong></h5>
  379. <div class="markdown level0 remarks">
  380. <p>
  381. The <a class="xref" href="Terminal.Gui.ListView.html">ListView</a> displays lists of data and allows the user to scroll through the data.
  382. Items in the can be activated firing an event (with the ENTER key or a mouse double-click).
  383. 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.
  384. </p>
  385. <p>
  386. 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
  387. <span class="xref">System.Collections.IList</span> object (e.g. arrays, <span class="xref">System.Collections.Generic.List&lt;T&gt;</span>,
  388. and other collections). Alternatively, an object that implements the <a class="xref" href="Terminal.Gui.IListDataSource.html">IListDataSource</a>
  389. interface can be provided giving full control of what is rendered.
  390. </p>
  391. <p>
  392. <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.
  393. <span class="xref">System.String</span> values are converted into <span class="xref">NStack.ustring</span> values before rendering, and other values are
  394. 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> .
  395. </p>
  396. <p>
  397. 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
  398. 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>
  399. an <span class="xref">System.Collections.IList</span> is being used.
  400. </p>
  401. <p>
  402. 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
  403. [x] or [ ] and bind the SPACE key to toggle the selection. To implement a different
  404. marking style set <a class="xref" href="Terminal.Gui.ListView.html#Terminal_Gui_ListView_AllowsMarking">AllowsMarking</a> to false and implement custom rendering.
  405. </p>
  406. </div>
  407. <h3 id="constructors">Constructors
  408. </h3>
  409. <a id="Terminal_Gui_ListView__ctor_" data-uid="Terminal.Gui.ListView.#ctor*"></a>
  410. <h4 id="Terminal_Gui_ListView__ctor" data-uid="Terminal.Gui.ListView.#ctor">ListView()</h4>
  411. <div class="markdown level1 summary">
  412. 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.
  413. </div>
  414. <div class="markdown level1 conceptual"></div>
  415. <h5 class="decalaration">Declaration</h5>
  416. <div class="codewrapper">
  417. <pre><code class="lang-csharp hljs">public ListView()</code></pre>
  418. </div>
  419. <a id="Terminal_Gui_ListView__ctor_" data-uid="Terminal.Gui.ListView.#ctor*"></a>
  420. <h4 id="Terminal_Gui_ListView__ctor_System_Collections_IList_" data-uid="Terminal.Gui.ListView.#ctor(System.Collections.IList)">ListView(IList)</h4>
  421. <div class="markdown level1 summary">
  422. 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,
  423. with relative positioning.
  424. </div>
  425. <div class="markdown level1 conceptual"></div>
  426. <h5 class="decalaration">Declaration</h5>
  427. <div class="codewrapper">
  428. <pre><code class="lang-csharp hljs">public ListView(IList source)</code></pre>
  429. </div>
  430. <h5 class="parameters">Parameters</h5>
  431. <table class="table table-bordered table-striped table-condensed">
  432. <thead>
  433. <tr>
  434. <th>Type</th>
  435. <th>Name</th>
  436. <th>Description</th>
  437. </tr>
  438. </thead>
  439. <tbody>
  440. <tr>
  441. <td><span class="xref">System.Collections.IList</span></td>
  442. <td><span class="parametername">source</span></td>
  443. <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>
  444. </tr>
  445. </tbody>
  446. </table>
  447. <a id="Terminal_Gui_ListView__ctor_" data-uid="Terminal.Gui.ListView.#ctor*"></a>
  448. <h4 id="Terminal_Gui_ListView__ctor_Terminal_Gui_IListDataSource_" data-uid="Terminal.Gui.ListView.#ctor(Terminal.Gui.IListDataSource)">ListView(IListDataSource)</h4>
  449. <div class="markdown level1 summary">
  450. 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.
  451. </div>
  452. <div class="markdown level1 conceptual"></div>
  453. <h5 class="decalaration">Declaration</h5>
  454. <div class="codewrapper">
  455. <pre><code class="lang-csharp hljs">public ListView(IListDataSource source)</code></pre>
  456. </div>
  457. <h5 class="parameters">Parameters</h5>
  458. <table class="table table-bordered table-striped table-condensed">
  459. <thead>
  460. <tr>
  461. <th>Type</th>
  462. <th>Name</th>
  463. <th>Description</th>
  464. </tr>
  465. </thead>
  466. <tbody>
  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><a class="xref" href="Terminal.Gui.IListDataSource.html">IListDataSource</a> object that provides a mechanism to render the data.
  471. The number of elements on the collection should not change, if you must change, set
  472. the &quot;Source&quot; property to reset the internal settings of the ListView.</td>
  473. </tr>
  474. </tbody>
  475. </table>
  476. <a id="Terminal_Gui_ListView__ctor_" data-uid="Terminal.Gui.ListView.#ctor*"></a>
  477. <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>
  478. <div class="markdown level1 summary">
  479. 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.
  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 ListView(Rect rect, IList source)</code></pre>
  485. </div>
  486. <h5 class="parameters">Parameters</h5>
  487. <table class="table table-bordered table-striped table-condensed">
  488. <thead>
  489. <tr>
  490. <th>Type</th>
  491. <th>Name</th>
  492. <th>Description</th>
  493. </tr>
  494. </thead>
  495. <tbody>
  496. <tr>
  497. <td><a class="xref" href="Terminal.Gui.Rect.html">Rect</a></td>
  498. <td><span class="parametername">rect</span></td>
  499. <td>Frame for the listview.</td>
  500. </tr>
  501. <tr>
  502. <td><span class="xref">System.Collections.IList</span></td>
  503. <td><span class="parametername">source</span></td>
  504. <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>
  505. </tr>
  506. </tbody>
  507. </table>
  508. <a id="Terminal_Gui_ListView__ctor_" data-uid="Terminal.Gui.ListView.#ctor*"></a>
  509. <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>
  510. <div class="markdown level1 summary">
  511. Initializes a new instance of <a class="xref" href="Terminal.Gui.ListView.html">ListView</a> with the provided data source and an absolute position
  512. </div>
  513. <div class="markdown level1 conceptual"></div>
  514. <h5 class="decalaration">Declaration</h5>
  515. <div class="codewrapper">
  516. <pre><code class="lang-csharp hljs">public ListView(Rect rect, IListDataSource source)</code></pre>
  517. </div>
  518. <h5 class="parameters">Parameters</h5>
  519. <table class="table table-bordered table-striped table-condensed">
  520. <thead>
  521. <tr>
  522. <th>Type</th>
  523. <th>Name</th>
  524. <th>Description</th>
  525. </tr>
  526. </thead>
  527. <tbody>
  528. <tr>
  529. <td><a class="xref" href="Terminal.Gui.Rect.html">Rect</a></td>
  530. <td><span class="parametername">rect</span></td>
  531. <td>Frame for the listview.</td>
  532. </tr>
  533. <tr>
  534. <td><a class="xref" href="Terminal.Gui.IListDataSource.html">IListDataSource</a></td>
  535. <td><span class="parametername">source</span></td>
  536. <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>
  537. </tr>
  538. </tbody>
  539. </table>
  540. <h3 id="fields">Fields
  541. </h3>
  542. <h4 id="Terminal_Gui_ListView_OpenSelectedItem" data-uid="Terminal.Gui.ListView.OpenSelectedItem">OpenSelectedItem</h4>
  543. <div class="markdown level1 summary">
  544. This event is raised when the user Double Clicks on an item or presses ENTER to open the selected item.
  545. </div>
  546. <div class="markdown level1 conceptual"></div>
  547. <h5 class="decalaration">Declaration</h5>
  548. <div class="codewrapper">
  549. <pre><code class="lang-csharp hljs">public Action&lt;ListViewItemEventArgs&gt; OpenSelectedItem</code></pre>
  550. </div>
  551. <h5 class="fieldValue">Field Value</h5>
  552. <table class="table table-bordered table-striped table-condensed">
  553. <thead>
  554. <tr>
  555. <th>Type</th>
  556. <th>Description</th>
  557. </tr>
  558. </thead>
  559. <tbody>
  560. <tr>
  561. <td><span class="xref">System.Action</span>&lt;<a class="xref" href="Terminal.Gui.ListViewItemEventArgs.html">ListViewItemEventArgs</a>&gt;</td>
  562. <td></td>
  563. </tr>
  564. </tbody>
  565. </table>
  566. <h4 id="Terminal_Gui_ListView_SelectedItemChanged" data-uid="Terminal.Gui.ListView.SelectedItemChanged">SelectedItemChanged</h4>
  567. <div class="markdown level1 summary">
  568. This event is raised when the selected item in the <a class="xref" href="Terminal.Gui.ListView.html">ListView</a> has changed.
  569. </div>
  570. <div class="markdown level1 conceptual"></div>
  571. <h5 class="decalaration">Declaration</h5>
  572. <div class="codewrapper">
  573. <pre><code class="lang-csharp hljs">public Action&lt;ListViewItemEventArgs&gt; SelectedItemChanged</code></pre>
  574. </div>
  575. <h5 class="fieldValue">Field Value</h5>
  576. <table class="table table-bordered table-striped table-condensed">
  577. <thead>
  578. <tr>
  579. <th>Type</th>
  580. <th>Description</th>
  581. </tr>
  582. </thead>
  583. <tbody>
  584. <tr>
  585. <td><span class="xref">System.Action</span>&lt;<a class="xref" href="Terminal.Gui.ListViewItemEventArgs.html">ListViewItemEventArgs</a>&gt;</td>
  586. <td></td>
  587. </tr>
  588. </tbody>
  589. </table>
  590. <h3 id="properties">Properties
  591. </h3>
  592. <a id="Terminal_Gui_ListView_AllowsMarking_" data-uid="Terminal.Gui.ListView.AllowsMarking*"></a>
  593. <h4 id="Terminal_Gui_ListView_AllowsMarking" data-uid="Terminal.Gui.ListView.AllowsMarking">AllowsMarking</h4>
  594. <div class="markdown level1 summary">
  595. Gets or sets whether this <a class="xref" href="Terminal.Gui.ListView.html">ListView</a> allows items to be marked.
  596. </div>
  597. <div class="markdown level1 conceptual"></div>
  598. <h5 class="decalaration">Declaration</h5>
  599. <div class="codewrapper">
  600. <pre><code class="lang-csharp hljs">public bool AllowsMarking { get; set; }</code></pre>
  601. </div>
  602. <h5 class="propertyValue">Property Value</h5>
  603. <table class="table table-bordered table-striped table-condensed">
  604. <thead>
  605. <tr>
  606. <th>Type</th>
  607. <th>Description</th>
  608. </tr>
  609. </thead>
  610. <tbody>
  611. <tr>
  612. <td><span class="xref">System.Boolean</span></td>
  613. <td><code>true</code> if allows marking elements of the list; otherwise, <code>false</code>.
  614. </td>
  615. </tr>
  616. </tbody>
  617. </table>
  618. <h5 id="Terminal_Gui_ListView_AllowsMarking_remarks">Remarks</h5>
  619. <div class="markdown level1 remarks">
  620. 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;
  621. spaces. SPACE key will toggle marking.
  622. </div>
  623. <a id="Terminal_Gui_ListView_AllowsMultipleSelection_" data-uid="Terminal.Gui.ListView.AllowsMultipleSelection*"></a>
  624. <h4 id="Terminal_Gui_ListView_AllowsMultipleSelection" data-uid="Terminal.Gui.ListView.AllowsMultipleSelection">AllowsMultipleSelection</h4>
  625. <div class="markdown level1 summary">
  626. If set to true allows more than one item to be selected. If false only allow one item selected.
  627. </div>
  628. <div class="markdown level1 conceptual"></div>
  629. <h5 class="decalaration">Declaration</h5>
  630. <div class="codewrapper">
  631. <pre><code class="lang-csharp hljs">public bool AllowsMultipleSelection { get; set; }</code></pre>
  632. </div>
  633. <h5 class="propertyValue">Property Value</h5>
  634. <table class="table table-bordered table-striped table-condensed">
  635. <thead>
  636. <tr>
  637. <th>Type</th>
  638. <th>Description</th>
  639. </tr>
  640. </thead>
  641. <tbody>
  642. <tr>
  643. <td><span class="xref">System.Boolean</span></td>
  644. <td></td>
  645. </tr>
  646. </tbody>
  647. </table>
  648. <a id="Terminal_Gui_ListView_SelectedItem_" data-uid="Terminal.Gui.ListView.SelectedItem*"></a>
  649. <h4 id="Terminal_Gui_ListView_SelectedItem" data-uid="Terminal.Gui.ListView.SelectedItem">SelectedItem</h4>
  650. <div class="markdown level1 summary">
  651. Gets or sets the index of the currently selected item.
  652. </div>
  653. <div class="markdown level1 conceptual"></div>
  654. <h5 class="decalaration">Declaration</h5>
  655. <div class="codewrapper">
  656. <pre><code class="lang-csharp hljs">public int SelectedItem { get; set; }</code></pre>
  657. </div>
  658. <h5 class="propertyValue">Property Value</h5>
  659. <table class="table table-bordered table-striped table-condensed">
  660. <thead>
  661. <tr>
  662. <th>Type</th>
  663. <th>Description</th>
  664. </tr>
  665. </thead>
  666. <tbody>
  667. <tr>
  668. <td><span class="xref">System.Int32</span></td>
  669. <td>The selected item.</td>
  670. </tr>
  671. </tbody>
  672. </table>
  673. <a id="Terminal_Gui_ListView_Source_" data-uid="Terminal.Gui.ListView.Source*"></a>
  674. <h4 id="Terminal_Gui_ListView_Source" data-uid="Terminal.Gui.ListView.Source">Source</h4>
  675. <div class="markdown level1 summary">
  676. 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.
  677. </div>
  678. <div class="markdown level1 conceptual"></div>
  679. <h5 class="decalaration">Declaration</h5>
  680. <div class="codewrapper">
  681. <pre><code class="lang-csharp hljs">public IListDataSource Source { get; set; }</code></pre>
  682. </div>
  683. <h5 class="propertyValue">Property Value</h5>
  684. <table class="table table-bordered table-striped table-condensed">
  685. <thead>
  686. <tr>
  687. <th>Type</th>
  688. <th>Description</th>
  689. </tr>
  690. </thead>
  691. <tbody>
  692. <tr>
  693. <td><a class="xref" href="Terminal.Gui.IListDataSource.html">IListDataSource</a></td>
  694. <td>The source.</td>
  695. </tr>
  696. </tbody>
  697. </table>
  698. <h5 id="Terminal_Gui_ListView_Source_remarks">Remarks</h5>
  699. <div class="markdown level1 remarks">
  700. 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.
  701. </div>
  702. <a id="Terminal_Gui_ListView_TopItem_" data-uid="Terminal.Gui.ListView.TopItem*"></a>
  703. <h4 id="Terminal_Gui_ListView_TopItem" data-uid="Terminal.Gui.ListView.TopItem">TopItem</h4>
  704. <div class="markdown level1 summary">
  705. Gets or sets the item that is displayed at the top of the <a class="xref" href="Terminal.Gui.ListView.html">ListView</a>.
  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 int TopItem { get; set; }</code></pre>
  711. </div>
  712. <h5 class="propertyValue">Property Value</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.Int32</span></td>
  723. <td>The top item.</td>
  724. </tr>
  725. </tbody>
  726. </table>
  727. <h3 id="methods">Methods
  728. </h3>
  729. <a id="Terminal_Gui_ListView_AllowsAll_" data-uid="Terminal.Gui.ListView.AllowsAll*"></a>
  730. <h4 id="Terminal_Gui_ListView_AllowsAll" data-uid="Terminal.Gui.ListView.AllowsAll">AllowsAll()</h4>
  731. <div class="markdown level1 summary">
  732. Prevents marking if it&apos;s not allowed mark and if it&apos;s not allows multiple selection.
  733. </div>
  734. <div class="markdown level1 conceptual"></div>
  735. <h5 class="decalaration">Declaration</h5>
  736. <div class="codewrapper">
  737. <pre><code class="lang-csharp hljs">public virtual bool AllowsAll()</code></pre>
  738. </div>
  739. <h5 class="returns">Returns</h5>
  740. <table class="table table-bordered table-striped table-condensed">
  741. <thead>
  742. <tr>
  743. <th>Type</th>
  744. <th>Description</th>
  745. </tr>
  746. </thead>
  747. <tbody>
  748. <tr>
  749. <td><span class="xref">System.Boolean</span></td>
  750. <td></td>
  751. </tr>
  752. </tbody>
  753. </table>
  754. <a id="Terminal_Gui_ListView_MarkUnmarkRow_" data-uid="Terminal.Gui.ListView.MarkUnmarkRow*"></a>
  755. <h4 id="Terminal_Gui_ListView_MarkUnmarkRow" data-uid="Terminal.Gui.ListView.MarkUnmarkRow">MarkUnmarkRow()</h4>
  756. <div class="markdown level1 summary">
  757. Marks an unmarked row.
  758. </div>
  759. <div class="markdown level1 conceptual"></div>
  760. <h5 class="decalaration">Declaration</h5>
  761. <div class="codewrapper">
  762. <pre><code class="lang-csharp hljs">public virtual bool MarkUnmarkRow()</code></pre>
  763. </div>
  764. <h5 class="returns">Returns</h5>
  765. <table class="table table-bordered table-striped table-condensed">
  766. <thead>
  767. <tr>
  768. <th>Type</th>
  769. <th>Description</th>
  770. </tr>
  771. </thead>
  772. <tbody>
  773. <tr>
  774. <td><span class="xref">System.Boolean</span></td>
  775. <td></td>
  776. </tr>
  777. </tbody>
  778. </table>
  779. <a id="Terminal_Gui_ListView_MouseEvent_" data-uid="Terminal.Gui.ListView.MouseEvent*"></a>
  780. <h4 id="Terminal_Gui_ListView_MouseEvent_Terminal_Gui_MouseEvent_" data-uid="Terminal.Gui.ListView.MouseEvent(Terminal.Gui.MouseEvent)">MouseEvent(MouseEvent)</h4>
  781. <div class="markdown level1 summary"></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 override bool MouseEvent(MouseEvent me)</code></pre>
  786. </div>
  787. <h5 class="parameters">Parameters</h5>
  788. <table class="table table-bordered table-striped table-condensed">
  789. <thead>
  790. <tr>
  791. <th>Type</th>
  792. <th>Name</th>
  793. <th>Description</th>
  794. </tr>
  795. </thead>
  796. <tbody>
  797. <tr>
  798. <td><a class="xref" href="Terminal.Gui.MouseEvent.html">MouseEvent</a></td>
  799. <td><span class="parametername">me</span></td>
  800. <td></td>
  801. </tr>
  802. </tbody>
  803. </table>
  804. <h5 class="returns">Returns</h5>
  805. <table class="table table-bordered table-striped table-condensed">
  806. <thead>
  807. <tr>
  808. <th>Type</th>
  809. <th>Description</th>
  810. </tr>
  811. </thead>
  812. <tbody>
  813. <tr>
  814. <td><span class="xref">System.Boolean</span></td>
  815. <td></td>
  816. </tr>
  817. </tbody>
  818. </table>
  819. <h5 class="overrides">Overrides</h5>
  820. <div><a class="xref" href="Terminal.Gui.Responder.html#Terminal_Gui_Responder_MouseEvent_Terminal_Gui_MouseEvent_">Responder.MouseEvent(MouseEvent)</a></div>
  821. <a id="Terminal_Gui_ListView_MoveDown_" data-uid="Terminal.Gui.ListView.MoveDown*"></a>
  822. <h4 id="Terminal_Gui_ListView_MoveDown" data-uid="Terminal.Gui.ListView.MoveDown">MoveDown()</h4>
  823. <div class="markdown level1 summary">
  824. Moves the selected item index to the next row.
  825. </div>
  826. <div class="markdown level1 conceptual"></div>
  827. <h5 class="decalaration">Declaration</h5>
  828. <div class="codewrapper">
  829. <pre><code class="lang-csharp hljs">public virtual bool MoveDown()</code></pre>
  830. </div>
  831. <h5 class="returns">Returns</h5>
  832. <table class="table table-bordered table-striped table-condensed">
  833. <thead>
  834. <tr>
  835. <th>Type</th>
  836. <th>Description</th>
  837. </tr>
  838. </thead>
  839. <tbody>
  840. <tr>
  841. <td><span class="xref">System.Boolean</span></td>
  842. <td></td>
  843. </tr>
  844. </tbody>
  845. </table>
  846. <a id="Terminal_Gui_ListView_MoveEnd_" data-uid="Terminal.Gui.ListView.MoveEnd*"></a>
  847. <h4 id="Terminal_Gui_ListView_MoveEnd" data-uid="Terminal.Gui.ListView.MoveEnd">MoveEnd()</h4>
  848. <div class="markdown level1 summary">
  849. Moves the selected item index to the last row.
  850. </div>
  851. <div class="markdown level1 conceptual"></div>
  852. <h5 class="decalaration">Declaration</h5>
  853. <div class="codewrapper">
  854. <pre><code class="lang-csharp hljs">public virtual bool MoveEnd()</code></pre>
  855. </div>
  856. <h5 class="returns">Returns</h5>
  857. <table class="table table-bordered table-striped table-condensed">
  858. <thead>
  859. <tr>
  860. <th>Type</th>
  861. <th>Description</th>
  862. </tr>
  863. </thead>
  864. <tbody>
  865. <tr>
  866. <td><span class="xref">System.Boolean</span></td>
  867. <td></td>
  868. </tr>
  869. </tbody>
  870. </table>
  871. <a id="Terminal_Gui_ListView_MoveHome_" data-uid="Terminal.Gui.ListView.MoveHome*"></a>
  872. <h4 id="Terminal_Gui_ListView_MoveHome" data-uid="Terminal.Gui.ListView.MoveHome">MoveHome()</h4>
  873. <div class="markdown level1 summary">
  874. Moves the selected item index to the first row.
  875. </div>
  876. <div class="markdown level1 conceptual"></div>
  877. <h5 class="decalaration">Declaration</h5>
  878. <div class="codewrapper">
  879. <pre><code class="lang-csharp hljs">public virtual bool MoveHome()</code></pre>
  880. </div>
  881. <h5 class="returns">Returns</h5>
  882. <table class="table table-bordered table-striped table-condensed">
  883. <thead>
  884. <tr>
  885. <th>Type</th>
  886. <th>Description</th>
  887. </tr>
  888. </thead>
  889. <tbody>
  890. <tr>
  891. <td><span class="xref">System.Boolean</span></td>
  892. <td></td>
  893. </tr>
  894. </tbody>
  895. </table>
  896. <a id="Terminal_Gui_ListView_MovePageDown_" data-uid="Terminal.Gui.ListView.MovePageDown*"></a>
  897. <h4 id="Terminal_Gui_ListView_MovePageDown" data-uid="Terminal.Gui.ListView.MovePageDown">MovePageDown()</h4>
  898. <div class="markdown level1 summary">
  899. Moves the selected item index to the previous page.
  900. </div>
  901. <div class="markdown level1 conceptual"></div>
  902. <h5 class="decalaration">Declaration</h5>
  903. <div class="codewrapper">
  904. <pre><code class="lang-csharp hljs">public virtual bool MovePageDown()</code></pre>
  905. </div>
  906. <h5 class="returns">Returns</h5>
  907. <table class="table table-bordered table-striped table-condensed">
  908. <thead>
  909. <tr>
  910. <th>Type</th>
  911. <th>Description</th>
  912. </tr>
  913. </thead>
  914. <tbody>
  915. <tr>
  916. <td><span class="xref">System.Boolean</span></td>
  917. <td></td>
  918. </tr>
  919. </tbody>
  920. </table>
  921. <a id="Terminal_Gui_ListView_MovePageUp_" data-uid="Terminal.Gui.ListView.MovePageUp*"></a>
  922. <h4 id="Terminal_Gui_ListView_MovePageUp" data-uid="Terminal.Gui.ListView.MovePageUp">MovePageUp()</h4>
  923. <div class="markdown level1 summary">
  924. Moves the selected item index to the next page.
  925. </div>
  926. <div class="markdown level1 conceptual"></div>
  927. <h5 class="decalaration">Declaration</h5>
  928. <div class="codewrapper">
  929. <pre><code class="lang-csharp hljs">public virtual bool MovePageUp()</code></pre>
  930. </div>
  931. <h5 class="returns">Returns</h5>
  932. <table class="table table-bordered table-striped table-condensed">
  933. <thead>
  934. <tr>
  935. <th>Type</th>
  936. <th>Description</th>
  937. </tr>
  938. </thead>
  939. <tbody>
  940. <tr>
  941. <td><span class="xref">System.Boolean</span></td>
  942. <td></td>
  943. </tr>
  944. </tbody>
  945. </table>
  946. <a id="Terminal_Gui_ListView_MoveUp_" data-uid="Terminal.Gui.ListView.MoveUp*"></a>
  947. <h4 id="Terminal_Gui_ListView_MoveUp" data-uid="Terminal.Gui.ListView.MoveUp">MoveUp()</h4>
  948. <div class="markdown level1 summary">
  949. Moves the selected item index to the previous row.
  950. </div>
  951. <div class="markdown level1 conceptual"></div>
  952. <h5 class="decalaration">Declaration</h5>
  953. <div class="codewrapper">
  954. <pre><code class="lang-csharp hljs">public virtual bool MoveUp()</code></pre>
  955. </div>
  956. <h5 class="returns">Returns</h5>
  957. <table class="table table-bordered table-striped table-condensed">
  958. <thead>
  959. <tr>
  960. <th>Type</th>
  961. <th>Description</th>
  962. </tr>
  963. </thead>
  964. <tbody>
  965. <tr>
  966. <td><span class="xref">System.Boolean</span></td>
  967. <td></td>
  968. </tr>
  969. </tbody>
  970. </table>
  971. <a id="Terminal_Gui_ListView_OnEnter_" data-uid="Terminal.Gui.ListView.OnEnter*"></a>
  972. <h4 id="Terminal_Gui_ListView_OnEnter_Terminal_Gui_View_" data-uid="Terminal.Gui.ListView.OnEnter(Terminal.Gui.View)">OnEnter(View)</h4>
  973. <div class="markdown level1 summary"></div>
  974. <div class="markdown level1 conceptual"></div>
  975. <h5 class="decalaration">Declaration</h5>
  976. <div class="codewrapper">
  977. <pre><code class="lang-csharp hljs">public override bool OnEnter(View view)</code></pre>
  978. </div>
  979. <h5 class="parameters">Parameters</h5>
  980. <table class="table table-bordered table-striped table-condensed">
  981. <thead>
  982. <tr>
  983. <th>Type</th>
  984. <th>Name</th>
  985. <th>Description</th>
  986. </tr>
  987. </thead>
  988. <tbody>
  989. <tr>
  990. <td><a class="xref" href="Terminal.Gui.View.html">View</a></td>
  991. <td><span class="parametername">view</span></td>
  992. <td></td>
  993. </tr>
  994. </tbody>
  995. </table>
  996. <h5 class="returns">Returns</h5>
  997. <table class="table table-bordered table-striped table-condensed">
  998. <thead>
  999. <tr>
  1000. <th>Type</th>
  1001. <th>Description</th>
  1002. </tr>
  1003. </thead>
  1004. <tbody>
  1005. <tr>
  1006. <td><span class="xref">System.Boolean</span></td>
  1007. <td></td>
  1008. </tr>
  1009. </tbody>
  1010. </table>
  1011. <h5 class="overrides">Overrides</h5>
  1012. <div><a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnEnter_Terminal_Gui_View_">View.OnEnter(View)</a></div>
  1013. <a id="Terminal_Gui_ListView_OnMouseEnter_" data-uid="Terminal.Gui.ListView.OnMouseEnter*"></a>
  1014. <h4 id="Terminal_Gui_ListView_OnMouseEnter_Terminal_Gui_MouseEvent_" data-uid="Terminal.Gui.ListView.OnMouseEnter(Terminal.Gui.MouseEvent)">OnMouseEnter(MouseEvent)</h4>
  1015. <div class="markdown level1 summary"></div>
  1016. <div class="markdown level1 conceptual"></div>
  1017. <h5 class="decalaration">Declaration</h5>
  1018. <div class="codewrapper">
  1019. <pre><code class="lang-csharp hljs">public override bool OnMouseEnter(MouseEvent mouseEvent)</code></pre>
  1020. </div>
  1021. <h5 class="parameters">Parameters</h5>
  1022. <table class="table table-bordered table-striped table-condensed">
  1023. <thead>
  1024. <tr>
  1025. <th>Type</th>
  1026. <th>Name</th>
  1027. <th>Description</th>
  1028. </tr>
  1029. </thead>
  1030. <tbody>
  1031. <tr>
  1032. <td><a class="xref" href="Terminal.Gui.MouseEvent.html">MouseEvent</a></td>
  1033. <td><span class="parametername">mouseEvent</span></td>
  1034. <td></td>
  1035. </tr>
  1036. </tbody>
  1037. </table>
  1038. <h5 class="returns">Returns</h5>
  1039. <table class="table table-bordered table-striped table-condensed">
  1040. <thead>
  1041. <tr>
  1042. <th>Type</th>
  1043. <th>Description</th>
  1044. </tr>
  1045. </thead>
  1046. <tbody>
  1047. <tr>
  1048. <td><span class="xref">System.Boolean</span></td>
  1049. <td></td>
  1050. </tr>
  1051. </tbody>
  1052. </table>
  1053. <h5 class="overrides">Overrides</h5>
  1054. <div><a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnMouseEnter_Terminal_Gui_MouseEvent_">View.OnMouseEnter(MouseEvent)</a></div>
  1055. <a id="Terminal_Gui_ListView_OnOpenSelectedItem_" data-uid="Terminal.Gui.ListView.OnOpenSelectedItem*"></a>
  1056. <h4 id="Terminal_Gui_ListView_OnOpenSelectedItem" data-uid="Terminal.Gui.ListView.OnOpenSelectedItem">OnOpenSelectedItem()</h4>
  1057. <div class="markdown level1 summary">
  1058. Invokes the OnOpenSelectedItem event if it is defined.
  1059. </div>
  1060. <div class="markdown level1 conceptual"></div>
  1061. <h5 class="decalaration">Declaration</h5>
  1062. <div class="codewrapper">
  1063. <pre><code class="lang-csharp hljs">public virtual bool OnOpenSelectedItem()</code></pre>
  1064. </div>
  1065. <h5 class="returns">Returns</h5>
  1066. <table class="table table-bordered table-striped table-condensed">
  1067. <thead>
  1068. <tr>
  1069. <th>Type</th>
  1070. <th>Description</th>
  1071. </tr>
  1072. </thead>
  1073. <tbody>
  1074. <tr>
  1075. <td><span class="xref">System.Boolean</span></td>
  1076. <td></td>
  1077. </tr>
  1078. </tbody>
  1079. </table>
  1080. <a id="Terminal_Gui_ListView_OnSelectedChanged_" data-uid="Terminal.Gui.ListView.OnSelectedChanged*"></a>
  1081. <h4 id="Terminal_Gui_ListView_OnSelectedChanged" data-uid="Terminal.Gui.ListView.OnSelectedChanged">OnSelectedChanged()</h4>
  1082. <div class="markdown level1 summary">
  1083. Invokes the SelectedChanged event if it is defined.
  1084. </div>
  1085. <div class="markdown level1 conceptual"></div>
  1086. <h5 class="decalaration">Declaration</h5>
  1087. <div class="codewrapper">
  1088. <pre><code class="lang-csharp hljs">public virtual bool OnSelectedChanged()</code></pre>
  1089. </div>
  1090. <h5 class="returns">Returns</h5>
  1091. <table class="table table-bordered table-striped table-condensed">
  1092. <thead>
  1093. <tr>
  1094. <th>Type</th>
  1095. <th>Description</th>
  1096. </tr>
  1097. </thead>
  1098. <tbody>
  1099. <tr>
  1100. <td><span class="xref">System.Boolean</span></td>
  1101. <td></td>
  1102. </tr>
  1103. </tbody>
  1104. </table>
  1105. <a id="Terminal_Gui_ListView_PositionCursor_" data-uid="Terminal.Gui.ListView.PositionCursor*"></a>
  1106. <h4 id="Terminal_Gui_ListView_PositionCursor" data-uid="Terminal.Gui.ListView.PositionCursor">PositionCursor()</h4>
  1107. <div class="markdown level1 summary"></div>
  1108. <div class="markdown level1 conceptual"></div>
  1109. <h5 class="decalaration">Declaration</h5>
  1110. <div class="codewrapper">
  1111. <pre><code class="lang-csharp hljs">public override void PositionCursor()</code></pre>
  1112. </div>
  1113. <h5 class="overrides">Overrides</h5>
  1114. <div><a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_PositionCursor">View.PositionCursor()</a></div>
  1115. <a id="Terminal_Gui_ListView_ProcessKey_" data-uid="Terminal.Gui.ListView.ProcessKey*"></a>
  1116. <h4 id="Terminal_Gui_ListView_ProcessKey_Terminal_Gui_KeyEvent_" data-uid="Terminal.Gui.ListView.ProcessKey(Terminal.Gui.KeyEvent)">ProcessKey(KeyEvent)</h4>
  1117. <div class="markdown level1 summary"></div>
  1118. <div class="markdown level1 conceptual"></div>
  1119. <h5 class="decalaration">Declaration</h5>
  1120. <div class="codewrapper">
  1121. <pre><code class="lang-csharp hljs">public override bool ProcessKey(KeyEvent kb)</code></pre>
  1122. </div>
  1123. <h5 class="parameters">Parameters</h5>
  1124. <table class="table table-bordered table-striped table-condensed">
  1125. <thead>
  1126. <tr>
  1127. <th>Type</th>
  1128. <th>Name</th>
  1129. <th>Description</th>
  1130. </tr>
  1131. </thead>
  1132. <tbody>
  1133. <tr>
  1134. <td><a class="xref" href="Terminal.Gui.KeyEvent.html">KeyEvent</a></td>
  1135. <td><span class="parametername">kb</span></td>
  1136. <td></td>
  1137. </tr>
  1138. </tbody>
  1139. </table>
  1140. <h5 class="returns">Returns</h5>
  1141. <table class="table table-bordered table-striped table-condensed">
  1142. <thead>
  1143. <tr>
  1144. <th>Type</th>
  1145. <th>Description</th>
  1146. </tr>
  1147. </thead>
  1148. <tbody>
  1149. <tr>
  1150. <td><span class="xref">System.Boolean</span></td>
  1151. <td></td>
  1152. </tr>
  1153. </tbody>
  1154. </table>
  1155. <h5 class="overrides">Overrides</h5>
  1156. <div><a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ProcessKey_Terminal_Gui_KeyEvent_">View.ProcessKey(KeyEvent)</a></div>
  1157. <a id="Terminal_Gui_ListView_Redraw_" data-uid="Terminal.Gui.ListView.Redraw*"></a>
  1158. <h4 id="Terminal_Gui_ListView_Redraw_Terminal_Gui_Rect_" data-uid="Terminal.Gui.ListView.Redraw(Terminal.Gui.Rect)">Redraw(Rect)</h4>
  1159. <div class="markdown level1 summary"></div>
  1160. <div class="markdown level1 conceptual"></div>
  1161. <h5 class="decalaration">Declaration</h5>
  1162. <div class="codewrapper">
  1163. <pre><code class="lang-csharp hljs">public override void Redraw(Rect bounds)</code></pre>
  1164. </div>
  1165. <h5 class="parameters">Parameters</h5>
  1166. <table class="table table-bordered table-striped table-condensed">
  1167. <thead>
  1168. <tr>
  1169. <th>Type</th>
  1170. <th>Name</th>
  1171. <th>Description</th>
  1172. </tr>
  1173. </thead>
  1174. <tbody>
  1175. <tr>
  1176. <td><a class="xref" href="Terminal.Gui.Rect.html">Rect</a></td>
  1177. <td><span class="parametername">bounds</span></td>
  1178. <td></td>
  1179. </tr>
  1180. </tbody>
  1181. </table>
  1182. <h5 class="overrides">Overrides</h5>
  1183. <div><a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Redraw_Terminal_Gui_Rect_">View.Redraw(Rect)</a></div>
  1184. <a id="Terminal_Gui_ListView_SetSource_" data-uid="Terminal.Gui.ListView.SetSource*"></a>
  1185. <h4 id="Terminal_Gui_ListView_SetSource_System_Collections_IList_" data-uid="Terminal.Gui.ListView.SetSource(System.Collections.IList)">SetSource(IList)</h4>
  1186. <div class="markdown level1 summary">
  1187. Sets the source of the <a class="xref" href="Terminal.Gui.ListView.html">ListView</a> to an <span class="xref">System.Collections.IList</span>.
  1188. </div>
  1189. <div class="markdown level1 conceptual"></div>
  1190. <h5 class="decalaration">Declaration</h5>
  1191. <div class="codewrapper">
  1192. <pre><code class="lang-csharp hljs">public void SetSource(IList source)</code></pre>
  1193. </div>
  1194. <h5 class="parameters">Parameters</h5>
  1195. <table class="table table-bordered table-striped table-condensed">
  1196. <thead>
  1197. <tr>
  1198. <th>Type</th>
  1199. <th>Name</th>
  1200. <th>Description</th>
  1201. </tr>
  1202. </thead>
  1203. <tbody>
  1204. <tr>
  1205. <td><span class="xref">System.Collections.IList</span></td>
  1206. <td><span class="parametername">source</span></td>
  1207. <td></td>
  1208. </tr>
  1209. </tbody>
  1210. </table>
  1211. <h5 id="Terminal_Gui_ListView_SetSource_System_Collections_IList__remarks">Remarks</h5>
  1212. <div class="markdown level1 remarks">
  1213. 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.
  1214. </div>
  1215. <a id="Terminal_Gui_ListView_SetSourceAsync_" data-uid="Terminal.Gui.ListView.SetSourceAsync*"></a>
  1216. <h4 id="Terminal_Gui_ListView_SetSourceAsync_System_Collections_IList_" data-uid="Terminal.Gui.ListView.SetSourceAsync(System.Collections.IList)">SetSourceAsync(IList)</h4>
  1217. <div class="markdown level1 summary">
  1218. Sets the source to an <span class="xref">System.Collections.IList</span> value asynchronously.
  1219. </div>
  1220. <div class="markdown level1 conceptual"></div>
  1221. <h5 class="decalaration">Declaration</h5>
  1222. <div class="codewrapper">
  1223. <pre><code class="lang-csharp hljs">public Task SetSourceAsync(IList source)</code></pre>
  1224. </div>
  1225. <h5 class="parameters">Parameters</h5>
  1226. <table class="table table-bordered table-striped table-condensed">
  1227. <thead>
  1228. <tr>
  1229. <th>Type</th>
  1230. <th>Name</th>
  1231. <th>Description</th>
  1232. </tr>
  1233. </thead>
  1234. <tbody>
  1235. <tr>
  1236. <td><span class="xref">System.Collections.IList</span></td>
  1237. <td><span class="parametername">source</span></td>
  1238. <td></td>
  1239. </tr>
  1240. </tbody>
  1241. </table>
  1242. <h5 class="returns">Returns</h5>
  1243. <table class="table table-bordered table-striped table-condensed">
  1244. <thead>
  1245. <tr>
  1246. <th>Type</th>
  1247. <th>Description</th>
  1248. </tr>
  1249. </thead>
  1250. <tbody>
  1251. <tr>
  1252. <td><span class="xref">System.Threading.Tasks.Task</span></td>
  1253. <td>An item implementing the IList interface.</td>
  1254. </tr>
  1255. </tbody>
  1256. </table>
  1257. <h5 id="Terminal_Gui_ListView_SetSourceAsync_System_Collections_IList__remarks">Remarks</h5>
  1258. <div class="markdown level1 remarks">
  1259. 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.
  1260. </div>
  1261. <h3 id="implements">Implements</h3>
  1262. <div>
  1263. <span class="xref">System.IDisposable</span>
  1264. </div>
  1265. <div>
  1266. <span class="xref">System.Collections.IEnumerable</span>
  1267. </div>
  1268. <div>
  1269. <span class="xref">System.ComponentModel.ISupportInitializeNotification</span>
  1270. </div>
  1271. <div>
  1272. <span class="xref">System.ComponentModel.ISupportInitialize</span>
  1273. </div>
  1274. </article>
  1275. </div>
  1276. <div class="hidden-sm col-md-2" role="complementary">
  1277. <div class="sideaffix">
  1278. <div class="contribution">
  1279. <ul class="nav">
  1280. </ul>
  1281. </div>
  1282. <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
  1283. <!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
  1284. </nav>
  1285. </div>
  1286. </div>
  1287. </div>
  1288. </div>
  1289. <footer>
  1290. <div class="grad-bottom"></div>
  1291. <div class="footer">
  1292. <div class="container">
  1293. <span class="pull-right">
  1294. <a href="#top">Back to top</a>
  1295. </span>
  1296. <span>Generated by <strong>DocFX</strong></span>
  1297. </div>
  1298. </div>
  1299. </footer>
  1300. </div>
  1301. <script type="text/javascript" src="../../styles/docfx.vendor.js"></script>
  1302. <script type="text/javascript" src="../../styles/docfx.js"></script>
  1303. <script type="text/javascript" src="../../styles/main.js"></script>
  1304. </body>
  1305. </html>