Terminal.Gui.TreeView-1.html 79 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048
  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 TreeView&lt;T&gt;
  8. </title>
  9. <meta name="viewport" content="width=device-width">
  10. <meta name="title" content="Class TreeView&lt;T&gt;
  11. ">
  12. <meta name="generator" content="docfx 2.56.7.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">Search Results for <span></span></div>
  57. <div class="sr-items">
  58. <p><i class="glyphicon glyphicon-refresh index-loading"></i></p>
  59. </div>
  60. <ul id="pagination" data-first="First" data-prev="Previous" data-next="Next" data-last="Last"></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.TreeView`1">
  73. <h1 id="Terminal_Gui_TreeView_1" data-uid="Terminal.Gui.TreeView`1" class="text-break">Class TreeView&lt;T&gt;
  74. </h1>
  75. <div class="markdown level0 summary">
  76. Hierarchical tree view with expandable branches. Branch objects are dynamically determined
  77. when expanded using a user defined <a class="xref" href="Terminal.Gui.ITreeBuilder-1.html">ITreeBuilder&lt;T&gt;</a>
  78. </div>
  79. <div class="markdown level0 conceptual"></div>
  80. <div class="inheritance">
  81. <h5>Inheritance</h5>
  82. <div class="level0"><span class="xref">System.Object</span></div>
  83. <div class="level1"><a class="xref" href="Terminal.Gui.Responder.html">Responder</a></div>
  84. <div class="level2"><a class="xref" href="Terminal.Gui.View.html">View</a></div>
  85. <div class="level3"><span class="xref">TreeView&lt;T&gt;</span></div>
  86. <div class="level4"><a class="xref" href="Terminal.Gui.TreeView.html">TreeView</a></div>
  87. </div>
  88. <div classs="implements">
  89. <h5>Implements</h5>
  90. <div><span class="xref">System.IDisposable</span></div>
  91. <div><span class="xref">System.ComponentModel.ISupportInitializeNotification</span></div>
  92. <div><span class="xref">System.ComponentModel.ISupportInitialize</span></div>
  93. <div><a class="xref" href="Terminal.Gui.ITreeView.html">ITreeView</a></div>
  94. </div>
  95. <div class="inheritedMembers">
  96. <h5>Inherited Members</h5>
  97. <div>
  98. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Added">View.Added</a>
  99. </div>
  100. <div>
  101. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Removed">View.Removed</a>
  102. </div>
  103. <div>
  104. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Enter">View.Enter</a>
  105. </div>
  106. <div>
  107. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Leave">View.Leave</a>
  108. </div>
  109. <div>
  110. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_MouseEnter">View.MouseEnter</a>
  111. </div>
  112. <div>
  113. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_MouseLeave">View.MouseLeave</a>
  114. </div>
  115. <div>
  116. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_MouseClick">View.MouseClick</a>
  117. </div>
  118. <div>
  119. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_HotKey">View.HotKey</a>
  120. </div>
  121. <div>
  122. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_HotKeySpecifier">View.HotKeySpecifier</a>
  123. </div>
  124. <div>
  125. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Shortcut">View.Shortcut</a>
  126. </div>
  127. <div>
  128. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ShortcutTag">View.ShortcutTag</a>
  129. </div>
  130. <div>
  131. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ShortcutAction">View.ShortcutAction</a>
  132. </div>
  133. <div>
  134. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Data">View.Data</a>
  135. </div>
  136. <div>
  137. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Driver">View.Driver</a>
  138. </div>
  139. <div>
  140. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Subviews">View.Subviews</a>
  141. </div>
  142. <div>
  143. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_TabIndexes">View.TabIndexes</a>
  144. </div>
  145. <div>
  146. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_TabIndex">View.TabIndex</a>
  147. </div>
  148. <div>
  149. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_TabStop">View.TabStop</a>
  150. </div>
  151. <div>
  152. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_CanFocus">View.CanFocus</a>
  153. </div>
  154. <div>
  155. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Id">View.Id</a>
  156. </div>
  157. <div>
  158. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_IsCurrentTop">View.IsCurrentTop</a>
  159. </div>
  160. <div>
  161. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_WantMousePositionReports">View.WantMousePositionReports</a>
  162. </div>
  163. <div>
  164. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_WantContinuousButtonPressed">View.WantContinuousButtonPressed</a>
  165. </div>
  166. <div>
  167. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Frame">View.Frame</a>
  168. </div>
  169. <div>
  170. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_LayoutStyle">View.LayoutStyle</a>
  171. </div>
  172. <div>
  173. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Bounds">View.Bounds</a>
  174. </div>
  175. <div>
  176. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_X">View.X</a>
  177. </div>
  178. <div>
  179. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Y">View.Y</a>
  180. </div>
  181. <div>
  182. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Width">View.Width</a>
  183. </div>
  184. <div>
  185. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Height">View.Height</a>
  186. </div>
  187. <div>
  188. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SuperView">View.SuperView</a>
  189. </div>
  190. <div>
  191. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SetNeedsDisplay">View.SetNeedsDisplay()</a>
  192. </div>
  193. <div>
  194. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ClearLayoutNeeded">View.ClearLayoutNeeded()</a>
  195. </div>
  196. <div>
  197. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SetNeedsDisplay_Terminal_Gui_Rect_">View.SetNeedsDisplay(Rect)</a>
  198. </div>
  199. <div>
  200. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SetChildNeedsDisplay">View.SetChildNeedsDisplay()</a>
  201. </div>
  202. <div>
  203. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Add_Terminal_Gui_View_">View.Add(View)</a>
  204. </div>
  205. <div>
  206. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Add_Terminal_Gui_View___">View.Add(View[])</a>
  207. </div>
  208. <div>
  209. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_RemoveAll">View.RemoveAll()</a>
  210. </div>
  211. <div>
  212. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Remove_Terminal_Gui_View_">View.Remove(View)</a>
  213. </div>
  214. <div>
  215. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_BringSubviewToFront_Terminal_Gui_View_">View.BringSubviewToFront(View)</a>
  216. </div>
  217. <div>
  218. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SendSubviewToBack_Terminal_Gui_View_">View.SendSubviewToBack(View)</a>
  219. </div>
  220. <div>
  221. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SendSubviewBackwards_Terminal_Gui_View_">View.SendSubviewBackwards(View)</a>
  222. </div>
  223. <div>
  224. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_BringSubviewForward_Terminal_Gui_View_">View.BringSubviewForward(View)</a>
  225. </div>
  226. <div>
  227. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Clear">View.Clear()</a>
  228. </div>
  229. <div>
  230. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Clear_Terminal_Gui_Rect_">View.Clear(Rect)</a>
  231. </div>
  232. <div>
  233. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ScreenToView_System_Int32_System_Int32_">View.ScreenToView(Int32, Int32)</a>
  234. </div>
  235. <div>
  236. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ClipToBounds">View.ClipToBounds()</a>
  237. </div>
  238. <div>
  239. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SetClip_Terminal_Gui_Rect_">View.SetClip(Rect)</a>
  240. </div>
  241. <div>
  242. <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>
  243. </div>
  244. <div>
  245. <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>
  246. </div>
  247. <div>
  248. <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>
  249. </div>
  250. <div>
  251. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Move_System_Int32_System_Int32_">View.Move(Int32, Int32)</a>
  252. </div>
  253. <div>
  254. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_HasFocus">View.HasFocus</a>
  255. </div>
  256. <div>
  257. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnAdded_Terminal_Gui_View_">View.OnAdded(View)</a>
  258. </div>
  259. <div>
  260. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnRemoved_Terminal_Gui_View_">View.OnRemoved(View)</a>
  261. </div>
  262. <div>
  263. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnEnter_Terminal_Gui_View_">View.OnEnter(View)</a>
  264. </div>
  265. <div>
  266. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnLeave_Terminal_Gui_View_">View.OnLeave(View)</a>
  267. </div>
  268. <div>
  269. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Focused">View.Focused</a>
  270. </div>
  271. <div>
  272. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_MostFocused">View.MostFocused</a>
  273. </div>
  274. <div>
  275. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ColorScheme">View.ColorScheme</a>
  276. </div>
  277. <div>
  278. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_AddRune_System_Int32_System_Int32_System_Rune_">View.AddRune(Int32, Int32, Rune)</a>
  279. </div>
  280. <div>
  281. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ClearNeedsDisplay">View.ClearNeedsDisplay()</a>
  282. </div>
  283. <div>
  284. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_DrawContent">View.DrawContent</a>
  285. </div>
  286. <div>
  287. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnDrawContent_Terminal_Gui_Rect_">View.OnDrawContent(Rect)</a>
  288. </div>
  289. <div>
  290. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SetFocus">View.SetFocus()</a>
  291. </div>
  292. <div>
  293. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_KeyPress">View.KeyPress</a>
  294. </div>
  295. <div>
  296. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ProcessHotKey_Terminal_Gui_KeyEvent_">View.ProcessHotKey(KeyEvent)</a>
  297. </div>
  298. <div>
  299. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ProcessColdKey_Terminal_Gui_KeyEvent_">View.ProcessColdKey(KeyEvent)</a>
  300. </div>
  301. <div>
  302. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_KeyDown">View.KeyDown</a>
  303. </div>
  304. <div>
  305. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnKeyDown_Terminal_Gui_KeyEvent_">View.OnKeyDown(KeyEvent)</a>
  306. </div>
  307. <div>
  308. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_KeyUp">View.KeyUp</a>
  309. </div>
  310. <div>
  311. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnKeyUp_Terminal_Gui_KeyEvent_">View.OnKeyUp(KeyEvent)</a>
  312. </div>
  313. <div>
  314. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_EnsureFocus">View.EnsureFocus()</a>
  315. </div>
  316. <div>
  317. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_FocusFirst">View.FocusFirst()</a>
  318. </div>
  319. <div>
  320. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_FocusLast">View.FocusLast()</a>
  321. </div>
  322. <div>
  323. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_FocusPrev">View.FocusPrev()</a>
  324. </div>
  325. <div>
  326. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_FocusNext">View.FocusNext()</a>
  327. </div>
  328. <div>
  329. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_LayoutStarted">View.LayoutStarted</a>
  330. </div>
  331. <div>
  332. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_LayoutComplete">View.LayoutComplete</a>
  333. </div>
  334. <div>
  335. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Initialized">View.Initialized</a>
  336. </div>
  337. <div>
  338. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_LayoutSubviews">View.LayoutSubviews()</a>
  339. </div>
  340. <div>
  341. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Text">View.Text</a>
  342. </div>
  343. <div>
  344. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_AutoSize">View.AutoSize</a>
  345. </div>
  346. <div>
  347. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_TextAlignment">View.TextAlignment</a>
  348. </div>
  349. <div>
  350. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_IsInitialized">View.IsInitialized</a>
  351. </div>
  352. <div>
  353. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ToString">View.ToString()</a>
  354. </div>
  355. <div>
  356. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnMouseEnter_Terminal_Gui_MouseEvent_">View.OnMouseEnter(MouseEvent)</a>
  357. </div>
  358. <div>
  359. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnMouseLeave_Terminal_Gui_MouseEvent_">View.OnMouseLeave(MouseEvent)</a>
  360. </div>
  361. <div>
  362. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnMouseEvent_Terminal_Gui_MouseEvent_">View.OnMouseEvent(MouseEvent)</a>
  363. </div>
  364. <div>
  365. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnMouseClick_Terminal_Gui_View_MouseEventArgs_">View.OnMouseClick(View.MouseEventArgs)</a>
  366. </div>
  367. <div>
  368. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Dispose_System_Boolean_">View.Dispose(Boolean)</a>
  369. </div>
  370. <div>
  371. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_BeginInit">View.BeginInit()</a>
  372. </div>
  373. <div>
  374. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_EndInit">View.EndInit()</a>
  375. </div>
  376. <div>
  377. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Visible">View.Visible</a>
  378. </div>
  379. <div>
  380. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SetWidth_System_Int32_System_Int32__">View.SetWidth(Int32, Int32)</a>
  381. </div>
  382. <div>
  383. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SetHeight_System_Int32_System_Int32__">View.SetHeight(Int32, Int32)</a>
  384. </div>
  385. <div>
  386. <a class="xref" href="Terminal.Gui.Responder.html#Terminal_Gui_Responder_Dispose">Responder.Dispose()</a>
  387. </div>
  388. <div>
  389. <span class="xref">System.Object.Equals(System.Object)</span>
  390. </div>
  391. <div>
  392. <span class="xref">System.Object.Equals(System.Object, System.Object)</span>
  393. </div>
  394. <div>
  395. <span class="xref">System.Object.GetHashCode()</span>
  396. </div>
  397. <div>
  398. <span class="xref">System.Object.GetType()</span>
  399. </div>
  400. <div>
  401. <span class="xref">System.Object.MemberwiseClone()</span>
  402. </div>
  403. <div>
  404. <span class="xref">System.Object.ReferenceEquals(System.Object, System.Object)</span>
  405. </div>
  406. </div>
  407. <h6><strong>Namespace</strong>: <a class="xref" href="Terminal.Gui.html">Terminal.Gui</a></h6>
  408. <h6><strong>Assembly</strong>: Terminal.Gui.dll</h6>
  409. <h5 id="Terminal_Gui_TreeView_1_syntax">Syntax</h5>
  410. <div class="codewrapper">
  411. <pre><code class="lang-csharp hljs">public class TreeView&lt;T&gt; : View, IDisposable, ISupportInitializeNotification, ISupportInitialize, ITreeView where T : class</code></pre>
  412. </div>
  413. <h5 class="typeParameters">Type Parameters</h5>
  414. <table class="table table-bordered table-striped table-condensed">
  415. <thead>
  416. <tr>
  417. <th>Name</th>
  418. <th>Description</th>
  419. </tr>
  420. </thead>
  421. <tbody>
  422. <tr>
  423. <td><span class="parametername">T</span></td>
  424. <td></td>
  425. </tr>
  426. </tbody>
  427. </table>
  428. <h3 id="constructors">Constructors
  429. </h3>
  430. <a id="Terminal_Gui_TreeView_1__ctor_" data-uid="Terminal.Gui.TreeView`1.#ctor*"></a>
  431. <h4 id="Terminal_Gui_TreeView_1__ctor" data-uid="Terminal.Gui.TreeView`1.#ctor">TreeView()</h4>
  432. <div class="markdown level1 summary">
  433. Creates a new tree view with absolute positioning.
  434. Use <a class="xref" href="Terminal.Gui.TreeView-1.html#Terminal_Gui_TreeView_1_AddObjects_System_Collections_Generic_IEnumerable__0__">AddObjects(IEnumerable&lt;T&gt;)</a> to set set root objects for the tree.
  435. Children will not be rendered until you set <a class="xref" href="Terminal.Gui.TreeView-1.html#Terminal_Gui_TreeView_1_TreeBuilder">TreeBuilder</a>
  436. </div>
  437. <div class="markdown level1 conceptual"></div>
  438. <h5 class="decalaration">Declaration</h5>
  439. <div class="codewrapper">
  440. <pre><code class="lang-csharp hljs">public TreeView()</code></pre>
  441. </div>
  442. <a id="Terminal_Gui_TreeView_1__ctor_" data-uid="Terminal.Gui.TreeView`1.#ctor*"></a>
  443. <h4 id="Terminal_Gui_TreeView_1__ctor_Terminal_Gui_ITreeBuilder__0__" data-uid="Terminal.Gui.TreeView`1.#ctor(Terminal.Gui.ITreeBuilder{`0})">TreeView(ITreeBuilder&lt;T&gt;)</h4>
  444. <div class="markdown level1 summary">
  445. Initialises <a class="xref" href="Terminal.Gui.TreeView-1.html#Terminal_Gui_TreeView_1_TreeBuilder">TreeBuilder</a>.Creates a new tree view with absolute
  446. positioning. Use <a class="xref" href="Terminal.Gui.TreeView-1.html#Terminal_Gui_TreeView_1_AddObjects_System_Collections_Generic_IEnumerable__0__">AddObjects(IEnumerable&lt;T&gt;)</a> to set set root
  447. objects for the tree.
  448. </div>
  449. <div class="markdown level1 conceptual"></div>
  450. <h5 class="decalaration">Declaration</h5>
  451. <div class="codewrapper">
  452. <pre><code class="lang-csharp hljs">public TreeView(ITreeBuilder&lt;T&gt; builder)</code></pre>
  453. </div>
  454. <h5 class="parameters">Parameters</h5>
  455. <table class="table table-bordered table-striped table-condensed">
  456. <thead>
  457. <tr>
  458. <th>Type</th>
  459. <th>Name</th>
  460. <th>Description</th>
  461. </tr>
  462. </thead>
  463. <tbody>
  464. <tr>
  465. <td><a class="xref" href="Terminal.Gui.ITreeBuilder-1.html">ITreeBuilder</a>&lt;T&gt;</td>
  466. <td><span class="parametername">builder</span></td>
  467. <td></td>
  468. </tr>
  469. </tbody>
  470. </table>
  471. <h3 id="fields">Fields
  472. </h3>
  473. <h4 id="Terminal_Gui_TreeView_1_NoBuilderError" data-uid="Terminal.Gui.TreeView`1.NoBuilderError">NoBuilderError</h4>
  474. <div class="markdown level1 summary">
  475. Error message to display when the control is not properly initialized at draw time
  476. (nodes added but no tree builder set)
  477. </div>
  478. <div class="markdown level1 conceptual"></div>
  479. <h5 class="decalaration">Declaration</h5>
  480. <div class="codewrapper">
  481. <pre><code class="lang-csharp hljs">public static ustring NoBuilderError</code></pre>
  482. </div>
  483. <h5 class="fieldValue">Field Value</h5>
  484. <table class="table table-bordered table-striped table-condensed">
  485. <thead>
  486. <tr>
  487. <th>Type</th>
  488. <th>Description</th>
  489. </tr>
  490. </thead>
  491. <tbody>
  492. <tr>
  493. <td><span class="xref">NStack.ustring</span></td>
  494. <td></td>
  495. </tr>
  496. </tbody>
  497. </table>
  498. <h3 id="properties">Properties
  499. </h3>
  500. <a id="Terminal_Gui_TreeView_1_AllowLetterBasedNavigation_" data-uid="Terminal.Gui.TreeView`1.AllowLetterBasedNavigation*"></a>
  501. <h4 id="Terminal_Gui_TreeView_1_AllowLetterBasedNavigation" data-uid="Terminal.Gui.TreeView`1.AllowLetterBasedNavigation">AllowLetterBasedNavigation</h4>
  502. <div class="markdown level1 summary">
  503. True makes a letter key press navigate to the next visible branch that begins with
  504. that letter/digit
  505. </div>
  506. <div class="markdown level1 conceptual"></div>
  507. <h5 class="decalaration">Declaration</h5>
  508. <div class="codewrapper">
  509. <pre><code class="lang-csharp hljs">public bool AllowLetterBasedNavigation { get; set; }</code></pre>
  510. </div>
  511. <h5 class="propertyValue">Property Value</h5>
  512. <table class="table table-bordered table-striped table-condensed">
  513. <thead>
  514. <tr>
  515. <th>Type</th>
  516. <th>Description</th>
  517. </tr>
  518. </thead>
  519. <tbody>
  520. <tr>
  521. <td><span class="xref">System.Boolean</span></td>
  522. <td></td>
  523. </tr>
  524. </tbody>
  525. </table>
  526. <a id="Terminal_Gui_TreeView_1_AspectGetter_" data-uid="Terminal.Gui.TreeView`1.AspectGetter*"></a>
  527. <h4 id="Terminal_Gui_TreeView_1_AspectGetter" data-uid="Terminal.Gui.TreeView`1.AspectGetter">AspectGetter</h4>
  528. <div class="markdown level1 summary">
  529. Returns the string representation of model objects hosted in the tree. Default
  530. implementation is to call <span class="xref">System.Object.ToString()</span>
  531. </div>
  532. <div class="markdown level1 conceptual"></div>
  533. <h5 class="decalaration">Declaration</h5>
  534. <div class="codewrapper">
  535. <pre><code class="lang-csharp hljs">public AspectGetterDelegate&lt;T&gt; AspectGetter { get; set; }</code></pre>
  536. </div>
  537. <h5 class="propertyValue">Property Value</h5>
  538. <table class="table table-bordered table-striped table-condensed">
  539. <thead>
  540. <tr>
  541. <th>Type</th>
  542. <th>Description</th>
  543. </tr>
  544. </thead>
  545. <tbody>
  546. <tr>
  547. <td><a class="xref" href="Terminal.Gui.AspectGetterDelegate-1.html">AspectGetterDelegate</a>&lt;T&gt;</td>
  548. <td></td>
  549. </tr>
  550. </tbody>
  551. </table>
  552. <a id="Terminal_Gui_TreeView_1_ContentHeight_" data-uid="Terminal.Gui.TreeView`1.ContentHeight*"></a>
  553. <h4 id="Terminal_Gui_TreeView_1_ContentHeight" data-uid="Terminal.Gui.TreeView`1.ContentHeight">ContentHeight</h4>
  554. <div class="markdown level1 summary">
  555. The current number of rows in the tree (ignoring the controls bounds)
  556. </div>
  557. <div class="markdown level1 conceptual"></div>
  558. <h5 class="decalaration">Declaration</h5>
  559. <div class="codewrapper">
  560. <pre><code class="lang-csharp hljs">public int ContentHeight { get; }</code></pre>
  561. </div>
  562. <h5 class="propertyValue">Property Value</h5>
  563. <table class="table table-bordered table-striped table-condensed">
  564. <thead>
  565. <tr>
  566. <th>Type</th>
  567. <th>Description</th>
  568. </tr>
  569. </thead>
  570. <tbody>
  571. <tr>
  572. <td><span class="xref">System.Int32</span></td>
  573. <td></td>
  574. </tr>
  575. </tbody>
  576. </table>
  577. <a id="Terminal_Gui_TreeView_1_MultiSelect_" data-uid="Terminal.Gui.TreeView`1.MultiSelect*"></a>
  578. <h4 id="Terminal_Gui_TreeView_1_MultiSelect" data-uid="Terminal.Gui.TreeView`1.MultiSelect">MultiSelect</h4>
  579. <div class="markdown level1 summary">
  580. True to allow multiple objects to be selected at once
  581. </div>
  582. <div class="markdown level1 conceptual"></div>
  583. <h5 class="decalaration">Declaration</h5>
  584. <div class="codewrapper">
  585. <pre><code class="lang-csharp hljs">public bool MultiSelect { get; set; }</code></pre>
  586. </div>
  587. <h5 class="propertyValue">Property Value</h5>
  588. <table class="table table-bordered table-striped table-condensed">
  589. <thead>
  590. <tr>
  591. <th>Type</th>
  592. <th>Description</th>
  593. </tr>
  594. </thead>
  595. <tbody>
  596. <tr>
  597. <td><span class="xref">System.Boolean</span></td>
  598. <td></td>
  599. </tr>
  600. </tbody>
  601. </table>
  602. <a id="Terminal_Gui_TreeView_1_ObjectActivationKey_" data-uid="Terminal.Gui.TreeView`1.ObjectActivationKey*"></a>
  603. <h4 id="Terminal_Gui_TreeView_1_ObjectActivationKey" data-uid="Terminal.Gui.TreeView`1.ObjectActivationKey">ObjectActivationKey</h4>
  604. <div class="markdown level1 summary">
  605. Key which when pressed triggers <a class="xref" href="Terminal.Gui.TreeView-1.html#Terminal_Gui_TreeView_1_ObjectActivated">ObjectActivated</a>.
  606. Defaults to Enter
  607. </div>
  608. <div class="markdown level1 conceptual"></div>
  609. <h5 class="decalaration">Declaration</h5>
  610. <div class="codewrapper">
  611. <pre><code class="lang-csharp hljs">public Key ObjectActivationKey { get; set; }</code></pre>
  612. </div>
  613. <h5 class="propertyValue">Property Value</h5>
  614. <table class="table table-bordered table-striped table-condensed">
  615. <thead>
  616. <tr>
  617. <th>Type</th>
  618. <th>Description</th>
  619. </tr>
  620. </thead>
  621. <tbody>
  622. <tr>
  623. <td><a class="xref" href="Terminal.Gui.Key.html">Key</a></td>
  624. <td></td>
  625. </tr>
  626. </tbody>
  627. </table>
  628. <a id="Terminal_Gui_TreeView_1_Objects_" data-uid="Terminal.Gui.TreeView`1.Objects*"></a>
  629. <h4 id="Terminal_Gui_TreeView_1_Objects" data-uid="Terminal.Gui.TreeView`1.Objects">Objects</h4>
  630. <div class="markdown level1 summary">
  631. The root objects in the tree, note that this collection is of root objects only
  632. </div>
  633. <div class="markdown level1 conceptual"></div>
  634. <h5 class="decalaration">Declaration</h5>
  635. <div class="codewrapper">
  636. <pre><code class="lang-csharp hljs">public IEnumerable&lt;T&gt; Objects { get; }</code></pre>
  637. </div>
  638. <h5 class="propertyValue">Property Value</h5>
  639. <table class="table table-bordered table-striped table-condensed">
  640. <thead>
  641. <tr>
  642. <th>Type</th>
  643. <th>Description</th>
  644. </tr>
  645. </thead>
  646. <tbody>
  647. <tr>
  648. <td><span class="xref">System.Collections.Generic.IEnumerable</span>&lt;T&gt;</td>
  649. <td></td>
  650. </tr>
  651. </tbody>
  652. </table>
  653. <a id="Terminal_Gui_TreeView_1_ScrollOffsetHorizontal_" data-uid="Terminal.Gui.TreeView`1.ScrollOffsetHorizontal*"></a>
  654. <h4 id="Terminal_Gui_TreeView_1_ScrollOffsetHorizontal" data-uid="Terminal.Gui.TreeView`1.ScrollOffsetHorizontal">ScrollOffsetHorizontal</h4>
  655. <div class="markdown level1 summary">
  656. The amount of tree view that has been scrolled to the right (horizontally)
  657. </div>
  658. <div class="markdown level1 conceptual"></div>
  659. <h5 class="decalaration">Declaration</h5>
  660. <div class="codewrapper">
  661. <pre><code class="lang-csharp hljs">public int ScrollOffsetHorizontal { get; set; }</code></pre>
  662. </div>
  663. <h5 class="propertyValue">Property Value</h5>
  664. <table class="table table-bordered table-striped table-condensed">
  665. <thead>
  666. <tr>
  667. <th>Type</th>
  668. <th>Description</th>
  669. </tr>
  670. </thead>
  671. <tbody>
  672. <tr>
  673. <td><span class="xref">System.Int32</span></td>
  674. <td></td>
  675. </tr>
  676. </tbody>
  677. </table>
  678. <h5 id="Terminal_Gui_TreeView_1_ScrollOffsetHorizontal_remarks">Remarks</h5>
  679. <div class="markdown level1 remarks">Setting a value of less than 0 will result in a offset of 0. To see changes
  680. in the UI call <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SetNeedsDisplay">SetNeedsDisplay()</a></div>
  681. <a id="Terminal_Gui_TreeView_1_ScrollOffsetVertical_" data-uid="Terminal.Gui.TreeView`1.ScrollOffsetVertical*"></a>
  682. <h4 id="Terminal_Gui_TreeView_1_ScrollOffsetVertical" data-uid="Terminal.Gui.TreeView`1.ScrollOffsetVertical">ScrollOffsetVertical</h4>
  683. <div class="markdown level1 summary">
  684. The amount of tree view that has been scrolled off the top of the screen (by the user
  685. scrolling down)
  686. </div>
  687. <div class="markdown level1 conceptual"></div>
  688. <h5 class="decalaration">Declaration</h5>
  689. <div class="codewrapper">
  690. <pre><code class="lang-csharp hljs">public int ScrollOffsetVertical { get; set; }</code></pre>
  691. </div>
  692. <h5 class="propertyValue">Property Value</h5>
  693. <table class="table table-bordered table-striped table-condensed">
  694. <thead>
  695. <tr>
  696. <th>Type</th>
  697. <th>Description</th>
  698. </tr>
  699. </thead>
  700. <tbody>
  701. <tr>
  702. <td><span class="xref">System.Int32</span></td>
  703. <td></td>
  704. </tr>
  705. </tbody>
  706. </table>
  707. <h5 id="Terminal_Gui_TreeView_1_ScrollOffsetVertical_remarks">Remarks</h5>
  708. <div class="markdown level1 remarks">Setting a value of less than 0 will result in a offset of 0. To see changes
  709. in the UI call <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SetNeedsDisplay">SetNeedsDisplay()</a></div>
  710. <a id="Terminal_Gui_TreeView_1_SelectedObject_" data-uid="Terminal.Gui.TreeView`1.SelectedObject*"></a>
  711. <h4 id="Terminal_Gui_TreeView_1_SelectedObject" data-uid="Terminal.Gui.TreeView`1.SelectedObject">SelectedObject</h4>
  712. <div class="markdown level1 summary">
  713. The currently selected object in the tree. When <a class="xref" href="Terminal.Gui.TreeView-1.html#Terminal_Gui_TreeView_1_MultiSelect">MultiSelect</a> is true this
  714. is the object at which the cursor is at
  715. </div>
  716. <div class="markdown level1 conceptual"></div>
  717. <h5 class="decalaration">Declaration</h5>
  718. <div class="codewrapper">
  719. <pre><code class="lang-csharp hljs">public T SelectedObject { get; set; }</code></pre>
  720. </div>
  721. <h5 class="propertyValue">Property Value</h5>
  722. <table class="table table-bordered table-striped table-condensed">
  723. <thead>
  724. <tr>
  725. <th>Type</th>
  726. <th>Description</th>
  727. </tr>
  728. </thead>
  729. <tbody>
  730. <tr>
  731. <td><span class="xref">T</span></td>
  732. <td></td>
  733. </tr>
  734. </tbody>
  735. </table>
  736. <a id="Terminal_Gui_TreeView_1_Style_" data-uid="Terminal.Gui.TreeView`1.Style*"></a>
  737. <h4 id="Terminal_Gui_TreeView_1_Style" data-uid="Terminal.Gui.TreeView`1.Style">Style</h4>
  738. <div class="markdown level1 summary">
  739. Contains options for changing how the tree is rendered
  740. </div>
  741. <div class="markdown level1 conceptual"></div>
  742. <h5 class="decalaration">Declaration</h5>
  743. <div class="codewrapper">
  744. <pre><code class="lang-csharp hljs">public TreeStyle Style { get; set; }</code></pre>
  745. </div>
  746. <h5 class="propertyValue">Property Value</h5>
  747. <table class="table table-bordered table-striped table-condensed">
  748. <thead>
  749. <tr>
  750. <th>Type</th>
  751. <th>Description</th>
  752. </tr>
  753. </thead>
  754. <tbody>
  755. <tr>
  756. <td><a class="xref" href="Terminal.Gui.TreeStyle.html">TreeStyle</a></td>
  757. <td></td>
  758. </tr>
  759. </tbody>
  760. </table>
  761. <a id="Terminal_Gui_TreeView_1_TreeBuilder_" data-uid="Terminal.Gui.TreeView`1.TreeBuilder*"></a>
  762. <h4 id="Terminal_Gui_TreeView_1_TreeBuilder" data-uid="Terminal.Gui.TreeView`1.TreeBuilder">TreeBuilder</h4>
  763. <div class="markdown level1 summary">
  764. Determines how sub branches of the tree are dynamically built at runtime as the user
  765. expands root nodes
  766. </div>
  767. <div class="markdown level1 conceptual"></div>
  768. <h5 class="decalaration">Declaration</h5>
  769. <div class="codewrapper">
  770. <pre><code class="lang-csharp hljs">public ITreeBuilder&lt;T&gt; TreeBuilder { get; set; }</code></pre>
  771. </div>
  772. <h5 class="propertyValue">Property Value</h5>
  773. <table class="table table-bordered table-striped table-condensed">
  774. <thead>
  775. <tr>
  776. <th>Type</th>
  777. <th>Description</th>
  778. </tr>
  779. </thead>
  780. <tbody>
  781. <tr>
  782. <td><a class="xref" href="Terminal.Gui.ITreeBuilder-1.html">ITreeBuilder</a>&lt;T&gt;</td>
  783. <td></td>
  784. </tr>
  785. </tbody>
  786. </table>
  787. <h3 id="methods">Methods
  788. </h3>
  789. <a id="Terminal_Gui_TreeView_1_AddObject_" data-uid="Terminal.Gui.TreeView`1.AddObject*"></a>
  790. <h4 id="Terminal_Gui_TreeView_1_AddObject__0_" data-uid="Terminal.Gui.TreeView`1.AddObject(`0)">AddObject(T)</h4>
  791. <div class="markdown level1 summary">
  792. Adds a new root level object unless it is already a root of the tree
  793. </div>
  794. <div class="markdown level1 conceptual"></div>
  795. <h5 class="decalaration">Declaration</h5>
  796. <div class="codewrapper">
  797. <pre><code class="lang-csharp hljs">public void AddObject(T o)</code></pre>
  798. </div>
  799. <h5 class="parameters">Parameters</h5>
  800. <table class="table table-bordered table-striped table-condensed">
  801. <thead>
  802. <tr>
  803. <th>Type</th>
  804. <th>Name</th>
  805. <th>Description</th>
  806. </tr>
  807. </thead>
  808. <tbody>
  809. <tr>
  810. <td><span class="xref">T</span></td>
  811. <td><span class="parametername">o</span></td>
  812. <td></td>
  813. </tr>
  814. </tbody>
  815. </table>
  816. <a id="Terminal_Gui_TreeView_1_AddObjects_" data-uid="Terminal.Gui.TreeView`1.AddObjects*"></a>
  817. <h4 id="Terminal_Gui_TreeView_1_AddObjects_System_Collections_Generic_IEnumerable__0__" data-uid="Terminal.Gui.TreeView`1.AddObjects(System.Collections.Generic.IEnumerable{`0})">AddObjects(IEnumerable&lt;T&gt;)</h4>
  818. <div class="markdown level1 summary">
  819. Adds many new root level objects. Objects that are already root objects are ignored
  820. </div>
  821. <div class="markdown level1 conceptual"></div>
  822. <h5 class="decalaration">Declaration</h5>
  823. <div class="codewrapper">
  824. <pre><code class="lang-csharp hljs">public void AddObjects(IEnumerable&lt;T&gt; collection)</code></pre>
  825. </div>
  826. <h5 class="parameters">Parameters</h5>
  827. <table class="table table-bordered table-striped table-condensed">
  828. <thead>
  829. <tr>
  830. <th>Type</th>
  831. <th>Name</th>
  832. <th>Description</th>
  833. </tr>
  834. </thead>
  835. <tbody>
  836. <tr>
  837. <td><span class="xref">System.Collections.Generic.IEnumerable</span>&lt;T&gt;</td>
  838. <td><span class="parametername">collection</span></td>
  839. <td>Objects to add as new root level objects</td>
  840. </tr>
  841. </tbody>
  842. </table>
  843. <a id="Terminal_Gui_TreeView_1_AdjustSelection_" data-uid="Terminal.Gui.TreeView`1.AdjustSelection*"></a>
  844. <h4 id="Terminal_Gui_TreeView_1_AdjustSelection_System_Int32_System_Boolean_" data-uid="Terminal.Gui.TreeView`1.AdjustSelection(System.Int32,System.Boolean)">AdjustSelection(Int32, Boolean)</h4>
  845. <div class="markdown level1 summary">
  846. The number of screen lines to move the currently selected object by. Supports negative
  847. <code data-dev-comment-type="paramref" class="paramref">offset</code>. Each branch occupies 1 line on screen
  848. </div>
  849. <div class="markdown level1 conceptual"></div>
  850. <h5 class="decalaration">Declaration</h5>
  851. <div class="codewrapper">
  852. <pre><code class="lang-csharp hljs">public void AdjustSelection(int offset, bool expandSelection = false)</code></pre>
  853. </div>
  854. <h5 class="parameters">Parameters</h5>
  855. <table class="table table-bordered table-striped table-condensed">
  856. <thead>
  857. <tr>
  858. <th>Type</th>
  859. <th>Name</th>
  860. <th>Description</th>
  861. </tr>
  862. </thead>
  863. <tbody>
  864. <tr>
  865. <td><span class="xref">System.Int32</span></td>
  866. <td><span class="parametername">offset</span></td>
  867. <td>Positive to move the selection down the screen, negative to move it up</td>
  868. </tr>
  869. <tr>
  870. <td><span class="xref">System.Boolean</span></td>
  871. <td><span class="parametername">expandSelection</span></td>
  872. <td>True to expand the selection (assuming
  873. <a class="xref" href="Terminal.Gui.TreeView-1.html#Terminal_Gui_TreeView_1_MultiSelect">MultiSelect</a> is enabled). False to replace</td>
  874. </tr>
  875. </tbody>
  876. </table>
  877. <h5 id="Terminal_Gui_TreeView_1_AdjustSelection_System_Int32_System_Boolean__remarks">Remarks</h5>
  878. <div class="markdown level1 remarks">If nothing is currently selected or the selected object is no longer in the tree
  879. then the first object in the tree is selected instead</div>
  880. <a id="Terminal_Gui_TreeView_1_AdjustSelectionToBranchEnd_" data-uid="Terminal.Gui.TreeView`1.AdjustSelectionToBranchEnd*"></a>
  881. <h4 id="Terminal_Gui_TreeView_1_AdjustSelectionToBranchEnd" data-uid="Terminal.Gui.TreeView`1.AdjustSelectionToBranchEnd">AdjustSelectionToBranchEnd()</h4>
  882. <div class="markdown level1 summary">
  883. Moves the selection to the last child in the currently selected level
  884. </div>
  885. <div class="markdown level1 conceptual"></div>
  886. <h5 class="decalaration">Declaration</h5>
  887. <div class="codewrapper">
  888. <pre><code class="lang-csharp hljs">public void AdjustSelectionToBranchEnd()</code></pre>
  889. </div>
  890. <a id="Terminal_Gui_TreeView_1_AdjustSelectionToBranchStart_" data-uid="Terminal.Gui.TreeView`1.AdjustSelectionToBranchStart*"></a>
  891. <h4 id="Terminal_Gui_TreeView_1_AdjustSelectionToBranchStart" data-uid="Terminal.Gui.TreeView`1.AdjustSelectionToBranchStart">AdjustSelectionToBranchStart()</h4>
  892. <div class="markdown level1 summary">
  893. Moves the selection to the first child in the currently selected level
  894. </div>
  895. <div class="markdown level1 conceptual"></div>
  896. <h5 class="decalaration">Declaration</h5>
  897. <div class="codewrapper">
  898. <pre><code class="lang-csharp hljs">public void AdjustSelectionToBranchStart()</code></pre>
  899. </div>
  900. <a id="Terminal_Gui_TreeView_1_CanExpand_" data-uid="Terminal.Gui.TreeView`1.CanExpand*"></a>
  901. <h4 id="Terminal_Gui_TreeView_1_CanExpand__0_" data-uid="Terminal.Gui.TreeView`1.CanExpand(`0)">CanExpand(T)</h4>
  902. <div class="markdown level1 summary">
  903. Returns true if the given object <code data-dev-comment-type="paramref" class="paramref">o</code> is exposed in the tree and can be
  904. expanded otherwise false
  905. </div>
  906. <div class="markdown level1 conceptual"></div>
  907. <h5 class="decalaration">Declaration</h5>
  908. <div class="codewrapper">
  909. <pre><code class="lang-csharp hljs">public bool CanExpand(T o)</code></pre>
  910. </div>
  911. <h5 class="parameters">Parameters</h5>
  912. <table class="table table-bordered table-striped table-condensed">
  913. <thead>
  914. <tr>
  915. <th>Type</th>
  916. <th>Name</th>
  917. <th>Description</th>
  918. </tr>
  919. </thead>
  920. <tbody>
  921. <tr>
  922. <td><span class="xref">T</span></td>
  923. <td><span class="parametername">o</span></td>
  924. <td></td>
  925. </tr>
  926. </tbody>
  927. </table>
  928. <h5 class="returns">Returns</h5>
  929. <table class="table table-bordered table-striped table-condensed">
  930. <thead>
  931. <tr>
  932. <th>Type</th>
  933. <th>Description</th>
  934. </tr>
  935. </thead>
  936. <tbody>
  937. <tr>
  938. <td><span class="xref">System.Boolean</span></td>
  939. <td></td>
  940. </tr>
  941. </tbody>
  942. </table>
  943. <a id="Terminal_Gui_TreeView_1_ClearObjects_" data-uid="Terminal.Gui.TreeView`1.ClearObjects*"></a>
  944. <h4 id="Terminal_Gui_TreeView_1_ClearObjects" data-uid="Terminal.Gui.TreeView`1.ClearObjects">ClearObjects()</h4>
  945. <div class="markdown level1 summary">
  946. Removes all objects from the tree and clears <a class="xref" href="Terminal.Gui.TreeView-1.html#Terminal_Gui_TreeView_1_SelectedObject">SelectedObject</a>
  947. </div>
  948. <div class="markdown level1 conceptual"></div>
  949. <h5 class="decalaration">Declaration</h5>
  950. <div class="codewrapper">
  951. <pre><code class="lang-csharp hljs">public void ClearObjects()</code></pre>
  952. </div>
  953. <a id="Terminal_Gui_TreeView_1_Collapse_" data-uid="Terminal.Gui.TreeView`1.Collapse*"></a>
  954. <h4 id="Terminal_Gui_TreeView_1_Collapse__0_" data-uid="Terminal.Gui.TreeView`1.Collapse(`0)">Collapse(T)</h4>
  955. <div class="markdown level1 summary">
  956. Collapses the supplied object if it is currently expanded
  957. </div>
  958. <div class="markdown level1 conceptual"></div>
  959. <h5 class="decalaration">Declaration</h5>
  960. <div class="codewrapper">
  961. <pre><code class="lang-csharp hljs">public void Collapse(T toCollapse)</code></pre>
  962. </div>
  963. <h5 class="parameters">Parameters</h5>
  964. <table class="table table-bordered table-striped table-condensed">
  965. <thead>
  966. <tr>
  967. <th>Type</th>
  968. <th>Name</th>
  969. <th>Description</th>
  970. </tr>
  971. </thead>
  972. <tbody>
  973. <tr>
  974. <td><span class="xref">T</span></td>
  975. <td><span class="parametername">toCollapse</span></td>
  976. <td>The object to collapse</td>
  977. </tr>
  978. </tbody>
  979. </table>
  980. <a id="Terminal_Gui_TreeView_1_CollapseAll_" data-uid="Terminal.Gui.TreeView`1.CollapseAll*"></a>
  981. <h4 id="Terminal_Gui_TreeView_1_CollapseAll" data-uid="Terminal.Gui.TreeView`1.CollapseAll">CollapseAll()</h4>
  982. <div class="markdown level1 summary">
  983. Collapses all root nodes in the tree
  984. </div>
  985. <div class="markdown level1 conceptual"></div>
  986. <h5 class="decalaration">Declaration</h5>
  987. <div class="codewrapper">
  988. <pre><code class="lang-csharp hljs">public void CollapseAll()</code></pre>
  989. </div>
  990. <a id="Terminal_Gui_TreeView_1_CollapseAll_" data-uid="Terminal.Gui.TreeView`1.CollapseAll*"></a>
  991. <h4 id="Terminal_Gui_TreeView_1_CollapseAll__0_" data-uid="Terminal.Gui.TreeView`1.CollapseAll(`0)">CollapseAll(T)</h4>
  992. <div class="markdown level1 summary">
  993. Collapses the supplied object if it is currently expanded. Also collapses all children
  994. branches (this will only become apparent when/if the user expands it again)
  995. </div>
  996. <div class="markdown level1 conceptual"></div>
  997. <h5 class="decalaration">Declaration</h5>
  998. <div class="codewrapper">
  999. <pre><code class="lang-csharp hljs">public void CollapseAll(T toCollapse)</code></pre>
  1000. </div>
  1001. <h5 class="parameters">Parameters</h5>
  1002. <table class="table table-bordered table-striped table-condensed">
  1003. <thead>
  1004. <tr>
  1005. <th>Type</th>
  1006. <th>Name</th>
  1007. <th>Description</th>
  1008. </tr>
  1009. </thead>
  1010. <tbody>
  1011. <tr>
  1012. <td><span class="xref">T</span></td>
  1013. <td><span class="parametername">toCollapse</span></td>
  1014. <td>The object to collapse</td>
  1015. </tr>
  1016. </tbody>
  1017. </table>
  1018. <a id="Terminal_Gui_TreeView_1_CollapseImpl_" data-uid="Terminal.Gui.TreeView`1.CollapseImpl*"></a>
  1019. <h4 id="Terminal_Gui_TreeView_1_CollapseImpl__0_System_Boolean_" data-uid="Terminal.Gui.TreeView`1.CollapseImpl(`0,System.Boolean)">CollapseImpl(T, Boolean)</h4>
  1020. <div class="markdown level1 summary">
  1021. Implementation of <a class="xref" href="Terminal.Gui.TreeView-1.html#Terminal_Gui_TreeView_1_Collapse__0_">Collapse(T)</a> and <a class="xref" href="Terminal.Gui.TreeView-1.html#Terminal_Gui_TreeView_1_CollapseAll__0_">CollapseAll(T)</a>. Performs
  1022. operation and updates selection if disapeared
  1023. </div>
  1024. <div class="markdown level1 conceptual"></div>
  1025. <h5 class="decalaration">Declaration</h5>
  1026. <div class="codewrapper">
  1027. <pre><code class="lang-csharp hljs">protected void CollapseImpl(T toCollapse, bool all)</code></pre>
  1028. </div>
  1029. <h5 class="parameters">Parameters</h5>
  1030. <table class="table table-bordered table-striped table-condensed">
  1031. <thead>
  1032. <tr>
  1033. <th>Type</th>
  1034. <th>Name</th>
  1035. <th>Description</th>
  1036. </tr>
  1037. </thead>
  1038. <tbody>
  1039. <tr>
  1040. <td><span class="xref">T</span></td>
  1041. <td><span class="parametername">toCollapse</span></td>
  1042. <td></td>
  1043. </tr>
  1044. <tr>
  1045. <td><span class="xref">System.Boolean</span></td>
  1046. <td><span class="parametername">all</span></td>
  1047. <td></td>
  1048. </tr>
  1049. </tbody>
  1050. </table>
  1051. <a id="Terminal_Gui_TreeView_1_CursorLeft_" data-uid="Terminal.Gui.TreeView`1.CursorLeft*"></a>
  1052. <h4 id="Terminal_Gui_TreeView_1_CursorLeft_System_Boolean_" data-uid="Terminal.Gui.TreeView`1.CursorLeft(System.Boolean)">CursorLeft(Boolean)</h4>
  1053. <div class="markdown level1 summary">
  1054. Determines systems behaviour when the left arrow key is pressed. Default behaviour is
  1055. to collapse the current tree node if possible otherwise changes selection to current
  1056. branches parent
  1057. </div>
  1058. <div class="markdown level1 conceptual"></div>
  1059. <h5 class="decalaration">Declaration</h5>
  1060. <div class="codewrapper">
  1061. <pre><code class="lang-csharp hljs">protected virtual void CursorLeft(bool ctrl)</code></pre>
  1062. </div>
  1063. <h5 class="parameters">Parameters</h5>
  1064. <table class="table table-bordered table-striped table-condensed">
  1065. <thead>
  1066. <tr>
  1067. <th>Type</th>
  1068. <th>Name</th>
  1069. <th>Description</th>
  1070. </tr>
  1071. </thead>
  1072. <tbody>
  1073. <tr>
  1074. <td><span class="xref">System.Boolean</span></td>
  1075. <td><span class="parametername">ctrl</span></td>
  1076. <td></td>
  1077. </tr>
  1078. </tbody>
  1079. </table>
  1080. <a id="Terminal_Gui_TreeView_1_EnsureVisible_" data-uid="Terminal.Gui.TreeView`1.EnsureVisible*"></a>
  1081. <h4 id="Terminal_Gui_TreeView_1_EnsureVisible__0_" data-uid="Terminal.Gui.TreeView`1.EnsureVisible(`0)">EnsureVisible(T)</h4>
  1082. <div class="markdown level1 summary">
  1083. Adjusts the <a class="xref" href="Terminal.Gui.TreeView-1.html#Terminal_Gui_TreeView_1_ScrollOffsetVertical">ScrollOffsetVertical</a> to ensure the given
  1084. <code data-dev-comment-type="paramref" class="paramref">model</code> is visible. Has no effect if already visible
  1085. </div>
  1086. <div class="markdown level1 conceptual"></div>
  1087. <h5 class="decalaration">Declaration</h5>
  1088. <div class="codewrapper">
  1089. <pre><code class="lang-csharp hljs">public void EnsureVisible(T model)</code></pre>
  1090. </div>
  1091. <h5 class="parameters">Parameters</h5>
  1092. <table class="table table-bordered table-striped table-condensed">
  1093. <thead>
  1094. <tr>
  1095. <th>Type</th>
  1096. <th>Name</th>
  1097. <th>Description</th>
  1098. </tr>
  1099. </thead>
  1100. <tbody>
  1101. <tr>
  1102. <td><span class="xref">T</span></td>
  1103. <td><span class="parametername">model</span></td>
  1104. <td></td>
  1105. </tr>
  1106. </tbody>
  1107. </table>
  1108. <a id="Terminal_Gui_TreeView_1_Expand_" data-uid="Terminal.Gui.TreeView`1.Expand*"></a>
  1109. <h4 id="Terminal_Gui_TreeView_1_Expand__0_" data-uid="Terminal.Gui.TreeView`1.Expand(`0)">Expand(T)</h4>
  1110. <div class="markdown level1 summary">
  1111. Expands the supplied object if it is contained in the tree (either as a root object or
  1112. as an exposed branch object)
  1113. </div>
  1114. <div class="markdown level1 conceptual"></div>
  1115. <h5 class="decalaration">Declaration</h5>
  1116. <div class="codewrapper">
  1117. <pre><code class="lang-csharp hljs">public void Expand(T toExpand)</code></pre>
  1118. </div>
  1119. <h5 class="parameters">Parameters</h5>
  1120. <table class="table table-bordered table-striped table-condensed">
  1121. <thead>
  1122. <tr>
  1123. <th>Type</th>
  1124. <th>Name</th>
  1125. <th>Description</th>
  1126. </tr>
  1127. </thead>
  1128. <tbody>
  1129. <tr>
  1130. <td><span class="xref">T</span></td>
  1131. <td><span class="parametername">toExpand</span></td>
  1132. <td>The object to expand</td>
  1133. </tr>
  1134. </tbody>
  1135. </table>
  1136. <a id="Terminal_Gui_TreeView_1_ExpandAll_" data-uid="Terminal.Gui.TreeView`1.ExpandAll*"></a>
  1137. <h4 id="Terminal_Gui_TreeView_1_ExpandAll" data-uid="Terminal.Gui.TreeView`1.ExpandAll">ExpandAll()</h4>
  1138. <div class="markdown level1 summary">
  1139. Fully expands all nodes in the tree, if the tree is very big and built dynamically this
  1140. may take a while (e.g. for file system)
  1141. </div>
  1142. <div class="markdown level1 conceptual"></div>
  1143. <h5 class="decalaration">Declaration</h5>
  1144. <div class="codewrapper">
  1145. <pre><code class="lang-csharp hljs">public void ExpandAll()</code></pre>
  1146. </div>
  1147. <a id="Terminal_Gui_TreeView_1_ExpandAll_" data-uid="Terminal.Gui.TreeView`1.ExpandAll*"></a>
  1148. <h4 id="Terminal_Gui_TreeView_1_ExpandAll__0_" data-uid="Terminal.Gui.TreeView`1.ExpandAll(`0)">ExpandAll(T)</h4>
  1149. <div class="markdown level1 summary">
  1150. Expands the supplied object and all child objects
  1151. </div>
  1152. <div class="markdown level1 conceptual"></div>
  1153. <h5 class="decalaration">Declaration</h5>
  1154. <div class="codewrapper">
  1155. <pre><code class="lang-csharp hljs">public void ExpandAll(T toExpand)</code></pre>
  1156. </div>
  1157. <h5 class="parameters">Parameters</h5>
  1158. <table class="table table-bordered table-striped table-condensed">
  1159. <thead>
  1160. <tr>
  1161. <th>Type</th>
  1162. <th>Name</th>
  1163. <th>Description</th>
  1164. </tr>
  1165. </thead>
  1166. <tbody>
  1167. <tr>
  1168. <td><span class="xref">T</span></td>
  1169. <td><span class="parametername">toExpand</span></td>
  1170. <td>The object to expand</td>
  1171. </tr>
  1172. </tbody>
  1173. </table>
  1174. <a id="Terminal_Gui_TreeView_1_GetAllSelectedObjects_" data-uid="Terminal.Gui.TreeView`1.GetAllSelectedObjects*"></a>
  1175. <h4 id="Terminal_Gui_TreeView_1_GetAllSelectedObjects" data-uid="Terminal.Gui.TreeView`1.GetAllSelectedObjects">GetAllSelectedObjects()</h4>
  1176. <div class="markdown level1 summary">
  1177. Returns <a class="xref" href="Terminal.Gui.TreeView-1.html#Terminal_Gui_TreeView_1_SelectedObject">SelectedObject</a> (if not null) and all multi selected objects if
  1178. <a class="xref" href="Terminal.Gui.TreeView-1.html#Terminal_Gui_TreeView_1_MultiSelect">MultiSelect</a> is true
  1179. </div>
  1180. <div class="markdown level1 conceptual"></div>
  1181. <h5 class="decalaration">Declaration</h5>
  1182. <div class="codewrapper">
  1183. <pre><code class="lang-csharp hljs">public IEnumerable&lt;T&gt; GetAllSelectedObjects()</code></pre>
  1184. </div>
  1185. <h5 class="returns">Returns</h5>
  1186. <table class="table table-bordered table-striped table-condensed">
  1187. <thead>
  1188. <tr>
  1189. <th>Type</th>
  1190. <th>Description</th>
  1191. </tr>
  1192. </thead>
  1193. <tbody>
  1194. <tr>
  1195. <td><span class="xref">System.Collections.Generic.IEnumerable</span>&lt;T&gt;</td>
  1196. <td></td>
  1197. </tr>
  1198. </tbody>
  1199. </table>
  1200. <a id="Terminal_Gui_TreeView_1_GetChildren_" data-uid="Terminal.Gui.TreeView`1.GetChildren*"></a>
  1201. <h4 id="Terminal_Gui_TreeView_1_GetChildren__0_" data-uid="Terminal.Gui.TreeView`1.GetChildren(`0)">GetChildren(T)</h4>
  1202. <div class="markdown level1 summary">
  1203. Returns the currently expanded children of the passed object. Returns an empty
  1204. collection if the branch is not exposed or not expanded
  1205. </div>
  1206. <div class="markdown level1 conceptual"></div>
  1207. <h5 class="decalaration">Declaration</h5>
  1208. <div class="codewrapper">
  1209. <pre><code class="lang-csharp hljs">public IEnumerable&lt;T&gt; GetChildren(T o)</code></pre>
  1210. </div>
  1211. <h5 class="parameters">Parameters</h5>
  1212. <table class="table table-bordered table-striped table-condensed">
  1213. <thead>
  1214. <tr>
  1215. <th>Type</th>
  1216. <th>Name</th>
  1217. <th>Description</th>
  1218. </tr>
  1219. </thead>
  1220. <tbody>
  1221. <tr>
  1222. <td><span class="xref">T</span></td>
  1223. <td><span class="parametername">o</span></td>
  1224. <td>An object in the tree</td>
  1225. </tr>
  1226. </tbody>
  1227. </table>
  1228. <h5 class="returns">Returns</h5>
  1229. <table class="table table-bordered table-striped table-condensed">
  1230. <thead>
  1231. <tr>
  1232. <th>Type</th>
  1233. <th>Description</th>
  1234. </tr>
  1235. </thead>
  1236. <tbody>
  1237. <tr>
  1238. <td><span class="xref">System.Collections.Generic.IEnumerable</span>&lt;T&gt;</td>
  1239. <td></td>
  1240. </tr>
  1241. </tbody>
  1242. </table>
  1243. <a id="Terminal_Gui_TreeView_1_GetContentWidth_" data-uid="Terminal.Gui.TreeView`1.GetContentWidth*"></a>
  1244. <h4 id="Terminal_Gui_TreeView_1_GetContentWidth_System_Boolean_" data-uid="Terminal.Gui.TreeView`1.GetContentWidth(System.Boolean)">GetContentWidth(Boolean)</h4>
  1245. <div class="markdown level1 summary">
  1246. Returns the maximum width line in the tree including prefix and expansion symbols
  1247. </div>
  1248. <div class="markdown level1 conceptual"></div>
  1249. <h5 class="decalaration">Declaration</h5>
  1250. <div class="codewrapper">
  1251. <pre><code class="lang-csharp hljs">public int GetContentWidth(bool visible)</code></pre>
  1252. </div>
  1253. <h5 class="parameters">Parameters</h5>
  1254. <table class="table table-bordered table-striped table-condensed">
  1255. <thead>
  1256. <tr>
  1257. <th>Type</th>
  1258. <th>Name</th>
  1259. <th>Description</th>
  1260. </tr>
  1261. </thead>
  1262. <tbody>
  1263. <tr>
  1264. <td><span class="xref">System.Boolean</span></td>
  1265. <td><span class="parametername">visible</span></td>
  1266. <td>True to consider only rows currently visible (based on window
  1267. bounds and <a class="xref" href="Terminal.Gui.TreeView-1.html#Terminal_Gui_TreeView_1_ScrollOffsetVertical">ScrollOffsetVertical</a>. False to calculate the width of
  1268. every exposed branch in the tree</td>
  1269. </tr>
  1270. </tbody>
  1271. </table>
  1272. <h5 class="returns">Returns</h5>
  1273. <table class="table table-bordered table-striped table-condensed">
  1274. <thead>
  1275. <tr>
  1276. <th>Type</th>
  1277. <th>Description</th>
  1278. </tr>
  1279. </thead>
  1280. <tbody>
  1281. <tr>
  1282. <td><span class="xref">System.Int32</span></td>
  1283. <td></td>
  1284. </tr>
  1285. </tbody>
  1286. </table>
  1287. <a id="Terminal_Gui_TreeView_1_GetParent_" data-uid="Terminal.Gui.TreeView`1.GetParent*"></a>
  1288. <h4 id="Terminal_Gui_TreeView_1_GetParent__0_" data-uid="Terminal.Gui.TreeView`1.GetParent(`0)">GetParent(T)</h4>
  1289. <div class="markdown level1 summary">
  1290. Returns the parent object of <code data-dev-comment-type="paramref" class="paramref">o</code> in the tree. Returns null if
  1291. the object is not exposed in the tree
  1292. </div>
  1293. <div class="markdown level1 conceptual"></div>
  1294. <h5 class="decalaration">Declaration</h5>
  1295. <div class="codewrapper">
  1296. <pre><code class="lang-csharp hljs">public T GetParent(T o)</code></pre>
  1297. </div>
  1298. <h5 class="parameters">Parameters</h5>
  1299. <table class="table table-bordered table-striped table-condensed">
  1300. <thead>
  1301. <tr>
  1302. <th>Type</th>
  1303. <th>Name</th>
  1304. <th>Description</th>
  1305. </tr>
  1306. </thead>
  1307. <tbody>
  1308. <tr>
  1309. <td><span class="xref">T</span></td>
  1310. <td><span class="parametername">o</span></td>
  1311. <td>An object in the tree</td>
  1312. </tr>
  1313. </tbody>
  1314. </table>
  1315. <h5 class="returns">Returns</h5>
  1316. <table class="table table-bordered table-striped table-condensed">
  1317. <thead>
  1318. <tr>
  1319. <th>Type</th>
  1320. <th>Description</th>
  1321. </tr>
  1322. </thead>
  1323. <tbody>
  1324. <tr>
  1325. <td><span class="xref">T</span></td>
  1326. <td></td>
  1327. </tr>
  1328. </tbody>
  1329. </table>
  1330. <a id="Terminal_Gui_TreeView_1_GetScrollOffsetOf_" data-uid="Terminal.Gui.TreeView`1.GetScrollOffsetOf*"></a>
  1331. <h4 id="Terminal_Gui_TreeView_1_GetScrollOffsetOf__0_" data-uid="Terminal.Gui.TreeView`1.GetScrollOffsetOf(`0)">GetScrollOffsetOf(T)</h4>
  1332. <div class="markdown level1 summary">
  1333. Returns the index of the object <code data-dev-comment-type="paramref" class="paramref">o</code> if it is currently exposed (it&apos;s
  1334. parent(s) have been expanded). This can be used with <a class="xref" href="Terminal.Gui.TreeView-1.html#Terminal_Gui_TreeView_1_ScrollOffsetVertical">ScrollOffsetVertical</a>
  1335. and <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SetNeedsDisplay">SetNeedsDisplay()</a> to scroll to a specific object
  1336. </div>
  1337. <div class="markdown level1 conceptual"></div>
  1338. <h5 class="decalaration">Declaration</h5>
  1339. <div class="codewrapper">
  1340. <pre><code class="lang-csharp hljs">public int GetScrollOffsetOf(T o)</code></pre>
  1341. </div>
  1342. <h5 class="parameters">Parameters</h5>
  1343. <table class="table table-bordered table-striped table-condensed">
  1344. <thead>
  1345. <tr>
  1346. <th>Type</th>
  1347. <th>Name</th>
  1348. <th>Description</th>
  1349. </tr>
  1350. </thead>
  1351. <tbody>
  1352. <tr>
  1353. <td><span class="xref">T</span></td>
  1354. <td><span class="parametername">o</span></td>
  1355. <td>An object that appears in your tree and is currently exposed</td>
  1356. </tr>
  1357. </tbody>
  1358. </table>
  1359. <h5 class="returns">Returns</h5>
  1360. <table class="table table-bordered table-striped table-condensed">
  1361. <thead>
  1362. <tr>
  1363. <th>Type</th>
  1364. <th>Description</th>
  1365. </tr>
  1366. </thead>
  1367. <tbody>
  1368. <tr>
  1369. <td><span class="xref">System.Int32</span></td>
  1370. <td>The index the object was found at or -1 if it is not currently revealed or
  1371. not in the tree at all</td>
  1372. </tr>
  1373. </tbody>
  1374. </table>
  1375. <h5 id="Terminal_Gui_TreeView_1_GetScrollOffsetOf__0__remarks">Remarks</h5>
  1376. <div class="markdown level1 remarks">Uses the Equals method and returns the first index at which the object is found
  1377. or -1 if it is not found</div>
  1378. <a id="Terminal_Gui_TreeView_1_GoTo_" data-uid="Terminal.Gui.TreeView`1.GoTo*"></a>
  1379. <h4 id="Terminal_Gui_TreeView_1_GoTo__0_" data-uid="Terminal.Gui.TreeView`1.GoTo(`0)">GoTo(T)</h4>
  1380. <div class="markdown level1 summary">
  1381. Changes the <a class="xref" href="Terminal.Gui.TreeView-1.html#Terminal_Gui_TreeView_1_SelectedObject">SelectedObject</a> to <code data-dev-comment-type="paramref" class="paramref">toSelect</code> and scrolls to ensure
  1382. it is visible. Has no effect if <code data-dev-comment-type="paramref" class="paramref">toSelect</code> is not exposed in the tree (e.g.
  1383. its parents are collapsed)
  1384. </div>
  1385. <div class="markdown level1 conceptual"></div>
  1386. <h5 class="decalaration">Declaration</h5>
  1387. <div class="codewrapper">
  1388. <pre><code class="lang-csharp hljs">public void GoTo(T toSelect)</code></pre>
  1389. </div>
  1390. <h5 class="parameters">Parameters</h5>
  1391. <table class="table table-bordered table-striped table-condensed">
  1392. <thead>
  1393. <tr>
  1394. <th>Type</th>
  1395. <th>Name</th>
  1396. <th>Description</th>
  1397. </tr>
  1398. </thead>
  1399. <tbody>
  1400. <tr>
  1401. <td><span class="xref">T</span></td>
  1402. <td><span class="parametername">toSelect</span></td>
  1403. <td></td>
  1404. </tr>
  1405. </tbody>
  1406. </table>
  1407. <a id="Terminal_Gui_TreeView_1_GoToEnd_" data-uid="Terminal.Gui.TreeView`1.GoToEnd*"></a>
  1408. <h4 id="Terminal_Gui_TreeView_1_GoToEnd" data-uid="Terminal.Gui.TreeView`1.GoToEnd">GoToEnd()</h4>
  1409. <div class="markdown level1 summary">
  1410. Changes the <a class="xref" href="Terminal.Gui.TreeView-1.html#Terminal_Gui_TreeView_1_SelectedObject">SelectedObject</a> to the last object in the tree and scrolls so
  1411. that it is visible
  1412. </div>
  1413. <div class="markdown level1 conceptual"></div>
  1414. <h5 class="decalaration">Declaration</h5>
  1415. <div class="codewrapper">
  1416. <pre><code class="lang-csharp hljs">public void GoToEnd()</code></pre>
  1417. </div>
  1418. <a id="Terminal_Gui_TreeView_1_GoToFirst_" data-uid="Terminal.Gui.TreeView`1.GoToFirst*"></a>
  1419. <h4 id="Terminal_Gui_TreeView_1_GoToFirst" data-uid="Terminal.Gui.TreeView`1.GoToFirst">GoToFirst()</h4>
  1420. <div class="markdown level1 summary">
  1421. Changes the <a class="xref" href="Terminal.Gui.TreeView-1.html#Terminal_Gui_TreeView_1_SelectedObject">SelectedObject</a> to the first root object and resets
  1422. the <a class="xref" href="Terminal.Gui.TreeView-1.html#Terminal_Gui_TreeView_1_ScrollOffsetVertical">ScrollOffsetVertical</a> to 0
  1423. </div>
  1424. <div class="markdown level1 conceptual"></div>
  1425. <h5 class="decalaration">Declaration</h5>
  1426. <div class="codewrapper">
  1427. <pre><code class="lang-csharp hljs">public void GoToFirst()</code></pre>
  1428. </div>
  1429. <a id="Terminal_Gui_TreeView_1_InvalidateLineMap_" data-uid="Terminal.Gui.TreeView`1.InvalidateLineMap*"></a>
  1430. <h4 id="Terminal_Gui_TreeView_1_InvalidateLineMap" data-uid="Terminal.Gui.TreeView`1.InvalidateLineMap">InvalidateLineMap()</h4>
  1431. <div class="markdown level1 summary">
  1432. Clears any cached results of <span class="xref">Terminal.Gui.TreeView`1.BuildLineMap</span>
  1433. </div>
  1434. <div class="markdown level1 conceptual"></div>
  1435. <h5 class="decalaration">Declaration</h5>
  1436. <div class="codewrapper">
  1437. <pre><code class="lang-csharp hljs">protected void InvalidateLineMap()</code></pre>
  1438. </div>
  1439. <a id="Terminal_Gui_TreeView_1_IsExpanded_" data-uid="Terminal.Gui.TreeView`1.IsExpanded*"></a>
  1440. <h4 id="Terminal_Gui_TreeView_1_IsExpanded__0_" data-uid="Terminal.Gui.TreeView`1.IsExpanded(`0)">IsExpanded(T)</h4>
  1441. <div class="markdown level1 summary">
  1442. Returns true if the given object <code data-dev-comment-type="paramref" class="paramref">o</code> is exposed in the tree and
  1443. expanded otherwise false
  1444. </div>
  1445. <div class="markdown level1 conceptual"></div>
  1446. <h5 class="decalaration">Declaration</h5>
  1447. <div class="codewrapper">
  1448. <pre><code class="lang-csharp hljs">public bool IsExpanded(T o)</code></pre>
  1449. </div>
  1450. <h5 class="parameters">Parameters</h5>
  1451. <table class="table table-bordered table-striped table-condensed">
  1452. <thead>
  1453. <tr>
  1454. <th>Type</th>
  1455. <th>Name</th>
  1456. <th>Description</th>
  1457. </tr>
  1458. </thead>
  1459. <tbody>
  1460. <tr>
  1461. <td><span class="xref">T</span></td>
  1462. <td><span class="parametername">o</span></td>
  1463. <td></td>
  1464. </tr>
  1465. </tbody>
  1466. </table>
  1467. <h5 class="returns">Returns</h5>
  1468. <table class="table table-bordered table-striped table-condensed">
  1469. <thead>
  1470. <tr>
  1471. <th>Type</th>
  1472. <th>Description</th>
  1473. </tr>
  1474. </thead>
  1475. <tbody>
  1476. <tr>
  1477. <td><span class="xref">System.Boolean</span></td>
  1478. <td></td>
  1479. </tr>
  1480. </tbody>
  1481. </table>
  1482. <a id="Terminal_Gui_TreeView_1_IsSelected_" data-uid="Terminal.Gui.TreeView`1.IsSelected*"></a>
  1483. <h4 id="Terminal_Gui_TreeView_1_IsSelected__0_" data-uid="Terminal.Gui.TreeView`1.IsSelected(`0)">IsSelected(T)</h4>
  1484. <div class="markdown level1 summary">
  1485. Returns true if the <code data-dev-comment-type="paramref" class="paramref">model</code> is either the
  1486. <a class="xref" href="Terminal.Gui.TreeView-1.html#Terminal_Gui_TreeView_1_SelectedObject">SelectedObject</a> or part of a <a class="xref" href="Terminal.Gui.TreeView-1.html#Terminal_Gui_TreeView_1_MultiSelect">MultiSelect</a>
  1487. </div>
  1488. <div class="markdown level1 conceptual"></div>
  1489. <h5 class="decalaration">Declaration</h5>
  1490. <div class="codewrapper">
  1491. <pre><code class="lang-csharp hljs">public bool IsSelected(T model)</code></pre>
  1492. </div>
  1493. <h5 class="parameters">Parameters</h5>
  1494. <table class="table table-bordered table-striped table-condensed">
  1495. <thead>
  1496. <tr>
  1497. <th>Type</th>
  1498. <th>Name</th>
  1499. <th>Description</th>
  1500. </tr>
  1501. </thead>
  1502. <tbody>
  1503. <tr>
  1504. <td><span class="xref">T</span></td>
  1505. <td><span class="parametername">model</span></td>
  1506. <td></td>
  1507. </tr>
  1508. </tbody>
  1509. </table>
  1510. <h5 class="returns">Returns</h5>
  1511. <table class="table table-bordered table-striped table-condensed">
  1512. <thead>
  1513. <tr>
  1514. <th>Type</th>
  1515. <th>Description</th>
  1516. </tr>
  1517. </thead>
  1518. <tbody>
  1519. <tr>
  1520. <td><span class="xref">System.Boolean</span></td>
  1521. <td></td>
  1522. </tr>
  1523. </tbody>
  1524. </table>
  1525. <a id="Terminal_Gui_TreeView_1_MouseEvent_" data-uid="Terminal.Gui.TreeView`1.MouseEvent*"></a>
  1526. <h4 id="Terminal_Gui_TreeView_1_MouseEvent_Terminal_Gui_MouseEvent_" data-uid="Terminal.Gui.TreeView`1.MouseEvent(Terminal.Gui.MouseEvent)">MouseEvent(MouseEvent)</h4>
  1527. <div class="markdown level1 summary">
  1528. Method invoked when a mouse event is generated
  1529. </div>
  1530. <div class="markdown level1 conceptual"></div>
  1531. <h5 class="decalaration">Declaration</h5>
  1532. <div class="codewrapper">
  1533. <pre><code class="lang-csharp hljs">public override bool MouseEvent(MouseEvent me)</code></pre>
  1534. </div>
  1535. <h5 class="parameters">Parameters</h5>
  1536. <table class="table table-bordered table-striped table-condensed">
  1537. <thead>
  1538. <tr>
  1539. <th>Type</th>
  1540. <th>Name</th>
  1541. <th>Description</th>
  1542. </tr>
  1543. </thead>
  1544. <tbody>
  1545. <tr>
  1546. <td><a class="xref" href="Terminal.Gui.MouseEvent.html">MouseEvent</a></td>
  1547. <td><span class="parametername">me</span></td>
  1548. <td></td>
  1549. </tr>
  1550. </tbody>
  1551. </table>
  1552. <h5 class="returns">Returns</h5>
  1553. <table class="table table-bordered table-striped table-condensed">
  1554. <thead>
  1555. <tr>
  1556. <th>Type</th>
  1557. <th>Description</th>
  1558. </tr>
  1559. </thead>
  1560. <tbody>
  1561. <tr>
  1562. <td><span class="xref">System.Boolean</span></td>
  1563. <td><code>true</code>, if the event was handled, <code>false</code> otherwise.</td>
  1564. </tr>
  1565. </tbody>
  1566. </table>
  1567. <h5 class="overrides">Overrides</h5>
  1568. <div><a class="xref" href="Terminal.Gui.Responder.html#Terminal_Gui_Responder_MouseEvent_Terminal_Gui_MouseEvent_">Responder.MouseEvent(MouseEvent)</a></div>
  1569. <a id="Terminal_Gui_TreeView_1_OnObjectActivated_" data-uid="Terminal.Gui.TreeView`1.OnObjectActivated*"></a>
  1570. <h4 id="Terminal_Gui_TreeView_1_OnObjectActivated_Terminal_Gui_ObjectActivatedEventArgs__0__" data-uid="Terminal.Gui.TreeView`1.OnObjectActivated(Terminal.Gui.ObjectActivatedEventArgs{`0})">OnObjectActivated(ObjectActivatedEventArgs&lt;T&gt;)</h4>
  1571. <div class="markdown level1 summary">
  1572. Raises the <a class="xref" href="Terminal.Gui.TreeView-1.html#Terminal_Gui_TreeView_1_ObjectActivated">ObjectActivated</a> event
  1573. </div>
  1574. <div class="markdown level1 conceptual"></div>
  1575. <h5 class="decalaration">Declaration</h5>
  1576. <div class="codewrapper">
  1577. <pre><code class="lang-csharp hljs">protected virtual void OnObjectActivated(ObjectActivatedEventArgs&lt;T&gt; e)</code></pre>
  1578. </div>
  1579. <h5 class="parameters">Parameters</h5>
  1580. <table class="table table-bordered table-striped table-condensed">
  1581. <thead>
  1582. <tr>
  1583. <th>Type</th>
  1584. <th>Name</th>
  1585. <th>Description</th>
  1586. </tr>
  1587. </thead>
  1588. <tbody>
  1589. <tr>
  1590. <td><a class="xref" href="Terminal.Gui.ObjectActivatedEventArgs-1.html">ObjectActivatedEventArgs</a>&lt;T&gt;</td>
  1591. <td><span class="parametername">e</span></td>
  1592. <td></td>
  1593. </tr>
  1594. </tbody>
  1595. </table>
  1596. <a id="Terminal_Gui_TreeView_1_OnSelectionChanged_" data-uid="Terminal.Gui.TreeView`1.OnSelectionChanged*"></a>
  1597. <h4 id="Terminal_Gui_TreeView_1_OnSelectionChanged_Terminal_Gui_SelectionChangedEventArgs__0__" data-uid="Terminal.Gui.TreeView`1.OnSelectionChanged(Terminal.Gui.SelectionChangedEventArgs{`0})">OnSelectionChanged(SelectionChangedEventArgs&lt;T&gt;)</h4>
  1598. <div class="markdown level1 summary">
  1599. Raises the SelectionChanged event
  1600. </div>
  1601. <div class="markdown level1 conceptual"></div>
  1602. <h5 class="decalaration">Declaration</h5>
  1603. <div class="codewrapper">
  1604. <pre><code class="lang-csharp hljs">protected virtual void OnSelectionChanged(SelectionChangedEventArgs&lt;T&gt; e)</code></pre>
  1605. </div>
  1606. <h5 class="parameters">Parameters</h5>
  1607. <table class="table table-bordered table-striped table-condensed">
  1608. <thead>
  1609. <tr>
  1610. <th>Type</th>
  1611. <th>Name</th>
  1612. <th>Description</th>
  1613. </tr>
  1614. </thead>
  1615. <tbody>
  1616. <tr>
  1617. <td><a class="xref" href="Terminal.Gui.SelectionChangedEventArgs-1.html">SelectionChangedEventArgs</a>&lt;T&gt;</td>
  1618. <td><span class="parametername">e</span></td>
  1619. <td></td>
  1620. </tr>
  1621. </tbody>
  1622. </table>
  1623. <a id="Terminal_Gui_TreeView_1_PositionCursor_" data-uid="Terminal.Gui.TreeView`1.PositionCursor*"></a>
  1624. <h4 id="Terminal_Gui_TreeView_1_PositionCursor" data-uid="Terminal.Gui.TreeView`1.PositionCursor">PositionCursor()</h4>
  1625. <div class="markdown level1 summary">
  1626. Positions the cursor at the start of the selected objects line (if visible)
  1627. </div>
  1628. <div class="markdown level1 conceptual"></div>
  1629. <h5 class="decalaration">Declaration</h5>
  1630. <div class="codewrapper">
  1631. <pre><code class="lang-csharp hljs">public override void PositionCursor()</code></pre>
  1632. </div>
  1633. <h5 class="overrides">Overrides</h5>
  1634. <div><a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_PositionCursor">View.PositionCursor()</a></div>
  1635. <a id="Terminal_Gui_TreeView_1_ProcessKey_" data-uid="Terminal.Gui.TreeView`1.ProcessKey*"></a>
  1636. <h4 id="Terminal_Gui_TreeView_1_ProcessKey_Terminal_Gui_KeyEvent_" data-uid="Terminal.Gui.TreeView`1.ProcessKey(Terminal.Gui.KeyEvent)">ProcessKey(KeyEvent)</h4>
  1637. <div class="markdown level1 summary">
  1638. If the view is focused, gives the view a
  1639. chance to process the keystroke.
  1640. </div>
  1641. <div class="markdown level1 conceptual"></div>
  1642. <h5 class="decalaration">Declaration</h5>
  1643. <div class="codewrapper">
  1644. <pre><code class="lang-csharp hljs">public override bool ProcessKey(KeyEvent keyEvent)</code></pre>
  1645. </div>
  1646. <h5 class="parameters">Parameters</h5>
  1647. <table class="table table-bordered table-striped table-condensed">
  1648. <thead>
  1649. <tr>
  1650. <th>Type</th>
  1651. <th>Name</th>
  1652. <th>Description</th>
  1653. </tr>
  1654. </thead>
  1655. <tbody>
  1656. <tr>
  1657. <td><a class="xref" href="Terminal.Gui.KeyEvent.html">KeyEvent</a></td>
  1658. <td><span class="parametername">keyEvent</span></td>
  1659. <td>Contains the details about the key that produced the event.</td>
  1660. </tr>
  1661. </tbody>
  1662. </table>
  1663. <h5 class="returns">Returns</h5>
  1664. <table class="table table-bordered table-striped table-condensed">
  1665. <thead>
  1666. <tr>
  1667. <th>Type</th>
  1668. <th>Description</th>
  1669. </tr>
  1670. </thead>
  1671. <tbody>
  1672. <tr>
  1673. <td><span class="xref">System.Boolean</span></td>
  1674. <td></td>
  1675. </tr>
  1676. </tbody>
  1677. </table>
  1678. <h5 class="overrides">Overrides</h5>
  1679. <div><a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ProcessKey_Terminal_Gui_KeyEvent_">View.ProcessKey(KeyEvent)</a></div>
  1680. <h5 id="Terminal_Gui_TreeView_1_ProcessKey_Terminal_Gui_KeyEvent__remarks">Remarks</h5>
  1681. <div class="markdown level1 remarks">
  1682. <p>
  1683. Views can override this method if they are
  1684. interested in processing the given keystroke.
  1685. If they consume the keystroke, they must
  1686. return true to stop the keystroke from being
  1687. processed by other widgets or consumed by the
  1688. widget engine. If they return false, the
  1689. keystroke will be passed using the ProcessColdKey
  1690. method to other views to process.
  1691. </p>
  1692. <p>
  1693. The View implementation does nothing but return false,
  1694. so it is not necessary to call base.ProcessKey if you
  1695. derive directly from View, but you should if you derive
  1696. other View subclasses.
  1697. </p>
  1698. </div>
  1699. <a id="Terminal_Gui_TreeView_1_RebuildTree_" data-uid="Terminal.Gui.TreeView`1.RebuildTree*"></a>
  1700. <h4 id="Terminal_Gui_TreeView_1_RebuildTree" data-uid="Terminal.Gui.TreeView`1.RebuildTree">RebuildTree()</h4>
  1701. <div class="markdown level1 summary">
  1702. Rebuilds the tree structure for all exposed objects starting with the root objects.
  1703. Call this method when you know there are changes to the tree but don&apos;t know which
  1704. objects have changed (otherwise use <a class="xref" href="Terminal.Gui.TreeView-1.html#Terminal_Gui_TreeView_1_RefreshObject__0_System_Boolean_">RefreshObject(T, Boolean)</a>)
  1705. </div>
  1706. <div class="markdown level1 conceptual"></div>
  1707. <h5 class="decalaration">Declaration</h5>
  1708. <div class="codewrapper">
  1709. <pre><code class="lang-csharp hljs">public void RebuildTree()</code></pre>
  1710. </div>
  1711. <a id="Terminal_Gui_TreeView_1_Redraw_" data-uid="Terminal.Gui.TreeView`1.Redraw*"></a>
  1712. <h4 id="Terminal_Gui_TreeView_1_Redraw_Terminal_Gui_Rect_" data-uid="Terminal.Gui.TreeView`1.Redraw(Terminal.Gui.Rect)">Redraw(Rect)</h4>
  1713. <div class="markdown level1 summary">
  1714. Redraws this view and its subviews; only redraws the views that have been flagged for a re-display.
  1715. </div>
  1716. <div class="markdown level1 conceptual"></div>
  1717. <h5 class="decalaration">Declaration</h5>
  1718. <div class="codewrapper">
  1719. <pre><code class="lang-csharp hljs">public override void Redraw(Rect bounds)</code></pre>
  1720. </div>
  1721. <h5 class="parameters">Parameters</h5>
  1722. <table class="table table-bordered table-striped table-condensed">
  1723. <thead>
  1724. <tr>
  1725. <th>Type</th>
  1726. <th>Name</th>
  1727. <th>Description</th>
  1728. </tr>
  1729. </thead>
  1730. <tbody>
  1731. <tr>
  1732. <td><a class="xref" href="Terminal.Gui.Rect.html">Rect</a></td>
  1733. <td><span class="parametername">bounds</span></td>
  1734. <td>The bounds (view-relative region) to redraw.</td>
  1735. </tr>
  1736. </tbody>
  1737. </table>
  1738. <h5 class="overrides">Overrides</h5>
  1739. <div><a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Redraw_Terminal_Gui_Rect_">View.Redraw(Rect)</a></div>
  1740. <h5 id="Terminal_Gui_TreeView_1_Redraw_Terminal_Gui_Rect__remarks">Remarks</h5>
  1741. <div class="markdown level1 remarks">
  1742. <p>
  1743. Always use <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Bounds">Bounds</a> (view-relative) when calling <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Redraw_Terminal_Gui_Rect_">Redraw(Rect)</a>, NOT <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Frame">Frame</a> (superview-relative).
  1744. </p>
  1745. <p>
  1746. Views should set the color that they want to use on entry, as otherwise this will inherit
  1747. the last color that was set globally on the driver.
  1748. </p>
  1749. <p>
  1750. Overrides of <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Redraw_Terminal_Gui_Rect_">Redraw(Rect)</a> must ensure they do not set <code>Driver.Clip</code> to a clip region
  1751. larger than the <code>region</code> parameter.
  1752. </p>
  1753. </div>
  1754. <a id="Terminal_Gui_TreeView_1_RefreshObject_" data-uid="Terminal.Gui.TreeView`1.RefreshObject*"></a>
  1755. <h4 id="Terminal_Gui_TreeView_1_RefreshObject__0_System_Boolean_" data-uid="Terminal.Gui.TreeView`1.RefreshObject(`0,System.Boolean)">RefreshObject(T, Boolean)</h4>
  1756. <div class="markdown level1 summary">
  1757. Refreshes the state of the object <code data-dev-comment-type="paramref" class="paramref">o</code> in the tree. This will
  1758. recompute children, string representation etc
  1759. </div>
  1760. <div class="markdown level1 conceptual"></div>
  1761. <h5 class="decalaration">Declaration</h5>
  1762. <div class="codewrapper">
  1763. <pre><code class="lang-csharp hljs">public void RefreshObject(T o, bool startAtTop = false)</code></pre>
  1764. </div>
  1765. <h5 class="parameters">Parameters</h5>
  1766. <table class="table table-bordered table-striped table-condensed">
  1767. <thead>
  1768. <tr>
  1769. <th>Type</th>
  1770. <th>Name</th>
  1771. <th>Description</th>
  1772. </tr>
  1773. </thead>
  1774. <tbody>
  1775. <tr>
  1776. <td><span class="xref">T</span></td>
  1777. <td><span class="parametername">o</span></td>
  1778. <td></td>
  1779. </tr>
  1780. <tr>
  1781. <td><span class="xref">System.Boolean</span></td>
  1782. <td><span class="parametername">startAtTop</span></td>
  1783. <td>True to also refresh all ancestors of the objects branch
  1784. (starting with the root). False to refresh only the passed node</td>
  1785. </tr>
  1786. </tbody>
  1787. </table>
  1788. <h5 id="Terminal_Gui_TreeView_1_RefreshObject__0_System_Boolean__remarks">Remarks</h5>
  1789. <div class="markdown level1 remarks">This has no effect if the object is not exposed in the tree.</div>
  1790. <a id="Terminal_Gui_TreeView_1_Remove_" data-uid="Terminal.Gui.TreeView`1.Remove*"></a>
  1791. <h4 id="Terminal_Gui_TreeView_1_Remove__0_" data-uid="Terminal.Gui.TreeView`1.Remove(`0)">Remove(T)</h4>
  1792. <div class="markdown level1 summary">
  1793. Removes the given root object from the tree
  1794. </div>
  1795. <div class="markdown level1 conceptual"></div>
  1796. <h5 class="decalaration">Declaration</h5>
  1797. <div class="codewrapper">
  1798. <pre><code class="lang-csharp hljs">public void Remove(T o)</code></pre>
  1799. </div>
  1800. <h5 class="parameters">Parameters</h5>
  1801. <table class="table table-bordered table-striped table-condensed">
  1802. <thead>
  1803. <tr>
  1804. <th>Type</th>
  1805. <th>Name</th>
  1806. <th>Description</th>
  1807. </tr>
  1808. </thead>
  1809. <tbody>
  1810. <tr>
  1811. <td><span class="xref">T</span></td>
  1812. <td><span class="parametername">o</span></td>
  1813. <td></td>
  1814. </tr>
  1815. </tbody>
  1816. </table>
  1817. <h5 id="Terminal_Gui_TreeView_1_Remove__0__remarks">Remarks</h5>
  1818. <div class="markdown level1 remarks">If <code data-dev-comment-type="paramref" class="paramref">o</code> is the currently <a class="xref" href="Terminal.Gui.TreeView-1.html#Terminal_Gui_TreeView_1_SelectedObject">SelectedObject</a> then the
  1819. selection is cleared</div>
  1820. <a id="Terminal_Gui_TreeView_1_SelectAll_" data-uid="Terminal.Gui.TreeView`1.SelectAll*"></a>
  1821. <h4 id="Terminal_Gui_TreeView_1_SelectAll" data-uid="Terminal.Gui.TreeView`1.SelectAll">SelectAll()</h4>
  1822. <div class="markdown level1 summary">
  1823. Selects all objects in the tree when <a class="xref" href="Terminal.Gui.TreeView-1.html#Terminal_Gui_TreeView_1_MultiSelect">MultiSelect</a> is enabled otherwise
  1824. does nothing
  1825. </div>
  1826. <div class="markdown level1 conceptual"></div>
  1827. <h5 class="decalaration">Declaration</h5>
  1828. <div class="codewrapper">
  1829. <pre><code class="lang-csharp hljs">public void SelectAll()</code></pre>
  1830. </div>
  1831. <h3 id="events">Events
  1832. </h3>
  1833. <h4 id="Terminal_Gui_TreeView_1_ObjectActivated" data-uid="Terminal.Gui.TreeView`1.ObjectActivated">ObjectActivated</h4>
  1834. <div class="markdown level1 summary">
  1835. This event is raised when an object is activated e.g. by double clicking or
  1836. pressing <a class="xref" href="Terminal.Gui.TreeView-1.html#Terminal_Gui_TreeView_1_ObjectActivationKey">ObjectActivationKey</a>
  1837. </div>
  1838. <div class="markdown level1 conceptual"></div>
  1839. <h5 class="decalaration">Declaration</h5>
  1840. <div class="codewrapper">
  1841. <pre><code class="lang-csharp hljs">public event Action&lt;ObjectActivatedEventArgs&lt;T&gt;&gt; ObjectActivated</code></pre>
  1842. </div>
  1843. <h5 class="eventType">Event Type</h5>
  1844. <table class="table table-bordered table-striped table-condensed">
  1845. <thead>
  1846. <tr>
  1847. <th>Type</th>
  1848. <th>Description</th>
  1849. </tr>
  1850. </thead>
  1851. <tbody>
  1852. <tr>
  1853. <td><span class="xref">System.Action</span>&lt;<a class="xref" href="Terminal.Gui.ObjectActivatedEventArgs-1.html">ObjectActivatedEventArgs</a>&lt;T&gt;&gt;</td>
  1854. <td></td>
  1855. </tr>
  1856. </tbody>
  1857. </table>
  1858. <h4 id="Terminal_Gui_TreeView_1_SelectionChanged" data-uid="Terminal.Gui.TreeView`1.SelectionChanged">SelectionChanged</h4>
  1859. <div class="markdown level1 summary">
  1860. Called when the <a class="xref" href="Terminal.Gui.TreeView-1.html#Terminal_Gui_TreeView_1_SelectedObject">SelectedObject</a> changes
  1861. </div>
  1862. <div class="markdown level1 conceptual"></div>
  1863. <h5 class="decalaration">Declaration</h5>
  1864. <div class="codewrapper">
  1865. <pre><code class="lang-csharp hljs">public event EventHandler&lt;SelectionChangedEventArgs&lt;T&gt;&gt; SelectionChanged</code></pre>
  1866. </div>
  1867. <h5 class="eventType">Event Type</h5>
  1868. <table class="table table-bordered table-striped table-condensed">
  1869. <thead>
  1870. <tr>
  1871. <th>Type</th>
  1872. <th>Description</th>
  1873. </tr>
  1874. </thead>
  1875. <tbody>
  1876. <tr>
  1877. <td><span class="xref">System.EventHandler</span>&lt;<a class="xref" href="Terminal.Gui.SelectionChangedEventArgs-1.html">SelectionChangedEventArgs</a>&lt;T&gt;&gt;</td>
  1878. <td></td>
  1879. </tr>
  1880. </tbody>
  1881. </table>
  1882. <h3 id="implements">Implements</h3>
  1883. <div>
  1884. <span class="xref">System.IDisposable</span>
  1885. </div>
  1886. <div>
  1887. <span class="xref">System.ComponentModel.ISupportInitializeNotification</span>
  1888. </div>
  1889. <div>
  1890. <span class="xref">System.ComponentModel.ISupportInitialize</span>
  1891. </div>
  1892. <div>
  1893. <a class="xref" href="Terminal.Gui.ITreeView.html">ITreeView</a>
  1894. </div>
  1895. </article>
  1896. </div>
  1897. <div class="hidden-sm col-md-2" role="complementary">
  1898. <div class="sideaffix">
  1899. <div class="contribution">
  1900. <ul class="nav">
  1901. </ul>
  1902. </div>
  1903. <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
  1904. <h5>In This Article</h5>
  1905. <div></div>
  1906. </nav>
  1907. </div>
  1908. </div>
  1909. </div>
  1910. </div>
  1911. <footer>
  1912. <div class="grad-bottom"></div>
  1913. <div class="footer">
  1914. <div class="container">
  1915. <span class="pull-right">
  1916. <a href="#top">Back to top</a>
  1917. </span>
  1918. <span>Generated by <strong>DocFX</strong></span>
  1919. </div>
  1920. </div>
  1921. </footer>
  1922. </div>
  1923. <script type="text/javascript" src="../../styles/docfx.vendor.js"></script>
  1924. <script type="text/javascript" src="../../styles/docfx.js"></script>
  1925. <script type="text/javascript" src="../../styles/main.js"></script>
  1926. </body>
  1927. </html>