Terminal.Gui.TreeView-1.html 97 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375
  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.59.3.0">
  13. <link rel="shortcut icon" href="../../favicon.ico">
  14. <link rel="stylesheet" href="../../styles/docfx.vendor.css">
  15. <link rel="stylesheet" href="../../styles/docfx.css">
  16. <link rel="stylesheet" href="../../styles/main.css">
  17. <link href="https://fonts.googleapis.com/css?family=Source Sans Pro" rel="stylesheet">
  18. <link href="https://fonts.googleapis.com/css?family=Source Code Pro" rel="stylesheet">
  19. <meta property="docfx:navrel" content="../../toc.html">
  20. <meta property="docfx:tocrel" content="toc.html">
  21. <meta property="docfx:rel" content="../../">
  22. </head> <body data-spy="scroll" data-target="#affix" data-offset="120">
  23. <div id="wrapper">
  24. <header>
  25. <nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation">
  26. <div class="container">
  27. <div class="navbar-header">
  28. <button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
  29. <span class="sr-only">Toggle navigation</span>
  30. <span class="icon-bar"></span>
  31. <span class="icon-bar"></span>
  32. <span class="icon-bar"></span>
  33. </button>
  34. <a class="navbar-brand" href="../../index.html">
  35. <img id="logo" class="svg" src="../../images/logo48.png" alt="">
  36. </a>
  37. </div>
  38. <div class="collapse navbar-collapse" id="navbar">
  39. <form class="navbar-form navbar-right" role="search" id="search">
  40. <div class="form-group">
  41. <input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">
  42. </div>
  43. </form>
  44. </div>
  45. </div>
  46. </nav>
  47. <div class="subnav navbar navbar-default">
  48. <div class="container hide-when-search" id="breadcrumb">
  49. <ul class="breadcrumb">
  50. <li></li>
  51. </ul>
  52. </div>
  53. </div>
  54. </header>
  55. <div class="container body-content">
  56. <div id="search-results">
  57. <div class="search-list">Search Results for <span></span></div>
  58. <div class="sr-items">
  59. <p><i class="glyphicon glyphicon-refresh index-loading"></i></p>
  60. </div>
  61. <ul id="pagination" data-first="First" data-prev="Previous" data-next="Next" data-last="Last"></ul>
  62. </div>
  63. </div>
  64. <div role="main" class="container body-content hide-when-search">
  65. <div class="sidenav hide-when-search">
  66. <a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
  67. <div class="sidetoggle collapse" id="sidetoggle">
  68. <div id="sidetoc"></div>
  69. </div>
  70. </div>
  71. <div class="article row grid-right">
  72. <div class="col-md-10">
  73. <article class="content wrap" id="_content" data-uid="Terminal.Gui.TreeView`1">
  74. <h1 id="Terminal_Gui_TreeView_1" data-uid="Terminal.Gui.TreeView`1" class="text-break">Class TreeView&lt;T&gt;
  75. </h1>
  76. <div class="markdown level0 summary">
  77. Hierarchical tree view with expandable branches. Branch objects are dynamically determined
  78. when expanded using a user defined <a class="xref" href="Terminal.Gui.Trees.ITreeBuilder-1.html">ITreeBuilder&lt;T&gt;</a>
  79. <a href="https://migueldeicaza.github.io/gui.cs/articles/treeview.html">See TreeView Deep Dive for more information</a>.
  80. </div>
  81. <div class="markdown level0 conceptual"></div>
  82. <div class="inheritance">
  83. <h5>Inheritance</h5>
  84. <div class="level0"><span class="xref">System.Object</span></div>
  85. <div class="level1"><a class="xref" href="Terminal.Gui.Responder.html">Responder</a></div>
  86. <div class="level2"><a class="xref" href="Terminal.Gui.View.html">View</a></div>
  87. <div class="level3"><span class="xref">TreeView&lt;T&gt;</span></div>
  88. <div class="level4"><a class="xref" href="Terminal.Gui.TreeView.html">TreeView</a></div>
  89. </div>
  90. <div class="implements">
  91. <h5>Implements</h5>
  92. <div><span class="xref">System.IDisposable</span></div>
  93. <div><span class="xref">System.ComponentModel.ISupportInitializeNotification</span></div>
  94. <div><span class="xref">System.ComponentModel.ISupportInitialize</span></div>
  95. <div><a class="xref" href="Terminal.Gui.ITreeView.html">ITreeView</a></div>
  96. </div>
  97. <div class="inheritedMembers">
  98. <h5>Inherited Members</h5>
  99. <div>
  100. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_GetMinWidthHeight_Terminal_Gui_Size__">View.GetMinWidthHeight(Size)</a>
  101. </div>
  102. <div>
  103. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SetMinWidthHeight">View.SetMinWidthHeight()</a>
  104. </div>
  105. <div>
  106. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_UpdateTextFormatterText">View.UpdateTextFormatterText()</a>
  107. </div>
  108. <div>
  109. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ProcessResizeView">View.ProcessResizeView()</a>
  110. </div>
  111. <div>
  112. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SetNeedsDisplay">View.SetNeedsDisplay()</a>
  113. </div>
  114. <div>
  115. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ClearLayoutNeeded">View.ClearLayoutNeeded()</a>
  116. </div>
  117. <div>
  118. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SetNeedsDisplay_Terminal_Gui_Rect_">View.SetNeedsDisplay(Rect)</a>
  119. </div>
  120. <div>
  121. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SetChildNeedsDisplay">View.SetChildNeedsDisplay()</a>
  122. </div>
  123. <div>
  124. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Add_Terminal_Gui_View_">View.Add(View)</a>
  125. </div>
  126. <div>
  127. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Add_Terminal_Gui_View___">View.Add(View[])</a>
  128. </div>
  129. <div>
  130. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_RemoveAll">View.RemoveAll()</a>
  131. </div>
  132. <div>
  133. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Remove_Terminal_Gui_View_">View.Remove(View)</a>
  134. </div>
  135. <div>
  136. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_BringSubviewToFront_Terminal_Gui_View_">View.BringSubviewToFront(View)</a>
  137. </div>
  138. <div>
  139. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SendSubviewToBack_Terminal_Gui_View_">View.SendSubviewToBack(View)</a>
  140. </div>
  141. <div>
  142. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SendSubviewBackwards_Terminal_Gui_View_">View.SendSubviewBackwards(View)</a>
  143. </div>
  144. <div>
  145. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_BringSubviewForward_Terminal_Gui_View_">View.BringSubviewForward(View)</a>
  146. </div>
  147. <div>
  148. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Clear">View.Clear()</a>
  149. </div>
  150. <div>
  151. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Clear_Terminal_Gui_Rect_">View.Clear(Rect)</a>
  152. </div>
  153. <div>
  154. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ScreenToView_System_Int32_System_Int32_">View.ScreenToView(Int32, Int32)</a>
  155. </div>
  156. <div>
  157. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ClipToBounds">View.ClipToBounds()</a>
  158. </div>
  159. <div>
  160. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SetClip_Terminal_Gui_Rect_">View.SetClip(Rect)</a>
  161. </div>
  162. <div>
  163. <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>
  164. </div>
  165. <div>
  166. <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>
  167. </div>
  168. <div>
  169. <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>
  170. </div>
  171. <div>
  172. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Move_System_Int32_System_Int32_System_Boolean_">View.Move(Int32, Int32, Boolean)</a>
  173. </div>
  174. <div>
  175. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnAdded_Terminal_Gui_View_">View.OnAdded(View)</a>
  176. </div>
  177. <div>
  178. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnRemoved_Terminal_Gui_View_">View.OnRemoved(View)</a>
  179. </div>
  180. <div>
  181. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnLeave_Terminal_Gui_View_">View.OnLeave(View)</a>
  182. </div>
  183. <div>
  184. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_AddRune_System_Int32_System_Int32_System_Rune_">View.AddRune(Int32, Int32, Rune)</a>
  185. </div>
  186. <div>
  187. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ClearNeedsDisplay">View.ClearNeedsDisplay()</a>
  188. </div>
  189. <div>
  190. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnDrawContent_Terminal_Gui_Rect_">View.OnDrawContent(Rect)</a>
  191. </div>
  192. <div>
  193. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnDrawContentComplete_Terminal_Gui_Rect_">View.OnDrawContentComplete(Rect)</a>
  194. </div>
  195. <div>
  196. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SetFocus">View.SetFocus()</a>
  197. </div>
  198. <div>
  199. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_InvokeKeybindings_Terminal_Gui_KeyEvent_">View.InvokeKeybindings(KeyEvent)</a>
  200. </div>
  201. <div>
  202. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_AddKeyBinding_Terminal_Gui_Key_Terminal_Gui_Command_">View.AddKeyBinding(Key, Command)</a>
  203. </div>
  204. <div>
  205. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ReplaceKeyBinding_Terminal_Gui_Key_Terminal_Gui_Key_">View.ReplaceKeyBinding(Key, Key)</a>
  206. </div>
  207. <div>
  208. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ContainsKeyBinding_Terminal_Gui_Key_">View.ContainsKeyBinding(Key)</a>
  209. </div>
  210. <div>
  211. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ClearKeybindings">View.ClearKeybindings()</a>
  212. </div>
  213. <div>
  214. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ClearKeybinding_Terminal_Gui_Key_">View.ClearKeybinding(Key)</a>
  215. </div>
  216. <div>
  217. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ClearKeybinding_Terminal_Gui_Command_">View.ClearKeybinding(Command)</a>
  218. </div>
  219. <div>
  220. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_AddCommand_Terminal_Gui_Command_System_Func_System_Nullable_System_Boolean___">View.AddCommand(Command, Func&lt;Nullable&lt;Boolean&gt;&gt;)</a>
  221. </div>
  222. <div>
  223. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_GetSupportedCommands">View.GetSupportedCommands()</a>
  224. </div>
  225. <div>
  226. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_GetKeyFromCommand_Terminal_Gui_Command_">View.GetKeyFromCommand(Command)</a>
  227. </div>
  228. <div>
  229. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ProcessHotKey_Terminal_Gui_KeyEvent_">View.ProcessHotKey(KeyEvent)</a>
  230. </div>
  231. <div>
  232. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ProcessColdKey_Terminal_Gui_KeyEvent_">View.ProcessColdKey(KeyEvent)</a>
  233. </div>
  234. <div>
  235. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnKeyDown_Terminal_Gui_KeyEvent_">View.OnKeyDown(KeyEvent)</a>
  236. </div>
  237. <div>
  238. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnKeyUp_Terminal_Gui_KeyEvent_">View.OnKeyUp(KeyEvent)</a>
  239. </div>
  240. <div>
  241. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_EnsureFocus">View.EnsureFocus()</a>
  242. </div>
  243. <div>
  244. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_FocusFirst">View.FocusFirst()</a>
  245. </div>
  246. <div>
  247. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_FocusLast">View.FocusLast()</a>
  248. </div>
  249. <div>
  250. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_FocusPrev">View.FocusPrev()</a>
  251. </div>
  252. <div>
  253. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_FocusNext">View.FocusNext()</a>
  254. </div>
  255. <div>
  256. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_LayoutSubviews">View.LayoutSubviews()</a>
  257. </div>
  258. <div>
  259. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ToString">View.ToString()</a>
  260. </div>
  261. <div>
  262. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_GetAutoSize">View.GetAutoSize()</a>
  263. </div>
  264. <div>
  265. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_GetHotKeySpecifierLength_System_Boolean_">View.GetHotKeySpecifierLength(Boolean)</a>
  266. </div>
  267. <div>
  268. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_GetTextFormatterBoundsSize">View.GetTextFormatterBoundsSize()</a>
  269. </div>
  270. <div>
  271. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_GetBoundsTextFormatterSize">View.GetBoundsTextFormatterSize()</a>
  272. </div>
  273. <div>
  274. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnMouseEnter_Terminal_Gui_MouseEvent_">View.OnMouseEnter(MouseEvent)</a>
  275. </div>
  276. <div>
  277. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnMouseLeave_Terminal_Gui_MouseEvent_">View.OnMouseLeave(MouseEvent)</a>
  278. </div>
  279. <div>
  280. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnMouseEvent_Terminal_Gui_MouseEvent_">View.OnMouseEvent(MouseEvent)</a>
  281. </div>
  282. <div>
  283. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnMouseClick_Terminal_Gui_View_MouseEventArgs_">View.OnMouseClick(View.MouseEventArgs)</a>
  284. </div>
  285. <div>
  286. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnCanFocusChanged">View.OnCanFocusChanged()</a>
  287. </div>
  288. <div>
  289. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnEnabledChanged">View.OnEnabledChanged()</a>
  290. </div>
  291. <div>
  292. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnVisibleChanged">View.OnVisibleChanged()</a>
  293. </div>
  294. <div>
  295. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Dispose_System_Boolean_">View.Dispose(Boolean)</a>
  296. </div>
  297. <div>
  298. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_BeginInit">View.BeginInit()</a>
  299. </div>
  300. <div>
  301. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_EndInit">View.EndInit()</a>
  302. </div>
  303. <div>
  304. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SetWidth_System_Int32_System_Int32__">View.SetWidth(Int32, Int32)</a>
  305. </div>
  306. <div>
  307. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SetHeight_System_Int32_System_Int32__">View.SetHeight(Int32, Int32)</a>
  308. </div>
  309. <div>
  310. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_GetCurrentWidth_System_Int32__">View.GetCurrentWidth(Int32)</a>
  311. </div>
  312. <div>
  313. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_GetCurrentHeight_System_Int32__">View.GetCurrentHeight(Int32)</a>
  314. </div>
  315. <div>
  316. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_GetNormalColor">View.GetNormalColor()</a>
  317. </div>
  318. <div>
  319. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_GetTopSuperView">View.GetTopSuperView()</a>
  320. </div>
  321. <div>
  322. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_HotKey">View.HotKey</a>
  323. </div>
  324. <div>
  325. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_HotKeySpecifier">View.HotKeySpecifier</a>
  326. </div>
  327. <div>
  328. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Shortcut">View.Shortcut</a>
  329. </div>
  330. <div>
  331. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ShortcutTag">View.ShortcutTag</a>
  332. </div>
  333. <div>
  334. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ShortcutAction">View.ShortcutAction</a>
  335. </div>
  336. <div>
  337. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Data">View.Data</a>
  338. </div>
  339. <div>
  340. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Driver">View.Driver</a>
  341. </div>
  342. <div>
  343. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Subviews">View.Subviews</a>
  344. </div>
  345. <div>
  346. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_TabIndexes">View.TabIndexes</a>
  347. </div>
  348. <div>
  349. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_TabIndex">View.TabIndex</a>
  350. </div>
  351. <div>
  352. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_TabStop">View.TabStop</a>
  353. </div>
  354. <div>
  355. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_CanFocus">View.CanFocus</a>
  356. </div>
  357. <div>
  358. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Id">View.Id</a>
  359. </div>
  360. <div>
  361. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_IsCurrentTop">View.IsCurrentTop</a>
  362. </div>
  363. <div>
  364. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_WantMousePositionReports">View.WantMousePositionReports</a>
  365. </div>
  366. <div>
  367. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_WantContinuousButtonPressed">View.WantContinuousButtonPressed</a>
  368. </div>
  369. <div>
  370. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Frame">View.Frame</a>
  371. </div>
  372. <div>
  373. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_LayoutStyle">View.LayoutStyle</a>
  374. </div>
  375. <div>
  376. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Bounds">View.Bounds</a>
  377. </div>
  378. <div>
  379. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_X">View.X</a>
  380. </div>
  381. <div>
  382. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Y">View.Y</a>
  383. </div>
  384. <div>
  385. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Width">View.Width</a>
  386. </div>
  387. <div>
  388. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Height">View.Height</a>
  389. </div>
  390. <div>
  391. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ForceValidatePosDim">View.ForceValidatePosDim</a>
  392. </div>
  393. <div>
  394. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_TextFormatter">View.TextFormatter</a>
  395. </div>
  396. <div>
  397. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SuperView">View.SuperView</a>
  398. </div>
  399. <div>
  400. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_HasFocus">View.HasFocus</a>
  401. </div>
  402. <div>
  403. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Focused">View.Focused</a>
  404. </div>
  405. <div>
  406. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_MostFocused">View.MostFocused</a>
  407. </div>
  408. <div>
  409. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ColorScheme">View.ColorScheme</a>
  410. </div>
  411. <div>
  412. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Text">View.Text</a>
  413. </div>
  414. <div>
  415. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_AutoSize">View.AutoSize</a>
  416. </div>
  417. <div>
  418. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_PreserveTrailingSpaces">View.PreserveTrailingSpaces</a>
  419. </div>
  420. <div>
  421. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_TextAlignment">View.TextAlignment</a>
  422. </div>
  423. <div>
  424. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_VerticalTextAlignment">View.VerticalTextAlignment</a>
  425. </div>
  426. <div>
  427. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_TextDirection">View.TextDirection</a>
  428. </div>
  429. <div>
  430. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_IsInitialized">View.IsInitialized</a>
  431. </div>
  432. <div>
  433. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_IsAdded">View.IsAdded</a>
  434. </div>
  435. <div>
  436. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Enabled">View.Enabled</a>
  437. </div>
  438. <div>
  439. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Visible">View.Visible</a>
  440. </div>
  441. <div>
  442. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Border">View.Border</a>
  443. </div>
  444. <div>
  445. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Added">View.Added</a>
  446. </div>
  447. <div>
  448. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Removed">View.Removed</a>
  449. </div>
  450. <div>
  451. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Enter">View.Enter</a>
  452. </div>
  453. <div>
  454. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Leave">View.Leave</a>
  455. </div>
  456. <div>
  457. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_MouseEnter">View.MouseEnter</a>
  458. </div>
  459. <div>
  460. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_MouseLeave">View.MouseLeave</a>
  461. </div>
  462. <div>
  463. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_MouseClick">View.MouseClick</a>
  464. </div>
  465. <div>
  466. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_CanFocusChanged">View.CanFocusChanged</a>
  467. </div>
  468. <div>
  469. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_EnabledChanged">View.EnabledChanged</a>
  470. </div>
  471. <div>
  472. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_VisibleChanged">View.VisibleChanged</a>
  473. </div>
  474. <div>
  475. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_HotKeyChanged">View.HotKeyChanged</a>
  476. </div>
  477. <div>
  478. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_DrawContent">View.DrawContent</a>
  479. </div>
  480. <div>
  481. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_DrawContentComplete">View.DrawContentComplete</a>
  482. </div>
  483. <div>
  484. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_KeyPress">View.KeyPress</a>
  485. </div>
  486. <div>
  487. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_KeyDown">View.KeyDown</a>
  488. </div>
  489. <div>
  490. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_KeyUp">View.KeyUp</a>
  491. </div>
  492. <div>
  493. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_LayoutStarted">View.LayoutStarted</a>
  494. </div>
  495. <div>
  496. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_LayoutComplete">View.LayoutComplete</a>
  497. </div>
  498. <div>
  499. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Initialized">View.Initialized</a>
  500. </div>
  501. <div>
  502. <a class="xref" href="Terminal.Gui.Responder.html#Terminal_Gui_Responder_Dispose">Responder.Dispose()</a>
  503. </div>
  504. </div>
  505. <h6><strong>Namespace</strong>: <a class="xref" href="Terminal.Gui.html">Terminal.Gui</a></h6>
  506. <h6><strong>Assembly</strong>: Terminal.Gui.dll</h6>
  507. <h5 id="Terminal_Gui_TreeView_1_syntax">Syntax</h5>
  508. <div class="codewrapper">
  509. <pre><code class="lang-csharp hljs">public class TreeView&lt;T&gt; : View, ITreeView where T : class</code></pre>
  510. </div>
  511. <h5 class="typeParameters">Type Parameters</h5>
  512. <table class="table table-bordered table-striped table-condensed">
  513. <thead>
  514. <tr>
  515. <th>Name</th>
  516. <th>Description</th>
  517. </tr>
  518. </thead>
  519. <tbody>
  520. <tr>
  521. <td><span class="parametername">T</span></td>
  522. <td></td>
  523. </tr>
  524. </tbody>
  525. </table>
  526. <h3 id="constructors">Constructors
  527. </h3>
  528. <a id="Terminal_Gui_TreeView_1__ctor_" data-uid="Terminal.Gui.TreeView`1.#ctor*"></a>
  529. <h4 id="Terminal_Gui_TreeView_1__ctor" data-uid="Terminal.Gui.TreeView`1.#ctor">TreeView()</h4>
  530. <div class="markdown level1 summary">
  531. Creates a new tree view with absolute positioning.
  532. 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.
  533. Children will not be rendered until you set <a class="xref" href="Terminal.Gui.TreeView-1.html#Terminal_Gui_TreeView_1_TreeBuilder">TreeBuilder</a>
  534. </div>
  535. <div class="markdown level1 conceptual"></div>
  536. <h5 class="decalaration">Declaration</h5>
  537. <div class="codewrapper">
  538. <pre><code class="lang-csharp hljs">public TreeView()</code></pre>
  539. </div>
  540. <a id="Terminal_Gui_TreeView_1__ctor_" data-uid="Terminal.Gui.TreeView`1.#ctor*"></a>
  541. <h4 id="Terminal_Gui_TreeView_1__ctor_Terminal_Gui_Trees_ITreeBuilder__0__" data-uid="Terminal.Gui.TreeView`1.#ctor(Terminal.Gui.Trees.ITreeBuilder{`0})">TreeView(ITreeBuilder&lt;T&gt;)</h4>
  542. <div class="markdown level1 summary">
  543. Initialises <a class="xref" href="Terminal.Gui.TreeView-1.html#Terminal_Gui_TreeView_1_TreeBuilder">TreeBuilder</a>.Creates a new tree view with absolute
  544. 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
  545. objects for the tree.
  546. </div>
  547. <div class="markdown level1 conceptual"></div>
  548. <h5 class="decalaration">Declaration</h5>
  549. <div class="codewrapper">
  550. <pre><code class="lang-csharp hljs">public TreeView(ITreeBuilder&lt;T&gt; builder)</code></pre>
  551. </div>
  552. <h5 class="parameters">Parameters</h5>
  553. <table class="table table-bordered table-striped table-condensed">
  554. <thead>
  555. <tr>
  556. <th>Type</th>
  557. <th>Name</th>
  558. <th>Description</th>
  559. </tr>
  560. </thead>
  561. <tbody>
  562. <tr>
  563. <td><a class="xref" href="Terminal.Gui.Trees.ITreeBuilder-1.html">ITreeBuilder</a>&lt;T&gt;</td>
  564. <td><span class="parametername">builder</span></td>
  565. <td></td>
  566. </tr>
  567. </tbody>
  568. </table>
  569. <h3 id="fields">Fields
  570. </h3>
  571. <h4 id="Terminal_Gui_TreeView_1_NoBuilderError" data-uid="Terminal.Gui.TreeView`1.NoBuilderError">NoBuilderError</h4>
  572. <div class="markdown level1 summary">
  573. Error message to display when the control is not properly initialized at draw time
  574. (nodes added but no tree builder set)
  575. </div>
  576. <div class="markdown level1 conceptual"></div>
  577. <h5 class="decalaration">Declaration</h5>
  578. <div class="codewrapper">
  579. <pre><code class="lang-csharp hljs">public static ustring NoBuilderError</code></pre>
  580. </div>
  581. <h5 class="fieldValue">Field Value</h5>
  582. <table class="table table-bordered table-striped table-condensed">
  583. <thead>
  584. <tr>
  585. <th>Type</th>
  586. <th>Description</th>
  587. </tr>
  588. </thead>
  589. <tbody>
  590. <tr>
  591. <td><span class="xref">NStack.ustring</span></td>
  592. <td></td>
  593. </tr>
  594. </tbody>
  595. </table>
  596. <h3 id="properties">Properties
  597. </h3>
  598. <a id="Terminal_Gui_TreeView_1_AllowLetterBasedNavigation_" data-uid="Terminal.Gui.TreeView`1.AllowLetterBasedNavigation*"></a>
  599. <h4 id="Terminal_Gui_TreeView_1_AllowLetterBasedNavigation" data-uid="Terminal.Gui.TreeView`1.AllowLetterBasedNavigation">AllowLetterBasedNavigation</h4>
  600. <div class="markdown level1 summary">
  601. True makes a letter key press navigate to the next visible branch that begins with
  602. that letter/digit
  603. </div>
  604. <div class="markdown level1 conceptual"></div>
  605. <h5 class="decalaration">Declaration</h5>
  606. <div class="codewrapper">
  607. <pre><code class="lang-csharp hljs">public bool AllowLetterBasedNavigation { get; set; }</code></pre>
  608. </div>
  609. <h5 class="propertyValue">Property Value</h5>
  610. <table class="table table-bordered table-striped table-condensed">
  611. <thead>
  612. <tr>
  613. <th>Type</th>
  614. <th>Description</th>
  615. </tr>
  616. </thead>
  617. <tbody>
  618. <tr>
  619. <td><span class="xref">System.Boolean</span></td>
  620. <td></td>
  621. </tr>
  622. </tbody>
  623. </table>
  624. <a id="Terminal_Gui_TreeView_1_AspectGetter_" data-uid="Terminal.Gui.TreeView`1.AspectGetter*"></a>
  625. <h4 id="Terminal_Gui_TreeView_1_AspectGetter" data-uid="Terminal.Gui.TreeView`1.AspectGetter">AspectGetter</h4>
  626. <div class="markdown level1 summary">
  627. Returns the string representation of model objects hosted in the tree. Default
  628. implementation is to call <span class="xref">System.Object.ToString</span>
  629. </div>
  630. <div class="markdown level1 conceptual"></div>
  631. <h5 class="decalaration">Declaration</h5>
  632. <div class="codewrapper">
  633. <pre><code class="lang-csharp hljs">public AspectGetterDelegate&lt;T&gt; AspectGetter { get; set; }</code></pre>
  634. </div>
  635. <h5 class="propertyValue">Property Value</h5>
  636. <table class="table table-bordered table-striped table-condensed">
  637. <thead>
  638. <tr>
  639. <th>Type</th>
  640. <th>Description</th>
  641. </tr>
  642. </thead>
  643. <tbody>
  644. <tr>
  645. <td><a class="xref" href="Terminal.Gui.Trees.AspectGetterDelegate-1.html">AspectGetterDelegate</a>&lt;T&gt;</td>
  646. <td></td>
  647. </tr>
  648. </tbody>
  649. </table>
  650. <a id="Terminal_Gui_TreeView_1_ColorGetter_" data-uid="Terminal.Gui.TreeView`1.ColorGetter*"></a>
  651. <h4 id="Terminal_Gui_TreeView_1_ColorGetter" data-uid="Terminal.Gui.TreeView`1.ColorGetter">ColorGetter</h4>
  652. <div class="markdown level1 summary">
  653. Delegate for multi colored tree views. Return the <a class="xref" href="Terminal.Gui.ColorScheme.html">ColorScheme</a> to use
  654. for each passed object or null to use the default.
  655. </div>
  656. <div class="markdown level1 conceptual"></div>
  657. <h5 class="decalaration">Declaration</h5>
  658. <div class="codewrapper">
  659. <pre><code class="lang-csharp hljs">public Func&lt;T, ColorScheme&gt; ColorGetter { get; set; }</code></pre>
  660. </div>
  661. <h5 class="propertyValue">Property Value</h5>
  662. <table class="table table-bordered table-striped table-condensed">
  663. <thead>
  664. <tr>
  665. <th>Type</th>
  666. <th>Description</th>
  667. </tr>
  668. </thead>
  669. <tbody>
  670. <tr>
  671. <td><span class="xref">System.Func</span>&lt;T, <a class="xref" href="Terminal.Gui.ColorScheme.html">ColorScheme</a>&gt;</td>
  672. <td></td>
  673. </tr>
  674. </tbody>
  675. </table>
  676. <a id="Terminal_Gui_TreeView_1_ContentHeight_" data-uid="Terminal.Gui.TreeView`1.ContentHeight*"></a>
  677. <h4 id="Terminal_Gui_TreeView_1_ContentHeight" data-uid="Terminal.Gui.TreeView`1.ContentHeight">ContentHeight</h4>
  678. <div class="markdown level1 summary">
  679. The current number of rows in the tree (ignoring the controls bounds)
  680. </div>
  681. <div class="markdown level1 conceptual"></div>
  682. <h5 class="decalaration">Declaration</h5>
  683. <div class="codewrapper">
  684. <pre><code class="lang-csharp hljs">public int ContentHeight { get; }</code></pre>
  685. </div>
  686. <h5 class="propertyValue">Property Value</h5>
  687. <table class="table table-bordered table-striped table-condensed">
  688. <thead>
  689. <tr>
  690. <th>Type</th>
  691. <th>Description</th>
  692. </tr>
  693. </thead>
  694. <tbody>
  695. <tr>
  696. <td><span class="xref">System.Int32</span></td>
  697. <td></td>
  698. </tr>
  699. </tbody>
  700. </table>
  701. <a id="Terminal_Gui_TreeView_1_DesiredCursorVisibility_" data-uid="Terminal.Gui.TreeView`1.DesiredCursorVisibility*"></a>
  702. <h4 id="Terminal_Gui_TreeView_1_DesiredCursorVisibility" data-uid="Terminal.Gui.TreeView`1.DesiredCursorVisibility">DesiredCursorVisibility</h4>
  703. <div class="markdown level1 summary">
  704. Get / Set the wished cursor when the tree is focused
  705. </div>
  706. <div class="markdown level1 conceptual"></div>
  707. <h5 class="decalaration">Declaration</h5>
  708. <div class="codewrapper">
  709. <pre><code class="lang-csharp hljs">public CursorVisibility DesiredCursorVisibility { get; set; }</code></pre>
  710. </div>
  711. <h5 class="propertyValue">Property Value</h5>
  712. <table class="table table-bordered table-striped table-condensed">
  713. <thead>
  714. <tr>
  715. <th>Type</th>
  716. <th>Description</th>
  717. </tr>
  718. </thead>
  719. <tbody>
  720. <tr>
  721. <td><a class="xref" href="Terminal.Gui.CursorVisibility.html">CursorVisibility</a></td>
  722. <td></td>
  723. </tr>
  724. </tbody>
  725. </table>
  726. <a id="Terminal_Gui_TreeView_1_MultiSelect_" data-uid="Terminal.Gui.TreeView`1.MultiSelect*"></a>
  727. <h4 id="Terminal_Gui_TreeView_1_MultiSelect" data-uid="Terminal.Gui.TreeView`1.MultiSelect">MultiSelect</h4>
  728. <div class="markdown level1 summary">
  729. True to allow multiple objects to be selected at once
  730. </div>
  731. <div class="markdown level1 conceptual"></div>
  732. <h5 class="decalaration">Declaration</h5>
  733. <div class="codewrapper">
  734. <pre><code class="lang-csharp hljs">public bool MultiSelect { get; set; }</code></pre>
  735. </div>
  736. <h5 class="propertyValue">Property Value</h5>
  737. <table class="table table-bordered table-striped table-condensed">
  738. <thead>
  739. <tr>
  740. <th>Type</th>
  741. <th>Description</th>
  742. </tr>
  743. </thead>
  744. <tbody>
  745. <tr>
  746. <td><span class="xref">System.Boolean</span></td>
  747. <td></td>
  748. </tr>
  749. </tbody>
  750. </table>
  751. <a id="Terminal_Gui_TreeView_1_ObjectActivationButton_" data-uid="Terminal.Gui.TreeView`1.ObjectActivationButton*"></a>
  752. <h4 id="Terminal_Gui_TreeView_1_ObjectActivationButton" data-uid="Terminal.Gui.TreeView`1.ObjectActivationButton">ObjectActivationButton</h4>
  753. <div class="markdown level1 summary">
  754. Mouse event to trigger <a class="xref" href="Terminal.Gui.TreeView-1.html#Terminal_Gui_TreeView_1_ObjectActivated">ObjectActivated</a>.
  755. Defaults to double click (<a class="xref" href="Terminal.Gui.MouseFlags.html#Terminal_Gui_MouseFlags_Button1DoubleClicked">Button1DoubleClicked</a>).
  756. Set to null to disable this feature.
  757. </div>
  758. <div class="markdown level1 conceptual"></div>
  759. <h5 class="decalaration">Declaration</h5>
  760. <div class="codewrapper">
  761. <pre><code class="lang-csharp hljs">public Nullable&lt;MouseFlags&gt; ObjectActivationButton { get; set; }</code></pre>
  762. </div>
  763. <h5 class="propertyValue">Property Value</h5>
  764. <table class="table table-bordered table-striped table-condensed">
  765. <thead>
  766. <tr>
  767. <th>Type</th>
  768. <th>Description</th>
  769. </tr>
  770. </thead>
  771. <tbody>
  772. <tr>
  773. <td><span class="xref">System.Nullable</span>&lt;<a class="xref" href="Terminal.Gui.MouseFlags.html">MouseFlags</a>&gt;</td>
  774. <td></td>
  775. </tr>
  776. </tbody>
  777. </table>
  778. <a id="Terminal_Gui_TreeView_1_ObjectActivationKey_" data-uid="Terminal.Gui.TreeView`1.ObjectActivationKey*"></a>
  779. <h4 id="Terminal_Gui_TreeView_1_ObjectActivationKey" data-uid="Terminal.Gui.TreeView`1.ObjectActivationKey">ObjectActivationKey</h4>
  780. <div class="markdown level1 summary">
  781. Key which when pressed triggers <a class="xref" href="Terminal.Gui.TreeView-1.html#Terminal_Gui_TreeView_1_ObjectActivated">ObjectActivated</a>.
  782. Defaults to Enter
  783. </div>
  784. <div class="markdown level1 conceptual"></div>
  785. <h5 class="decalaration">Declaration</h5>
  786. <div class="codewrapper">
  787. <pre><code class="lang-csharp hljs">public Key ObjectActivationKey { get; set; }</code></pre>
  788. </div>
  789. <h5 class="propertyValue">Property Value</h5>
  790. <table class="table table-bordered table-striped table-condensed">
  791. <thead>
  792. <tr>
  793. <th>Type</th>
  794. <th>Description</th>
  795. </tr>
  796. </thead>
  797. <tbody>
  798. <tr>
  799. <td><a class="xref" href="Terminal.Gui.Key.html">Key</a></td>
  800. <td></td>
  801. </tr>
  802. </tbody>
  803. </table>
  804. <a id="Terminal_Gui_TreeView_1_Objects_" data-uid="Terminal.Gui.TreeView`1.Objects*"></a>
  805. <h4 id="Terminal_Gui_TreeView_1_Objects" data-uid="Terminal.Gui.TreeView`1.Objects">Objects</h4>
  806. <div class="markdown level1 summary">
  807. The root objects in the tree, note that this collection is of root objects only
  808. </div>
  809. <div class="markdown level1 conceptual"></div>
  810. <h5 class="decalaration">Declaration</h5>
  811. <div class="codewrapper">
  812. <pre><code class="lang-csharp hljs">public IEnumerable&lt;T&gt; Objects { get; }</code></pre>
  813. </div>
  814. <h5 class="propertyValue">Property Value</h5>
  815. <table class="table table-bordered table-striped table-condensed">
  816. <thead>
  817. <tr>
  818. <th>Type</th>
  819. <th>Description</th>
  820. </tr>
  821. </thead>
  822. <tbody>
  823. <tr>
  824. <td><span class="xref">System.Collections.Generic.IEnumerable</span>&lt;T&gt;</td>
  825. <td></td>
  826. </tr>
  827. </tbody>
  828. </table>
  829. <a id="Terminal_Gui_TreeView_1_ScrollOffsetHorizontal_" data-uid="Terminal.Gui.TreeView`1.ScrollOffsetHorizontal*"></a>
  830. <h4 id="Terminal_Gui_TreeView_1_ScrollOffsetHorizontal" data-uid="Terminal.Gui.TreeView`1.ScrollOffsetHorizontal">ScrollOffsetHorizontal</h4>
  831. <div class="markdown level1 summary">
  832. The amount of tree view that has been scrolled to the right (horizontally)
  833. </div>
  834. <div class="markdown level1 conceptual"></div>
  835. <h5 class="decalaration">Declaration</h5>
  836. <div class="codewrapper">
  837. <pre><code class="lang-csharp hljs">public int ScrollOffsetHorizontal { get; set; }</code></pre>
  838. </div>
  839. <h5 class="propertyValue">Property Value</h5>
  840. <table class="table table-bordered table-striped table-condensed">
  841. <thead>
  842. <tr>
  843. <th>Type</th>
  844. <th>Description</th>
  845. </tr>
  846. </thead>
  847. <tbody>
  848. <tr>
  849. <td><span class="xref">System.Int32</span></td>
  850. <td></td>
  851. </tr>
  852. </tbody>
  853. </table>
  854. <a id="Terminal_Gui_TreeView_1_ScrollOffsetVertical_" data-uid="Terminal.Gui.TreeView`1.ScrollOffsetVertical*"></a>
  855. <h4 id="Terminal_Gui_TreeView_1_ScrollOffsetVertical" data-uid="Terminal.Gui.TreeView`1.ScrollOffsetVertical">ScrollOffsetVertical</h4>
  856. <div class="markdown level1 summary">
  857. The amount of tree view that has been scrolled off the top of the screen (by the user
  858. scrolling down)
  859. </div>
  860. <div class="markdown level1 conceptual"></div>
  861. <h5 class="decalaration">Declaration</h5>
  862. <div class="codewrapper">
  863. <pre><code class="lang-csharp hljs">public int ScrollOffsetVertical { get; set; }</code></pre>
  864. </div>
  865. <h5 class="propertyValue">Property Value</h5>
  866. <table class="table table-bordered table-striped table-condensed">
  867. <thead>
  868. <tr>
  869. <th>Type</th>
  870. <th>Description</th>
  871. </tr>
  872. </thead>
  873. <tbody>
  874. <tr>
  875. <td><span class="xref">System.Int32</span></td>
  876. <td></td>
  877. </tr>
  878. </tbody>
  879. </table>
  880. <a id="Terminal_Gui_TreeView_1_SelectedObject_" data-uid="Terminal.Gui.TreeView`1.SelectedObject*"></a>
  881. <h4 id="Terminal_Gui_TreeView_1_SelectedObject" data-uid="Terminal.Gui.TreeView`1.SelectedObject">SelectedObject</h4>
  882. <div class="markdown level1 summary">
  883. 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
  884. is the object at which the cursor is at
  885. </div>
  886. <div class="markdown level1 conceptual"></div>
  887. <h5 class="decalaration">Declaration</h5>
  888. <div class="codewrapper">
  889. <pre><code class="lang-csharp hljs">public T SelectedObject { get; set; }</code></pre>
  890. </div>
  891. <h5 class="propertyValue">Property Value</h5>
  892. <table class="table table-bordered table-striped table-condensed">
  893. <thead>
  894. <tr>
  895. <th>Type</th>
  896. <th>Description</th>
  897. </tr>
  898. </thead>
  899. <tbody>
  900. <tr>
  901. <td><span class="xref">T</span></td>
  902. <td></td>
  903. </tr>
  904. </tbody>
  905. </table>
  906. <a id="Terminal_Gui_TreeView_1_Style_" data-uid="Terminal.Gui.TreeView`1.Style*"></a>
  907. <h4 id="Terminal_Gui_TreeView_1_Style" data-uid="Terminal.Gui.TreeView`1.Style">Style</h4>
  908. <div class="markdown level1 summary">
  909. Contains options for changing how the tree is rendered
  910. </div>
  911. <div class="markdown level1 conceptual"></div>
  912. <h5 class="decalaration">Declaration</h5>
  913. <div class="codewrapper">
  914. <pre><code class="lang-csharp hljs">public TreeStyle Style { get; set; }</code></pre>
  915. </div>
  916. <h5 class="propertyValue">Property Value</h5>
  917. <table class="table table-bordered table-striped table-condensed">
  918. <thead>
  919. <tr>
  920. <th>Type</th>
  921. <th>Description</th>
  922. </tr>
  923. </thead>
  924. <tbody>
  925. <tr>
  926. <td><a class="xref" href="Terminal.Gui.Trees.TreeStyle.html">TreeStyle</a></td>
  927. <td></td>
  928. </tr>
  929. </tbody>
  930. </table>
  931. <a id="Terminal_Gui_TreeView_1_TreeBuilder_" data-uid="Terminal.Gui.TreeView`1.TreeBuilder*"></a>
  932. <h4 id="Terminal_Gui_TreeView_1_TreeBuilder" data-uid="Terminal.Gui.TreeView`1.TreeBuilder">TreeBuilder</h4>
  933. <div class="markdown level1 summary">
  934. Determines how sub branches of the tree are dynamically built at runtime as the user
  935. expands root nodes
  936. </div>
  937. <div class="markdown level1 conceptual"></div>
  938. <h5 class="decalaration">Declaration</h5>
  939. <div class="codewrapper">
  940. <pre><code class="lang-csharp hljs">public ITreeBuilder&lt;T&gt; TreeBuilder { get; set; }</code></pre>
  941. </div>
  942. <h5 class="propertyValue">Property Value</h5>
  943. <table class="table table-bordered table-striped table-condensed">
  944. <thead>
  945. <tr>
  946. <th>Type</th>
  947. <th>Description</th>
  948. </tr>
  949. </thead>
  950. <tbody>
  951. <tr>
  952. <td><a class="xref" href="Terminal.Gui.Trees.ITreeBuilder-1.html">ITreeBuilder</a>&lt;T&gt;</td>
  953. <td></td>
  954. </tr>
  955. </tbody>
  956. </table>
  957. <h3 id="methods">Methods
  958. </h3>
  959. <a id="Terminal_Gui_TreeView_1_ActivateSelectedObjectIfAny_" data-uid="Terminal.Gui.TreeView`1.ActivateSelectedObjectIfAny*"></a>
  960. <h4 id="Terminal_Gui_TreeView_1_ActivateSelectedObjectIfAny" data-uid="Terminal.Gui.TreeView`1.ActivateSelectedObjectIfAny">ActivateSelectedObjectIfAny()</h4>
  961. <div class="markdown level1 summary">
  962. <p>Triggers the <a class="xref" href="Terminal.Gui.TreeView-1.html#Terminal_Gui_TreeView_1_ObjectActivated">ObjectActivated</a> event with the <a class="xref" href="Terminal.Gui.TreeView-1.html#Terminal_Gui_TreeView_1_SelectedObject">SelectedObject</a>.</p>
  963. <p>This method also ensures that the selected object is visible</p>
  964. </div>
  965. <div class="markdown level1 conceptual"></div>
  966. <h5 class="decalaration">Declaration</h5>
  967. <div class="codewrapper">
  968. <pre><code class="lang-csharp hljs">public void ActivateSelectedObjectIfAny()</code></pre>
  969. </div>
  970. <a id="Terminal_Gui_TreeView_1_AddObject_" data-uid="Terminal.Gui.TreeView`1.AddObject*"></a>
  971. <h4 id="Terminal_Gui_TreeView_1_AddObject__0_" data-uid="Terminal.Gui.TreeView`1.AddObject(`0)">AddObject(T)</h4>
  972. <div class="markdown level1 summary">
  973. Adds a new root level object unless it is already a root of the tree
  974. </div>
  975. <div class="markdown level1 conceptual"></div>
  976. <h5 class="decalaration">Declaration</h5>
  977. <div class="codewrapper">
  978. <pre><code class="lang-csharp hljs">public void AddObject(T o)</code></pre>
  979. </div>
  980. <h5 class="parameters">Parameters</h5>
  981. <table class="table table-bordered table-striped table-condensed">
  982. <thead>
  983. <tr>
  984. <th>Type</th>
  985. <th>Name</th>
  986. <th>Description</th>
  987. </tr>
  988. </thead>
  989. <tbody>
  990. <tr>
  991. <td><span class="xref">T</span></td>
  992. <td><span class="parametername">o</span></td>
  993. <td></td>
  994. </tr>
  995. </tbody>
  996. </table>
  997. <a id="Terminal_Gui_TreeView_1_AddObjects_" data-uid="Terminal.Gui.TreeView`1.AddObjects*"></a>
  998. <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>
  999. <div class="markdown level1 summary">
  1000. Adds many new root level objects. Objects that are already root objects are ignored
  1001. </div>
  1002. <div class="markdown level1 conceptual"></div>
  1003. <h5 class="decalaration">Declaration</h5>
  1004. <div class="codewrapper">
  1005. <pre><code class="lang-csharp hljs">public void AddObjects(IEnumerable&lt;T&gt; collection)</code></pre>
  1006. </div>
  1007. <h5 class="parameters">Parameters</h5>
  1008. <table class="table table-bordered table-striped table-condensed">
  1009. <thead>
  1010. <tr>
  1011. <th>Type</th>
  1012. <th>Name</th>
  1013. <th>Description</th>
  1014. </tr>
  1015. </thead>
  1016. <tbody>
  1017. <tr>
  1018. <td><span class="xref">System.Collections.Generic.IEnumerable</span>&lt;T&gt;</td>
  1019. <td><span class="parametername">collection</span></td>
  1020. <td>Objects to add as new root level objects</td>
  1021. </tr>
  1022. </tbody>
  1023. </table>
  1024. <a id="Terminal_Gui_TreeView_1_AdjustSelection_" data-uid="Terminal.Gui.TreeView`1.AdjustSelection*"></a>
  1025. <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>
  1026. <div class="markdown level1 summary">
  1027. The number of screen lines to move the currently selected object by. Supports negative
  1028. <code data-dev-comment-type="paramref" class="paramref">offset</code>. Each branch occupies 1 line on screen
  1029. </div>
  1030. <div class="markdown level1 conceptual"></div>
  1031. <h5 class="decalaration">Declaration</h5>
  1032. <div class="codewrapper">
  1033. <pre><code class="lang-csharp hljs">public void AdjustSelection(int offset, bool expandSelection = false)</code></pre>
  1034. </div>
  1035. <h5 class="parameters">Parameters</h5>
  1036. <table class="table table-bordered table-striped table-condensed">
  1037. <thead>
  1038. <tr>
  1039. <th>Type</th>
  1040. <th>Name</th>
  1041. <th>Description</th>
  1042. </tr>
  1043. </thead>
  1044. <tbody>
  1045. <tr>
  1046. <td><span class="xref">System.Int32</span></td>
  1047. <td><span class="parametername">offset</span></td>
  1048. <td>Positive to move the selection down the screen, negative to move it up</td>
  1049. </tr>
  1050. <tr>
  1051. <td><span class="xref">System.Boolean</span></td>
  1052. <td><span class="parametername">expandSelection</span></td>
  1053. <td>True to expand the selection (assuming
  1054. <a class="xref" href="Terminal.Gui.TreeView-1.html#Terminal_Gui_TreeView_1_MultiSelect">MultiSelect</a> is enabled). False to replace</td>
  1055. </tr>
  1056. </tbody>
  1057. </table>
  1058. <a id="Terminal_Gui_TreeView_1_AdjustSelectionToBranchEnd_" data-uid="Terminal.Gui.TreeView`1.AdjustSelectionToBranchEnd*"></a>
  1059. <h4 id="Terminal_Gui_TreeView_1_AdjustSelectionToBranchEnd" data-uid="Terminal.Gui.TreeView`1.AdjustSelectionToBranchEnd">AdjustSelectionToBranchEnd()</h4>
  1060. <div class="markdown level1 summary">
  1061. Moves the selection to the last child in the currently selected level
  1062. </div>
  1063. <div class="markdown level1 conceptual"></div>
  1064. <h5 class="decalaration">Declaration</h5>
  1065. <div class="codewrapper">
  1066. <pre><code class="lang-csharp hljs">public void AdjustSelectionToBranchEnd()</code></pre>
  1067. </div>
  1068. <a id="Terminal_Gui_TreeView_1_AdjustSelectionToBranchStart_" data-uid="Terminal.Gui.TreeView`1.AdjustSelectionToBranchStart*"></a>
  1069. <h4 id="Terminal_Gui_TreeView_1_AdjustSelectionToBranchStart" data-uid="Terminal.Gui.TreeView`1.AdjustSelectionToBranchStart">AdjustSelectionToBranchStart()</h4>
  1070. <div class="markdown level1 summary">
  1071. Moves the selection to the first child in the currently selected level
  1072. </div>
  1073. <div class="markdown level1 conceptual"></div>
  1074. <h5 class="decalaration">Declaration</h5>
  1075. <div class="codewrapper">
  1076. <pre><code class="lang-csharp hljs">public void AdjustSelectionToBranchStart()</code></pre>
  1077. </div>
  1078. <a id="Terminal_Gui_TreeView_1_AdjustSelectionToNextItemBeginningWith_" data-uid="Terminal.Gui.TreeView`1.AdjustSelectionToNextItemBeginningWith*"></a>
  1079. <h4 id="Terminal_Gui_TreeView_1_AdjustSelectionToNextItemBeginningWith_System_Char_System_StringComparison_" data-uid="Terminal.Gui.TreeView`1.AdjustSelectionToNextItemBeginningWith(System.Char,System.StringComparison)">AdjustSelectionToNextItemBeginningWith(Char, StringComparison)</h4>
  1080. <div class="markdown level1 summary">
  1081. <p>Moves the <a class="xref" href="Terminal.Gui.TreeView-1.html#Terminal_Gui_TreeView_1_SelectedObject">SelectedObject</a> to the next item that begins with <code data-dev-comment-type="paramref" class="paramref">character</code></p>
  1082. <p>This method will loop back to the start of the tree if reaching the end without finding a match</p>
  1083. </div>
  1084. <div class="markdown level1 conceptual"></div>
  1085. <h5 class="decalaration">Declaration</h5>
  1086. <div class="codewrapper">
  1087. <pre><code class="lang-csharp hljs">public void AdjustSelectionToNextItemBeginningWith(char character, StringComparison caseSensitivity)</code></pre>
  1088. </div>
  1089. <h5 class="parameters">Parameters</h5>
  1090. <table class="table table-bordered table-striped table-condensed">
  1091. <thead>
  1092. <tr>
  1093. <th>Type</th>
  1094. <th>Name</th>
  1095. <th>Description</th>
  1096. </tr>
  1097. </thead>
  1098. <tbody>
  1099. <tr>
  1100. <td><span class="xref">System.Char</span></td>
  1101. <td><span class="parametername">character</span></td>
  1102. <td>The first character of the next item you want selected</td>
  1103. </tr>
  1104. <tr>
  1105. <td><span class="xref">System.StringComparison</span></td>
  1106. <td><span class="parametername">caseSensitivity</span></td>
  1107. <td>Case sensitivity of the search</td>
  1108. </tr>
  1109. </tbody>
  1110. </table>
  1111. <a id="Terminal_Gui_TreeView_1_CanExpand_" data-uid="Terminal.Gui.TreeView`1.CanExpand*"></a>
  1112. <h4 id="Terminal_Gui_TreeView_1_CanExpand__0_" data-uid="Terminal.Gui.TreeView`1.CanExpand(`0)">CanExpand(T)</h4>
  1113. <div class="markdown level1 summary">
  1114. Returns true if the given object <code data-dev-comment-type="paramref" class="paramref">o</code> is exposed in the tree and can be
  1115. expanded otherwise false
  1116. </div>
  1117. <div class="markdown level1 conceptual"></div>
  1118. <h5 class="decalaration">Declaration</h5>
  1119. <div class="codewrapper">
  1120. <pre><code class="lang-csharp hljs">public bool CanExpand(T o)</code></pre>
  1121. </div>
  1122. <h5 class="parameters">Parameters</h5>
  1123. <table class="table table-bordered table-striped table-condensed">
  1124. <thead>
  1125. <tr>
  1126. <th>Type</th>
  1127. <th>Name</th>
  1128. <th>Description</th>
  1129. </tr>
  1130. </thead>
  1131. <tbody>
  1132. <tr>
  1133. <td><span class="xref">T</span></td>
  1134. <td><span class="parametername">o</span></td>
  1135. <td></td>
  1136. </tr>
  1137. </tbody>
  1138. </table>
  1139. <h5 class="returns">Returns</h5>
  1140. <table class="table table-bordered table-striped table-condensed">
  1141. <thead>
  1142. <tr>
  1143. <th>Type</th>
  1144. <th>Description</th>
  1145. </tr>
  1146. </thead>
  1147. <tbody>
  1148. <tr>
  1149. <td><span class="xref">System.Boolean</span></td>
  1150. <td></td>
  1151. </tr>
  1152. </tbody>
  1153. </table>
  1154. <a id="Terminal_Gui_TreeView_1_ClearObjects_" data-uid="Terminal.Gui.TreeView`1.ClearObjects*"></a>
  1155. <h4 id="Terminal_Gui_TreeView_1_ClearObjects" data-uid="Terminal.Gui.TreeView`1.ClearObjects">ClearObjects()</h4>
  1156. <div class="markdown level1 summary">
  1157. Removes all objects from the tree and clears <a class="xref" href="Terminal.Gui.TreeView-1.html#Terminal_Gui_TreeView_1_SelectedObject">SelectedObject</a>
  1158. </div>
  1159. <div class="markdown level1 conceptual"></div>
  1160. <h5 class="decalaration">Declaration</h5>
  1161. <div class="codewrapper">
  1162. <pre><code class="lang-csharp hljs">public void ClearObjects()</code></pre>
  1163. </div>
  1164. <a id="Terminal_Gui_TreeView_1_Collapse_" data-uid="Terminal.Gui.TreeView`1.Collapse*"></a>
  1165. <h4 id="Terminal_Gui_TreeView_1_Collapse" data-uid="Terminal.Gui.TreeView`1.Collapse">Collapse()</h4>
  1166. <div class="markdown level1 summary">
  1167. Collapses the <a class="xref" href="Terminal.Gui.TreeView-1.html#Terminal_Gui_TreeView_1_SelectedObject">SelectedObject</a>
  1168. </div>
  1169. <div class="markdown level1 conceptual"></div>
  1170. <h5 class="decalaration">Declaration</h5>
  1171. <div class="codewrapper">
  1172. <pre><code class="lang-csharp hljs">public void Collapse()</code></pre>
  1173. </div>
  1174. <a id="Terminal_Gui_TreeView_1_Collapse_" data-uid="Terminal.Gui.TreeView`1.Collapse*"></a>
  1175. <h4 id="Terminal_Gui_TreeView_1_Collapse__0_" data-uid="Terminal.Gui.TreeView`1.Collapse(`0)">Collapse(T)</h4>
  1176. <div class="markdown level1 summary">
  1177. Collapses the supplied object if it is currently expanded
  1178. </div>
  1179. <div class="markdown level1 conceptual"></div>
  1180. <h5 class="decalaration">Declaration</h5>
  1181. <div class="codewrapper">
  1182. <pre><code class="lang-csharp hljs">public void Collapse(T toCollapse)</code></pre>
  1183. </div>
  1184. <h5 class="parameters">Parameters</h5>
  1185. <table class="table table-bordered table-striped table-condensed">
  1186. <thead>
  1187. <tr>
  1188. <th>Type</th>
  1189. <th>Name</th>
  1190. <th>Description</th>
  1191. </tr>
  1192. </thead>
  1193. <tbody>
  1194. <tr>
  1195. <td><span class="xref">T</span></td>
  1196. <td><span class="parametername">toCollapse</span></td>
  1197. <td>The object to collapse</td>
  1198. </tr>
  1199. </tbody>
  1200. </table>
  1201. <a id="Terminal_Gui_TreeView_1_CollapseAll_" data-uid="Terminal.Gui.TreeView`1.CollapseAll*"></a>
  1202. <h4 id="Terminal_Gui_TreeView_1_CollapseAll" data-uid="Terminal.Gui.TreeView`1.CollapseAll">CollapseAll()</h4>
  1203. <div class="markdown level1 summary">
  1204. Collapses all root nodes in the tree
  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 void CollapseAll()</code></pre>
  1210. </div>
  1211. <a id="Terminal_Gui_TreeView_1_CollapseAll_" data-uid="Terminal.Gui.TreeView`1.CollapseAll*"></a>
  1212. <h4 id="Terminal_Gui_TreeView_1_CollapseAll__0_" data-uid="Terminal.Gui.TreeView`1.CollapseAll(`0)">CollapseAll(T)</h4>
  1213. <div class="markdown level1 summary">
  1214. Collapses the supplied object if it is currently expanded. Also collapses all children
  1215. branches (this will only become apparent when/if the user expands it again)
  1216. </div>
  1217. <div class="markdown level1 conceptual"></div>
  1218. <h5 class="decalaration">Declaration</h5>
  1219. <div class="codewrapper">
  1220. <pre><code class="lang-csharp hljs">public void CollapseAll(T toCollapse)</code></pre>
  1221. </div>
  1222. <h5 class="parameters">Parameters</h5>
  1223. <table class="table table-bordered table-striped table-condensed">
  1224. <thead>
  1225. <tr>
  1226. <th>Type</th>
  1227. <th>Name</th>
  1228. <th>Description</th>
  1229. </tr>
  1230. </thead>
  1231. <tbody>
  1232. <tr>
  1233. <td><span class="xref">T</span></td>
  1234. <td><span class="parametername">toCollapse</span></td>
  1235. <td>The object to collapse</td>
  1236. </tr>
  1237. </tbody>
  1238. </table>
  1239. <a id="Terminal_Gui_TreeView_1_CollapseImpl_" data-uid="Terminal.Gui.TreeView`1.CollapseImpl*"></a>
  1240. <h4 id="Terminal_Gui_TreeView_1_CollapseImpl__0_System_Boolean_" data-uid="Terminal.Gui.TreeView`1.CollapseImpl(`0,System.Boolean)">CollapseImpl(T, Boolean)</h4>
  1241. <div class="markdown level1 summary">
  1242. 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
  1243. operation and updates selection if disapeared
  1244. </div>
  1245. <div class="markdown level1 conceptual"></div>
  1246. <h5 class="decalaration">Declaration</h5>
  1247. <div class="codewrapper">
  1248. <pre><code class="lang-csharp hljs">protected void CollapseImpl(T toCollapse, bool all)</code></pre>
  1249. </div>
  1250. <h5 class="parameters">Parameters</h5>
  1251. <table class="table table-bordered table-striped table-condensed">
  1252. <thead>
  1253. <tr>
  1254. <th>Type</th>
  1255. <th>Name</th>
  1256. <th>Description</th>
  1257. </tr>
  1258. </thead>
  1259. <tbody>
  1260. <tr>
  1261. <td><span class="xref">T</span></td>
  1262. <td><span class="parametername">toCollapse</span></td>
  1263. <td></td>
  1264. </tr>
  1265. <tr>
  1266. <td><span class="xref">System.Boolean</span></td>
  1267. <td><span class="parametername">all</span></td>
  1268. <td></td>
  1269. </tr>
  1270. </tbody>
  1271. </table>
  1272. <a id="Terminal_Gui_TreeView_1_CursorLeft_" data-uid="Terminal.Gui.TreeView`1.CursorLeft*"></a>
  1273. <h4 id="Terminal_Gui_TreeView_1_CursorLeft_System_Boolean_" data-uid="Terminal.Gui.TreeView`1.CursorLeft(System.Boolean)">CursorLeft(Boolean)</h4>
  1274. <div class="markdown level1 summary">
  1275. Determines systems behaviour when the left arrow key is pressed. Default behaviour is
  1276. to collapse the current tree node if possible otherwise changes selection to current
  1277. branches parent
  1278. </div>
  1279. <div class="markdown level1 conceptual"></div>
  1280. <h5 class="decalaration">Declaration</h5>
  1281. <div class="codewrapper">
  1282. <pre><code class="lang-csharp hljs">protected virtual void CursorLeft(bool ctrl)</code></pre>
  1283. </div>
  1284. <h5 class="parameters">Parameters</h5>
  1285. <table class="table table-bordered table-striped table-condensed">
  1286. <thead>
  1287. <tr>
  1288. <th>Type</th>
  1289. <th>Name</th>
  1290. <th>Description</th>
  1291. </tr>
  1292. </thead>
  1293. <tbody>
  1294. <tr>
  1295. <td><span class="xref">System.Boolean</span></td>
  1296. <td><span class="parametername">ctrl</span></td>
  1297. <td></td>
  1298. </tr>
  1299. </tbody>
  1300. </table>
  1301. <a id="Terminal_Gui_TreeView_1_EnsureVisible_" data-uid="Terminal.Gui.TreeView`1.EnsureVisible*"></a>
  1302. <h4 id="Terminal_Gui_TreeView_1_EnsureVisible__0_" data-uid="Terminal.Gui.TreeView`1.EnsureVisible(`0)">EnsureVisible(T)</h4>
  1303. <div class="markdown level1 summary">
  1304. Adjusts the <a class="xref" href="Terminal.Gui.TreeView-1.html#Terminal_Gui_TreeView_1_ScrollOffsetVertical">ScrollOffsetVertical</a> to ensure the given
  1305. <code data-dev-comment-type="paramref" class="paramref">model</code> is visible. Has no effect if already visible
  1306. </div>
  1307. <div class="markdown level1 conceptual"></div>
  1308. <h5 class="decalaration">Declaration</h5>
  1309. <div class="codewrapper">
  1310. <pre><code class="lang-csharp hljs">public void EnsureVisible(T model)</code></pre>
  1311. </div>
  1312. <h5 class="parameters">Parameters</h5>
  1313. <table class="table table-bordered table-striped table-condensed">
  1314. <thead>
  1315. <tr>
  1316. <th>Type</th>
  1317. <th>Name</th>
  1318. <th>Description</th>
  1319. </tr>
  1320. </thead>
  1321. <tbody>
  1322. <tr>
  1323. <td><span class="xref">T</span></td>
  1324. <td><span class="parametername">model</span></td>
  1325. <td></td>
  1326. </tr>
  1327. </tbody>
  1328. </table>
  1329. <a id="Terminal_Gui_TreeView_1_Expand_" data-uid="Terminal.Gui.TreeView`1.Expand*"></a>
  1330. <h4 id="Terminal_Gui_TreeView_1_Expand" data-uid="Terminal.Gui.TreeView`1.Expand">Expand()</h4>
  1331. <div class="markdown level1 summary">
  1332. Expands the currently <a class="xref" href="Terminal.Gui.TreeView-1.html#Terminal_Gui_TreeView_1_SelectedObject">SelectedObject</a>
  1333. </div>
  1334. <div class="markdown level1 conceptual"></div>
  1335. <h5 class="decalaration">Declaration</h5>
  1336. <div class="codewrapper">
  1337. <pre><code class="lang-csharp hljs">public void Expand()</code></pre>
  1338. </div>
  1339. <a id="Terminal_Gui_TreeView_1_Expand_" data-uid="Terminal.Gui.TreeView`1.Expand*"></a>
  1340. <h4 id="Terminal_Gui_TreeView_1_Expand__0_" data-uid="Terminal.Gui.TreeView`1.Expand(`0)">Expand(T)</h4>
  1341. <div class="markdown level1 summary">
  1342. Expands the supplied object if it is contained in the tree (either as a root object or
  1343. as an exposed branch object)
  1344. </div>
  1345. <div class="markdown level1 conceptual"></div>
  1346. <h5 class="decalaration">Declaration</h5>
  1347. <div class="codewrapper">
  1348. <pre><code class="lang-csharp hljs">public void Expand(T toExpand)</code></pre>
  1349. </div>
  1350. <h5 class="parameters">Parameters</h5>
  1351. <table class="table table-bordered table-striped table-condensed">
  1352. <thead>
  1353. <tr>
  1354. <th>Type</th>
  1355. <th>Name</th>
  1356. <th>Description</th>
  1357. </tr>
  1358. </thead>
  1359. <tbody>
  1360. <tr>
  1361. <td><span class="xref">T</span></td>
  1362. <td><span class="parametername">toExpand</span></td>
  1363. <td>The object to expand</td>
  1364. </tr>
  1365. </tbody>
  1366. </table>
  1367. <a id="Terminal_Gui_TreeView_1_ExpandAll_" data-uid="Terminal.Gui.TreeView`1.ExpandAll*"></a>
  1368. <h4 id="Terminal_Gui_TreeView_1_ExpandAll" data-uid="Terminal.Gui.TreeView`1.ExpandAll">ExpandAll()</h4>
  1369. <div class="markdown level1 summary">
  1370. Fully expands all nodes in the tree, if the tree is very big and built dynamically this
  1371. may take a while (e.g. for file system)
  1372. </div>
  1373. <div class="markdown level1 conceptual"></div>
  1374. <h5 class="decalaration">Declaration</h5>
  1375. <div class="codewrapper">
  1376. <pre><code class="lang-csharp hljs">public void ExpandAll()</code></pre>
  1377. </div>
  1378. <a id="Terminal_Gui_TreeView_1_ExpandAll_" data-uid="Terminal.Gui.TreeView`1.ExpandAll*"></a>
  1379. <h4 id="Terminal_Gui_TreeView_1_ExpandAll__0_" data-uid="Terminal.Gui.TreeView`1.ExpandAll(`0)">ExpandAll(T)</h4>
  1380. <div class="markdown level1 summary">
  1381. Expands the supplied object and all child objects
  1382. </div>
  1383. <div class="markdown level1 conceptual"></div>
  1384. <h5 class="decalaration">Declaration</h5>
  1385. <div class="codewrapper">
  1386. <pre><code class="lang-csharp hljs">public void ExpandAll(T toExpand)</code></pre>
  1387. </div>
  1388. <h5 class="parameters">Parameters</h5>
  1389. <table class="table table-bordered table-striped table-condensed">
  1390. <thead>
  1391. <tr>
  1392. <th>Type</th>
  1393. <th>Name</th>
  1394. <th>Description</th>
  1395. </tr>
  1396. </thead>
  1397. <tbody>
  1398. <tr>
  1399. <td><span class="xref">T</span></td>
  1400. <td><span class="parametername">toExpand</span></td>
  1401. <td>The object to expand</td>
  1402. </tr>
  1403. </tbody>
  1404. </table>
  1405. <a id="Terminal_Gui_TreeView_1_GetAllSelectedObjects_" data-uid="Terminal.Gui.TreeView`1.GetAllSelectedObjects*"></a>
  1406. <h4 id="Terminal_Gui_TreeView_1_GetAllSelectedObjects" data-uid="Terminal.Gui.TreeView`1.GetAllSelectedObjects">GetAllSelectedObjects()</h4>
  1407. <div class="markdown level1 summary">
  1408. 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
  1409. <a class="xref" href="Terminal.Gui.TreeView-1.html#Terminal_Gui_TreeView_1_MultiSelect">MultiSelect</a> is true
  1410. </div>
  1411. <div class="markdown level1 conceptual"></div>
  1412. <h5 class="decalaration">Declaration</h5>
  1413. <div class="codewrapper">
  1414. <pre><code class="lang-csharp hljs">public IEnumerable&lt;T&gt; GetAllSelectedObjects()</code></pre>
  1415. </div>
  1416. <h5 class="returns">Returns</h5>
  1417. <table class="table table-bordered table-striped table-condensed">
  1418. <thead>
  1419. <tr>
  1420. <th>Type</th>
  1421. <th>Description</th>
  1422. </tr>
  1423. </thead>
  1424. <tbody>
  1425. <tr>
  1426. <td><span class="xref">System.Collections.Generic.IEnumerable</span>&lt;T&gt;</td>
  1427. <td></td>
  1428. </tr>
  1429. </tbody>
  1430. </table>
  1431. <a id="Terminal_Gui_TreeView_1_GetChildren_" data-uid="Terminal.Gui.TreeView`1.GetChildren*"></a>
  1432. <h4 id="Terminal_Gui_TreeView_1_GetChildren__0_" data-uid="Terminal.Gui.TreeView`1.GetChildren(`0)">GetChildren(T)</h4>
  1433. <div class="markdown level1 summary">
  1434. Returns the currently expanded children of the passed object. Returns an empty
  1435. collection if the branch is not exposed or not expanded
  1436. </div>
  1437. <div class="markdown level1 conceptual"></div>
  1438. <h5 class="decalaration">Declaration</h5>
  1439. <div class="codewrapper">
  1440. <pre><code class="lang-csharp hljs">public IEnumerable&lt;T&gt; GetChildren(T o)</code></pre>
  1441. </div>
  1442. <h5 class="parameters">Parameters</h5>
  1443. <table class="table table-bordered table-striped table-condensed">
  1444. <thead>
  1445. <tr>
  1446. <th>Type</th>
  1447. <th>Name</th>
  1448. <th>Description</th>
  1449. </tr>
  1450. </thead>
  1451. <tbody>
  1452. <tr>
  1453. <td><span class="xref">T</span></td>
  1454. <td><span class="parametername">o</span></td>
  1455. <td>An object in the tree</td>
  1456. </tr>
  1457. </tbody>
  1458. </table>
  1459. <h5 class="returns">Returns</h5>
  1460. <table class="table table-bordered table-striped table-condensed">
  1461. <thead>
  1462. <tr>
  1463. <th>Type</th>
  1464. <th>Description</th>
  1465. </tr>
  1466. </thead>
  1467. <tbody>
  1468. <tr>
  1469. <td><span class="xref">System.Collections.Generic.IEnumerable</span>&lt;T&gt;</td>
  1470. <td></td>
  1471. </tr>
  1472. </tbody>
  1473. </table>
  1474. <a id="Terminal_Gui_TreeView_1_GetContentWidth_" data-uid="Terminal.Gui.TreeView`1.GetContentWidth*"></a>
  1475. <h4 id="Terminal_Gui_TreeView_1_GetContentWidth_System_Boolean_" data-uid="Terminal.Gui.TreeView`1.GetContentWidth(System.Boolean)">GetContentWidth(Boolean)</h4>
  1476. <div class="markdown level1 summary">
  1477. Returns the maximum width line in the tree including prefix and expansion symbols
  1478. </div>
  1479. <div class="markdown level1 conceptual"></div>
  1480. <h5 class="decalaration">Declaration</h5>
  1481. <div class="codewrapper">
  1482. <pre><code class="lang-csharp hljs">public int GetContentWidth(bool visible)</code></pre>
  1483. </div>
  1484. <h5 class="parameters">Parameters</h5>
  1485. <table class="table table-bordered table-striped table-condensed">
  1486. <thead>
  1487. <tr>
  1488. <th>Type</th>
  1489. <th>Name</th>
  1490. <th>Description</th>
  1491. </tr>
  1492. </thead>
  1493. <tbody>
  1494. <tr>
  1495. <td><span class="xref">System.Boolean</span></td>
  1496. <td><span class="parametername">visible</span></td>
  1497. <td>True to consider only rows currently visible (based on window
  1498. bounds and <a class="xref" href="Terminal.Gui.TreeView-1.html#Terminal_Gui_TreeView_1_ScrollOffsetVertical">ScrollOffsetVertical</a>. False to calculate the width of
  1499. every exposed branch in the tree</td>
  1500. </tr>
  1501. </tbody>
  1502. </table>
  1503. <h5 class="returns">Returns</h5>
  1504. <table class="table table-bordered table-striped table-condensed">
  1505. <thead>
  1506. <tr>
  1507. <th>Type</th>
  1508. <th>Description</th>
  1509. </tr>
  1510. </thead>
  1511. <tbody>
  1512. <tr>
  1513. <td><span class="xref">System.Int32</span></td>
  1514. <td></td>
  1515. </tr>
  1516. </tbody>
  1517. </table>
  1518. <a id="Terminal_Gui_TreeView_1_GetObjectOnRow_" data-uid="Terminal.Gui.TreeView`1.GetObjectOnRow*"></a>
  1519. <h4 id="Terminal_Gui_TreeView_1_GetObjectOnRow_System_Int32_" data-uid="Terminal.Gui.TreeView`1.GetObjectOnRow(System.Int32)">GetObjectOnRow(Int32)</h4>
  1520. <div class="markdown level1 summary">
  1521. Returns the object in the tree list that is currently visible
  1522. at the provided row. Returns null if no object is at that location.
  1523. <remarks>
  1524. </remarks>
  1525. If you have screen coordinates then use <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ScreenToView_System_Int32_System_Int32_">ScreenToView(Int32, Int32)</a>
  1526. to translate these into the client area of the <a class="xref" href="Terminal.Gui.TreeView-1.html">TreeView&lt;T&gt;</a>.
  1527. </div>
  1528. <div class="markdown level1 conceptual"></div>
  1529. <h5 class="decalaration">Declaration</h5>
  1530. <div class="codewrapper">
  1531. <pre><code class="lang-csharp hljs">public T GetObjectOnRow(int row)</code></pre>
  1532. </div>
  1533. <h5 class="parameters">Parameters</h5>
  1534. <table class="table table-bordered table-striped table-condensed">
  1535. <thead>
  1536. <tr>
  1537. <th>Type</th>
  1538. <th>Name</th>
  1539. <th>Description</th>
  1540. </tr>
  1541. </thead>
  1542. <tbody>
  1543. <tr>
  1544. <td><span class="xref">System.Int32</span></td>
  1545. <td><span class="parametername">row</span></td>
  1546. <td>The row of the <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Bounds">Bounds</a> of the <a class="xref" href="Terminal.Gui.TreeView-1.html">TreeView&lt;T&gt;</a></td>
  1547. </tr>
  1548. </tbody>
  1549. </table>
  1550. <h5 class="returns">Returns</h5>
  1551. <table class="table table-bordered table-striped table-condensed">
  1552. <thead>
  1553. <tr>
  1554. <th>Type</th>
  1555. <th>Description</th>
  1556. </tr>
  1557. </thead>
  1558. <tbody>
  1559. <tr>
  1560. <td><span class="xref">T</span></td>
  1561. <td>The object currently displayed on this row or null</td>
  1562. </tr>
  1563. </tbody>
  1564. </table>
  1565. <a id="Terminal_Gui_TreeView_1_GetObjectRow_" data-uid="Terminal.Gui.TreeView`1.GetObjectRow*"></a>
  1566. <h4 id="Terminal_Gui_TreeView_1_GetObjectRow__0_" data-uid="Terminal.Gui.TreeView`1.GetObjectRow(`0)">GetObjectRow(T)</h4>
  1567. <div class="markdown level1 summary">
  1568. <p>
  1569. Returns the Y coordinate within the <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Bounds">Bounds</a> of the
  1570. tree at which <code data-dev-comment-type="paramref" class="paramref">toFind</code> would be displayed or null if
  1571. it is not currently exposed (e.g. its parent is collapsed).
  1572. </p>
  1573. <p>
  1574. Note that the returned value can be negative if the TreeView is scrolled
  1575. down and the <code data-dev-comment-type="paramref" class="paramref">toFind</code> object is off the top of the view.
  1576. </p>
  1577. </div>
  1578. <div class="markdown level1 conceptual"></div>
  1579. <h5 class="decalaration">Declaration</h5>
  1580. <div class="codewrapper">
  1581. <pre><code class="lang-csharp hljs">public Nullable&lt;int&gt; GetObjectRow(T toFind)</code></pre>
  1582. </div>
  1583. <h5 class="parameters">Parameters</h5>
  1584. <table class="table table-bordered table-striped table-condensed">
  1585. <thead>
  1586. <tr>
  1587. <th>Type</th>
  1588. <th>Name</th>
  1589. <th>Description</th>
  1590. </tr>
  1591. </thead>
  1592. <tbody>
  1593. <tr>
  1594. <td><span class="xref">T</span></td>
  1595. <td><span class="parametername">toFind</span></td>
  1596. <td></td>
  1597. </tr>
  1598. </tbody>
  1599. </table>
  1600. <h5 class="returns">Returns</h5>
  1601. <table class="table table-bordered table-striped table-condensed">
  1602. <thead>
  1603. <tr>
  1604. <th>Type</th>
  1605. <th>Description</th>
  1606. </tr>
  1607. </thead>
  1608. <tbody>
  1609. <tr>
  1610. <td><span class="xref">System.Nullable</span>&lt;<span class="xref">System.Int32</span>&gt;</td>
  1611. <td></td>
  1612. </tr>
  1613. </tbody>
  1614. </table>
  1615. <a id="Terminal_Gui_TreeView_1_GetParent_" data-uid="Terminal.Gui.TreeView`1.GetParent*"></a>
  1616. <h4 id="Terminal_Gui_TreeView_1_GetParent__0_" data-uid="Terminal.Gui.TreeView`1.GetParent(`0)">GetParent(T)</h4>
  1617. <div class="markdown level1 summary">
  1618. Returns the parent object of <code data-dev-comment-type="paramref" class="paramref">o</code> in the tree. Returns null if
  1619. the object is not exposed in the tree
  1620. </div>
  1621. <div class="markdown level1 conceptual"></div>
  1622. <h5 class="decalaration">Declaration</h5>
  1623. <div class="codewrapper">
  1624. <pre><code class="lang-csharp hljs">public T GetParent(T o)</code></pre>
  1625. </div>
  1626. <h5 class="parameters">Parameters</h5>
  1627. <table class="table table-bordered table-striped table-condensed">
  1628. <thead>
  1629. <tr>
  1630. <th>Type</th>
  1631. <th>Name</th>
  1632. <th>Description</th>
  1633. </tr>
  1634. </thead>
  1635. <tbody>
  1636. <tr>
  1637. <td><span class="xref">T</span></td>
  1638. <td><span class="parametername">o</span></td>
  1639. <td>An object in the tree</td>
  1640. </tr>
  1641. </tbody>
  1642. </table>
  1643. <h5 class="returns">Returns</h5>
  1644. <table class="table table-bordered table-striped table-condensed">
  1645. <thead>
  1646. <tr>
  1647. <th>Type</th>
  1648. <th>Description</th>
  1649. </tr>
  1650. </thead>
  1651. <tbody>
  1652. <tr>
  1653. <td><span class="xref">T</span></td>
  1654. <td></td>
  1655. </tr>
  1656. </tbody>
  1657. </table>
  1658. <a id="Terminal_Gui_TreeView_1_GetScrollOffsetOf_" data-uid="Terminal.Gui.TreeView`1.GetScrollOffsetOf*"></a>
  1659. <h4 id="Terminal_Gui_TreeView_1_GetScrollOffsetOf__0_" data-uid="Terminal.Gui.TreeView`1.GetScrollOffsetOf(`0)">GetScrollOffsetOf(T)</h4>
  1660. <div class="markdown level1 summary">
  1661. Returns the index of the object <code data-dev-comment-type="paramref" class="paramref">o</code> if it is currently exposed (it&apos;s
  1662. 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>
  1663. and <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SetNeedsDisplay">SetNeedsDisplay()</a> to scroll to a specific object
  1664. </div>
  1665. <div class="markdown level1 conceptual"></div>
  1666. <h5 class="decalaration">Declaration</h5>
  1667. <div class="codewrapper">
  1668. <pre><code class="lang-csharp hljs">public int GetScrollOffsetOf(T o)</code></pre>
  1669. </div>
  1670. <h5 class="parameters">Parameters</h5>
  1671. <table class="table table-bordered table-striped table-condensed">
  1672. <thead>
  1673. <tr>
  1674. <th>Type</th>
  1675. <th>Name</th>
  1676. <th>Description</th>
  1677. </tr>
  1678. </thead>
  1679. <tbody>
  1680. <tr>
  1681. <td><span class="xref">T</span></td>
  1682. <td><span class="parametername">o</span></td>
  1683. <td>An object that appears in your tree and is currently exposed</td>
  1684. </tr>
  1685. </tbody>
  1686. </table>
  1687. <h5 class="returns">Returns</h5>
  1688. <table class="table table-bordered table-striped table-condensed">
  1689. <thead>
  1690. <tr>
  1691. <th>Type</th>
  1692. <th>Description</th>
  1693. </tr>
  1694. </thead>
  1695. <tbody>
  1696. <tr>
  1697. <td><span class="xref">System.Int32</span></td>
  1698. <td>The index the object was found at or -1 if it is not currently revealed or
  1699. not in the tree at all</td>
  1700. </tr>
  1701. </tbody>
  1702. </table>
  1703. <a id="Terminal_Gui_TreeView_1_GoTo_" data-uid="Terminal.Gui.TreeView`1.GoTo*"></a>
  1704. <h4 id="Terminal_Gui_TreeView_1_GoTo__0_" data-uid="Terminal.Gui.TreeView`1.GoTo(`0)">GoTo(T)</h4>
  1705. <div class="markdown level1 summary">
  1706. 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
  1707. 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.
  1708. its parents are collapsed)
  1709. </div>
  1710. <div class="markdown level1 conceptual"></div>
  1711. <h5 class="decalaration">Declaration</h5>
  1712. <div class="codewrapper">
  1713. <pre><code class="lang-csharp hljs">public void GoTo(T toSelect)</code></pre>
  1714. </div>
  1715. <h5 class="parameters">Parameters</h5>
  1716. <table class="table table-bordered table-striped table-condensed">
  1717. <thead>
  1718. <tr>
  1719. <th>Type</th>
  1720. <th>Name</th>
  1721. <th>Description</th>
  1722. </tr>
  1723. </thead>
  1724. <tbody>
  1725. <tr>
  1726. <td><span class="xref">T</span></td>
  1727. <td><span class="parametername">toSelect</span></td>
  1728. <td></td>
  1729. </tr>
  1730. </tbody>
  1731. </table>
  1732. <a id="Terminal_Gui_TreeView_1_GoToEnd_" data-uid="Terminal.Gui.TreeView`1.GoToEnd*"></a>
  1733. <h4 id="Terminal_Gui_TreeView_1_GoToEnd" data-uid="Terminal.Gui.TreeView`1.GoToEnd">GoToEnd()</h4>
  1734. <div class="markdown level1 summary">
  1735. 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
  1736. that it is visible
  1737. </div>
  1738. <div class="markdown level1 conceptual"></div>
  1739. <h5 class="decalaration">Declaration</h5>
  1740. <div class="codewrapper">
  1741. <pre><code class="lang-csharp hljs">public void GoToEnd()</code></pre>
  1742. </div>
  1743. <a id="Terminal_Gui_TreeView_1_GoToFirst_" data-uid="Terminal.Gui.TreeView`1.GoToFirst*"></a>
  1744. <h4 id="Terminal_Gui_TreeView_1_GoToFirst" data-uid="Terminal.Gui.TreeView`1.GoToFirst">GoToFirst()</h4>
  1745. <div class="markdown level1 summary">
  1746. 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
  1747. the <a class="xref" href="Terminal.Gui.TreeView-1.html#Terminal_Gui_TreeView_1_ScrollOffsetVertical">ScrollOffsetVertical</a> to 0
  1748. </div>
  1749. <div class="markdown level1 conceptual"></div>
  1750. <h5 class="decalaration">Declaration</h5>
  1751. <div class="codewrapper">
  1752. <pre><code class="lang-csharp hljs">public void GoToFirst()</code></pre>
  1753. </div>
  1754. <a id="Terminal_Gui_TreeView_1_InvalidateLineMap_" data-uid="Terminal.Gui.TreeView`1.InvalidateLineMap*"></a>
  1755. <h4 id="Terminal_Gui_TreeView_1_InvalidateLineMap" data-uid="Terminal.Gui.TreeView`1.InvalidateLineMap">InvalidateLineMap()</h4>
  1756. <div class="markdown level1 summary">
  1757. Clears any cached results of <span class="xref">Terminal.Gui.TreeView`1.BuildLineMap</span>
  1758. </div>
  1759. <div class="markdown level1 conceptual"></div>
  1760. <h5 class="decalaration">Declaration</h5>
  1761. <div class="codewrapper">
  1762. <pre><code class="lang-csharp hljs">protected void InvalidateLineMap()</code></pre>
  1763. </div>
  1764. <a id="Terminal_Gui_TreeView_1_IsExpanded_" data-uid="Terminal.Gui.TreeView`1.IsExpanded*"></a>
  1765. <h4 id="Terminal_Gui_TreeView_1_IsExpanded__0_" data-uid="Terminal.Gui.TreeView`1.IsExpanded(`0)">IsExpanded(T)</h4>
  1766. <div class="markdown level1 summary">
  1767. Returns true if the given object <code data-dev-comment-type="paramref" class="paramref">o</code> is exposed in the tree and
  1768. expanded otherwise false
  1769. </div>
  1770. <div class="markdown level1 conceptual"></div>
  1771. <h5 class="decalaration">Declaration</h5>
  1772. <div class="codewrapper">
  1773. <pre><code class="lang-csharp hljs">public bool IsExpanded(T o)</code></pre>
  1774. </div>
  1775. <h5 class="parameters">Parameters</h5>
  1776. <table class="table table-bordered table-striped table-condensed">
  1777. <thead>
  1778. <tr>
  1779. <th>Type</th>
  1780. <th>Name</th>
  1781. <th>Description</th>
  1782. </tr>
  1783. </thead>
  1784. <tbody>
  1785. <tr>
  1786. <td><span class="xref">T</span></td>
  1787. <td><span class="parametername">o</span></td>
  1788. <td></td>
  1789. </tr>
  1790. </tbody>
  1791. </table>
  1792. <h5 class="returns">Returns</h5>
  1793. <table class="table table-bordered table-striped table-condensed">
  1794. <thead>
  1795. <tr>
  1796. <th>Type</th>
  1797. <th>Description</th>
  1798. </tr>
  1799. </thead>
  1800. <tbody>
  1801. <tr>
  1802. <td><span class="xref">System.Boolean</span></td>
  1803. <td></td>
  1804. </tr>
  1805. </tbody>
  1806. </table>
  1807. <a id="Terminal_Gui_TreeView_1_IsSelected_" data-uid="Terminal.Gui.TreeView`1.IsSelected*"></a>
  1808. <h4 id="Terminal_Gui_TreeView_1_IsSelected__0_" data-uid="Terminal.Gui.TreeView`1.IsSelected(`0)">IsSelected(T)</h4>
  1809. <div class="markdown level1 summary">
  1810. Returns true if the <code data-dev-comment-type="paramref" class="paramref">model</code> is either the
  1811. <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>
  1812. </div>
  1813. <div class="markdown level1 conceptual"></div>
  1814. <h5 class="decalaration">Declaration</h5>
  1815. <div class="codewrapper">
  1816. <pre><code class="lang-csharp hljs">public bool IsSelected(T model)</code></pre>
  1817. </div>
  1818. <h5 class="parameters">Parameters</h5>
  1819. <table class="table table-bordered table-striped table-condensed">
  1820. <thead>
  1821. <tr>
  1822. <th>Type</th>
  1823. <th>Name</th>
  1824. <th>Description</th>
  1825. </tr>
  1826. </thead>
  1827. <tbody>
  1828. <tr>
  1829. <td><span class="xref">T</span></td>
  1830. <td><span class="parametername">model</span></td>
  1831. <td></td>
  1832. </tr>
  1833. </tbody>
  1834. </table>
  1835. <h5 class="returns">Returns</h5>
  1836. <table class="table table-bordered table-striped table-condensed">
  1837. <thead>
  1838. <tr>
  1839. <th>Type</th>
  1840. <th>Description</th>
  1841. </tr>
  1842. </thead>
  1843. <tbody>
  1844. <tr>
  1845. <td><span class="xref">System.Boolean</span></td>
  1846. <td></td>
  1847. </tr>
  1848. </tbody>
  1849. </table>
  1850. <a id="Terminal_Gui_TreeView_1_MouseEvent_" data-uid="Terminal.Gui.TreeView`1.MouseEvent*"></a>
  1851. <h4 id="Terminal_Gui_TreeView_1_MouseEvent_Terminal_Gui_MouseEvent_" data-uid="Terminal.Gui.TreeView`1.MouseEvent(Terminal.Gui.MouseEvent)">MouseEvent(MouseEvent)</h4>
  1852. <div class="markdown level1 summary">
  1853. Method invoked when a mouse event is generated
  1854. </div>
  1855. <div class="markdown level1 conceptual"></div>
  1856. <h5 class="decalaration">Declaration</h5>
  1857. <div class="codewrapper">
  1858. <pre><code class="lang-csharp hljs">public override bool MouseEvent(MouseEvent me)</code></pre>
  1859. </div>
  1860. <h5 class="parameters">Parameters</h5>
  1861. <table class="table table-bordered table-striped table-condensed">
  1862. <thead>
  1863. <tr>
  1864. <th>Type</th>
  1865. <th>Name</th>
  1866. <th>Description</th>
  1867. </tr>
  1868. </thead>
  1869. <tbody>
  1870. <tr>
  1871. <td><a class="xref" href="Terminal.Gui.MouseEvent.html">MouseEvent</a></td>
  1872. <td><span class="parametername">me</span></td>
  1873. <td></td>
  1874. </tr>
  1875. </tbody>
  1876. </table>
  1877. <h5 class="returns">Returns</h5>
  1878. <table class="table table-bordered table-striped table-condensed">
  1879. <thead>
  1880. <tr>
  1881. <th>Type</th>
  1882. <th>Description</th>
  1883. </tr>
  1884. </thead>
  1885. <tbody>
  1886. <tr>
  1887. <td><span class="xref">System.Boolean</span></td>
  1888. <td><code>true</code>, if the event was handled, <code>false</code> otherwise.</td>
  1889. </tr>
  1890. </tbody>
  1891. </table>
  1892. <h5 class="overrides">Overrides</h5>
  1893. <div><a class="xref" href="Terminal.Gui.Responder.html#Terminal_Gui_Responder_MouseEvent_Terminal_Gui_MouseEvent_">Responder.MouseEvent(MouseEvent)</a></div>
  1894. <a id="Terminal_Gui_TreeView_1_MovePageDown_" data-uid="Terminal.Gui.TreeView`1.MovePageDown*"></a>
  1895. <h4 id="Terminal_Gui_TreeView_1_MovePageDown_System_Boolean_" data-uid="Terminal.Gui.TreeView`1.MovePageDown(System.Boolean)">MovePageDown(Boolean)</h4>
  1896. <div class="markdown level1 summary">
  1897. Moves the selection down by the height of the control (1 page).
  1898. </div>
  1899. <div class="markdown level1 conceptual"></div>
  1900. <h5 class="decalaration">Declaration</h5>
  1901. <div class="codewrapper">
  1902. <pre><code class="lang-csharp hljs">public void MovePageDown(bool expandSelection = false)</code></pre>
  1903. </div>
  1904. <h5 class="parameters">Parameters</h5>
  1905. <table class="table table-bordered table-striped table-condensed">
  1906. <thead>
  1907. <tr>
  1908. <th>Type</th>
  1909. <th>Name</th>
  1910. <th>Description</th>
  1911. </tr>
  1912. </thead>
  1913. <tbody>
  1914. <tr>
  1915. <td><span class="xref">System.Boolean</span></td>
  1916. <td><span class="parametername">expandSelection</span></td>
  1917. <td>True if the navigation should add the covered nodes to the selected current selection</td>
  1918. </tr>
  1919. </tbody>
  1920. </table>
  1921. <h5 class="exceptions">Exceptions</h5>
  1922. <table class="table table-bordered table-striped table-condensed">
  1923. <thead>
  1924. <tr>
  1925. <th>Type</th>
  1926. <th>Condition</th>
  1927. </tr>
  1928. </thead>
  1929. <tbody>
  1930. <tr>
  1931. <td><span class="xref">System.NotImplementedException</span></td>
  1932. <td></td>
  1933. </tr>
  1934. </tbody>
  1935. </table>
  1936. <a id="Terminal_Gui_TreeView_1_MovePageUp_" data-uid="Terminal.Gui.TreeView`1.MovePageUp*"></a>
  1937. <h4 id="Terminal_Gui_TreeView_1_MovePageUp_System_Boolean_" data-uid="Terminal.Gui.TreeView`1.MovePageUp(System.Boolean)">MovePageUp(Boolean)</h4>
  1938. <div class="markdown level1 summary">
  1939. Moves the selection up by the height of the control (1 page).
  1940. </div>
  1941. <div class="markdown level1 conceptual"></div>
  1942. <h5 class="decalaration">Declaration</h5>
  1943. <div class="codewrapper">
  1944. <pre><code class="lang-csharp hljs">public void MovePageUp(bool expandSelection = false)</code></pre>
  1945. </div>
  1946. <h5 class="parameters">Parameters</h5>
  1947. <table class="table table-bordered table-striped table-condensed">
  1948. <thead>
  1949. <tr>
  1950. <th>Type</th>
  1951. <th>Name</th>
  1952. <th>Description</th>
  1953. </tr>
  1954. </thead>
  1955. <tbody>
  1956. <tr>
  1957. <td><span class="xref">System.Boolean</span></td>
  1958. <td><span class="parametername">expandSelection</span></td>
  1959. <td>True if the navigation should add the covered nodes to the selected current selection</td>
  1960. </tr>
  1961. </tbody>
  1962. </table>
  1963. <h5 class="exceptions">Exceptions</h5>
  1964. <table class="table table-bordered table-striped table-condensed">
  1965. <thead>
  1966. <tr>
  1967. <th>Type</th>
  1968. <th>Condition</th>
  1969. </tr>
  1970. </thead>
  1971. <tbody>
  1972. <tr>
  1973. <td><span class="xref">System.NotImplementedException</span></td>
  1974. <td></td>
  1975. </tr>
  1976. </tbody>
  1977. </table>
  1978. <a id="Terminal_Gui_TreeView_1_OnEnter_" data-uid="Terminal.Gui.TreeView`1.OnEnter*"></a>
  1979. <h4 id="Terminal_Gui_TreeView_1_OnEnter_Terminal_Gui_View_" data-uid="Terminal.Gui.TreeView`1.OnEnter(Terminal.Gui.View)">OnEnter(View)</h4>
  1980. <div class="markdown level1 summary">
  1981. Method invoked when a view gets focus.
  1982. </div>
  1983. <div class="markdown level1 conceptual"></div>
  1984. <h5 class="decalaration">Declaration</h5>
  1985. <div class="codewrapper">
  1986. <pre><code class="lang-csharp hljs">public override bool OnEnter(View view)</code></pre>
  1987. </div>
  1988. <h5 class="parameters">Parameters</h5>
  1989. <table class="table table-bordered table-striped table-condensed">
  1990. <thead>
  1991. <tr>
  1992. <th>Type</th>
  1993. <th>Name</th>
  1994. <th>Description</th>
  1995. </tr>
  1996. </thead>
  1997. <tbody>
  1998. <tr>
  1999. <td><a class="xref" href="Terminal.Gui.View.html">View</a></td>
  2000. <td><span class="parametername">view</span></td>
  2001. <td>The view that is losing focus.</td>
  2002. </tr>
  2003. </tbody>
  2004. </table>
  2005. <h5 class="returns">Returns</h5>
  2006. <table class="table table-bordered table-striped table-condensed">
  2007. <thead>
  2008. <tr>
  2009. <th>Type</th>
  2010. <th>Description</th>
  2011. </tr>
  2012. </thead>
  2013. <tbody>
  2014. <tr>
  2015. <td><span class="xref">System.Boolean</span></td>
  2016. <td><code>true</code>, if the event was handled, <code>false</code> otherwise.</td>
  2017. </tr>
  2018. </tbody>
  2019. </table>
  2020. <h5 class="overrides">Overrides</h5>
  2021. <div><a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnEnter_Terminal_Gui_View_">View.OnEnter(View)</a></div>
  2022. <a id="Terminal_Gui_TreeView_1_OnObjectActivated_" data-uid="Terminal.Gui.TreeView`1.OnObjectActivated*"></a>
  2023. <h4 id="Terminal_Gui_TreeView_1_OnObjectActivated_Terminal_Gui_Trees_ObjectActivatedEventArgs__0__" data-uid="Terminal.Gui.TreeView`1.OnObjectActivated(Terminal.Gui.Trees.ObjectActivatedEventArgs{`0})">OnObjectActivated(ObjectActivatedEventArgs&lt;T&gt;)</h4>
  2024. <div class="markdown level1 summary">
  2025. Raises the <a class="xref" href="Terminal.Gui.TreeView-1.html#Terminal_Gui_TreeView_1_ObjectActivated">ObjectActivated</a> event
  2026. </div>
  2027. <div class="markdown level1 conceptual"></div>
  2028. <h5 class="decalaration">Declaration</h5>
  2029. <div class="codewrapper">
  2030. <pre><code class="lang-csharp hljs">protected virtual void OnObjectActivated(ObjectActivatedEventArgs&lt;T&gt; e)</code></pre>
  2031. </div>
  2032. <h5 class="parameters">Parameters</h5>
  2033. <table class="table table-bordered table-striped table-condensed">
  2034. <thead>
  2035. <tr>
  2036. <th>Type</th>
  2037. <th>Name</th>
  2038. <th>Description</th>
  2039. </tr>
  2040. </thead>
  2041. <tbody>
  2042. <tr>
  2043. <td><a class="xref" href="Terminal.Gui.Trees.ObjectActivatedEventArgs-1.html">ObjectActivatedEventArgs</a>&lt;T&gt;</td>
  2044. <td><span class="parametername">e</span></td>
  2045. <td></td>
  2046. </tr>
  2047. </tbody>
  2048. </table>
  2049. <a id="Terminal_Gui_TreeView_1_OnSelectionChanged_" data-uid="Terminal.Gui.TreeView`1.OnSelectionChanged*"></a>
  2050. <h4 id="Terminal_Gui_TreeView_1_OnSelectionChanged_Terminal_Gui_Trees_SelectionChangedEventArgs__0__" data-uid="Terminal.Gui.TreeView`1.OnSelectionChanged(Terminal.Gui.Trees.SelectionChangedEventArgs{`0})">OnSelectionChanged(SelectionChangedEventArgs&lt;T&gt;)</h4>
  2051. <div class="markdown level1 summary">
  2052. Raises the SelectionChanged event
  2053. </div>
  2054. <div class="markdown level1 conceptual"></div>
  2055. <h5 class="decalaration">Declaration</h5>
  2056. <div class="codewrapper">
  2057. <pre><code class="lang-csharp hljs">protected virtual void OnSelectionChanged(SelectionChangedEventArgs&lt;T&gt; e)</code></pre>
  2058. </div>
  2059. <h5 class="parameters">Parameters</h5>
  2060. <table class="table table-bordered table-striped table-condensed">
  2061. <thead>
  2062. <tr>
  2063. <th>Type</th>
  2064. <th>Name</th>
  2065. <th>Description</th>
  2066. </tr>
  2067. </thead>
  2068. <tbody>
  2069. <tr>
  2070. <td><a class="xref" href="Terminal.Gui.Trees.SelectionChangedEventArgs-1.html">SelectionChangedEventArgs</a>&lt;T&gt;</td>
  2071. <td><span class="parametername">e</span></td>
  2072. <td></td>
  2073. </tr>
  2074. </tbody>
  2075. </table>
  2076. <a id="Terminal_Gui_TreeView_1_PositionCursor_" data-uid="Terminal.Gui.TreeView`1.PositionCursor*"></a>
  2077. <h4 id="Terminal_Gui_TreeView_1_PositionCursor" data-uid="Terminal.Gui.TreeView`1.PositionCursor">PositionCursor()</h4>
  2078. <div class="markdown level1 summary">
  2079. Positions the cursor at the start of the selected objects line (if visible)
  2080. </div>
  2081. <div class="markdown level1 conceptual"></div>
  2082. <h5 class="decalaration">Declaration</h5>
  2083. <div class="codewrapper">
  2084. <pre><code class="lang-csharp hljs">public override void PositionCursor()</code></pre>
  2085. </div>
  2086. <h5 class="overrides">Overrides</h5>
  2087. <div><a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_PositionCursor">View.PositionCursor()</a></div>
  2088. <a id="Terminal_Gui_TreeView_1_ProcessKey_" data-uid="Terminal.Gui.TreeView`1.ProcessKey*"></a>
  2089. <h4 id="Terminal_Gui_TreeView_1_ProcessKey_Terminal_Gui_KeyEvent_" data-uid="Terminal.Gui.TreeView`1.ProcessKey(Terminal.Gui.KeyEvent)">ProcessKey(KeyEvent)</h4>
  2090. <div class="markdown level1 summary">
  2091. If the view is focused, gives the view a
  2092. chance to process the keystroke.
  2093. </div>
  2094. <div class="markdown level1 conceptual"></div>
  2095. <h5 class="decalaration">Declaration</h5>
  2096. <div class="codewrapper">
  2097. <pre><code class="lang-csharp hljs">public override bool ProcessKey(KeyEvent keyEvent)</code></pre>
  2098. </div>
  2099. <h5 class="parameters">Parameters</h5>
  2100. <table class="table table-bordered table-striped table-condensed">
  2101. <thead>
  2102. <tr>
  2103. <th>Type</th>
  2104. <th>Name</th>
  2105. <th>Description</th>
  2106. </tr>
  2107. </thead>
  2108. <tbody>
  2109. <tr>
  2110. <td><a class="xref" href="Terminal.Gui.KeyEvent.html">KeyEvent</a></td>
  2111. <td><span class="parametername">keyEvent</span></td>
  2112. <td>Contains the details about the key that produced the event.</td>
  2113. </tr>
  2114. </tbody>
  2115. </table>
  2116. <h5 class="returns">Returns</h5>
  2117. <table class="table table-bordered table-striped table-condensed">
  2118. <thead>
  2119. <tr>
  2120. <th>Type</th>
  2121. <th>Description</th>
  2122. </tr>
  2123. </thead>
  2124. <tbody>
  2125. <tr>
  2126. <td><span class="xref">System.Boolean</span></td>
  2127. <td></td>
  2128. </tr>
  2129. </tbody>
  2130. </table>
  2131. <h5 class="overrides">Overrides</h5>
  2132. <div><a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ProcessKey_Terminal_Gui_KeyEvent_">View.ProcessKey(KeyEvent)</a></div>
  2133. <a id="Terminal_Gui_TreeView_1_RebuildTree_" data-uid="Terminal.Gui.TreeView`1.RebuildTree*"></a>
  2134. <h4 id="Terminal_Gui_TreeView_1_RebuildTree" data-uid="Terminal.Gui.TreeView`1.RebuildTree">RebuildTree()</h4>
  2135. <div class="markdown level1 summary">
  2136. Rebuilds the tree structure for all exposed objects starting with the root objects.
  2137. Call this method when you know there are changes to the tree but don&apos;t know which
  2138. 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>)
  2139. </div>
  2140. <div class="markdown level1 conceptual"></div>
  2141. <h5 class="decalaration">Declaration</h5>
  2142. <div class="codewrapper">
  2143. <pre><code class="lang-csharp hljs">public void RebuildTree()</code></pre>
  2144. </div>
  2145. <a id="Terminal_Gui_TreeView_1_Redraw_" data-uid="Terminal.Gui.TreeView`1.Redraw*"></a>
  2146. <h4 id="Terminal_Gui_TreeView_1_Redraw_Terminal_Gui_Rect_" data-uid="Terminal.Gui.TreeView`1.Redraw(Terminal.Gui.Rect)">Redraw(Rect)</h4>
  2147. <div class="markdown level1 summary">
  2148. Redraws this view and its subviews; only redraws the views that have been flagged for a re-display.
  2149. </div>
  2150. <div class="markdown level1 conceptual"></div>
  2151. <h5 class="decalaration">Declaration</h5>
  2152. <div class="codewrapper">
  2153. <pre><code class="lang-csharp hljs">public override void Redraw(Rect bounds)</code></pre>
  2154. </div>
  2155. <h5 class="parameters">Parameters</h5>
  2156. <table class="table table-bordered table-striped table-condensed">
  2157. <thead>
  2158. <tr>
  2159. <th>Type</th>
  2160. <th>Name</th>
  2161. <th>Description</th>
  2162. </tr>
  2163. </thead>
  2164. <tbody>
  2165. <tr>
  2166. <td><a class="xref" href="Terminal.Gui.Rect.html">Rect</a></td>
  2167. <td><span class="parametername">bounds</span></td>
  2168. <td>The bounds (view-relative region) to redraw.</td>
  2169. </tr>
  2170. </tbody>
  2171. </table>
  2172. <h5 class="overrides">Overrides</h5>
  2173. <div><a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Redraw_Terminal_Gui_Rect_">View.Redraw(Rect)</a></div>
  2174. <a id="Terminal_Gui_TreeView_1_RefreshObject_" data-uid="Terminal.Gui.TreeView`1.RefreshObject*"></a>
  2175. <h4 id="Terminal_Gui_TreeView_1_RefreshObject__0_System_Boolean_" data-uid="Terminal.Gui.TreeView`1.RefreshObject(`0,System.Boolean)">RefreshObject(T, Boolean)</h4>
  2176. <div class="markdown level1 summary">
  2177. Refreshes the state of the object <code data-dev-comment-type="paramref" class="paramref">o</code> in the tree. This will
  2178. recompute children, string representation etc
  2179. </div>
  2180. <div class="markdown level1 conceptual"></div>
  2181. <h5 class="decalaration">Declaration</h5>
  2182. <div class="codewrapper">
  2183. <pre><code class="lang-csharp hljs">public void RefreshObject(T o, bool startAtTop = false)</code></pre>
  2184. </div>
  2185. <h5 class="parameters">Parameters</h5>
  2186. <table class="table table-bordered table-striped table-condensed">
  2187. <thead>
  2188. <tr>
  2189. <th>Type</th>
  2190. <th>Name</th>
  2191. <th>Description</th>
  2192. </tr>
  2193. </thead>
  2194. <tbody>
  2195. <tr>
  2196. <td><span class="xref">T</span></td>
  2197. <td><span class="parametername">o</span></td>
  2198. <td></td>
  2199. </tr>
  2200. <tr>
  2201. <td><span class="xref">System.Boolean</span></td>
  2202. <td><span class="parametername">startAtTop</span></td>
  2203. <td>True to also refresh all ancestors of the objects branch
  2204. (starting with the root). False to refresh only the passed node</td>
  2205. </tr>
  2206. </tbody>
  2207. </table>
  2208. <a id="Terminal_Gui_TreeView_1_Remove_" data-uid="Terminal.Gui.TreeView`1.Remove*"></a>
  2209. <h4 id="Terminal_Gui_TreeView_1_Remove__0_" data-uid="Terminal.Gui.TreeView`1.Remove(`0)">Remove(T)</h4>
  2210. <div class="markdown level1 summary">
  2211. Removes the given root object from the tree
  2212. </div>
  2213. <div class="markdown level1 conceptual"></div>
  2214. <h5 class="decalaration">Declaration</h5>
  2215. <div class="codewrapper">
  2216. <pre><code class="lang-csharp hljs">public void Remove(T o)</code></pre>
  2217. </div>
  2218. <h5 class="parameters">Parameters</h5>
  2219. <table class="table table-bordered table-striped table-condensed">
  2220. <thead>
  2221. <tr>
  2222. <th>Type</th>
  2223. <th>Name</th>
  2224. <th>Description</th>
  2225. </tr>
  2226. </thead>
  2227. <tbody>
  2228. <tr>
  2229. <td><span class="xref">T</span></td>
  2230. <td><span class="parametername">o</span></td>
  2231. <td></td>
  2232. </tr>
  2233. </tbody>
  2234. </table>
  2235. <a id="Terminal_Gui_TreeView_1_ScrollDown_" data-uid="Terminal.Gui.TreeView`1.ScrollDown*"></a>
  2236. <h4 id="Terminal_Gui_TreeView_1_ScrollDown" data-uid="Terminal.Gui.TreeView`1.ScrollDown">ScrollDown()</h4>
  2237. <div class="markdown level1 summary">
  2238. Scrolls the view area down a single line without changing the current selection
  2239. </div>
  2240. <div class="markdown level1 conceptual"></div>
  2241. <h5 class="decalaration">Declaration</h5>
  2242. <div class="codewrapper">
  2243. <pre><code class="lang-csharp hljs">public void ScrollDown()</code></pre>
  2244. </div>
  2245. <a id="Terminal_Gui_TreeView_1_ScrollUp_" data-uid="Terminal.Gui.TreeView`1.ScrollUp*"></a>
  2246. <h4 id="Terminal_Gui_TreeView_1_ScrollUp" data-uid="Terminal.Gui.TreeView`1.ScrollUp">ScrollUp()</h4>
  2247. <div class="markdown level1 summary">
  2248. Scrolls the view area up a single line without changing the current selection
  2249. </div>
  2250. <div class="markdown level1 conceptual"></div>
  2251. <h5 class="decalaration">Declaration</h5>
  2252. <div class="codewrapper">
  2253. <pre><code class="lang-csharp hljs">public void ScrollUp()</code></pre>
  2254. </div>
  2255. <a id="Terminal_Gui_TreeView_1_SelectAll_" data-uid="Terminal.Gui.TreeView`1.SelectAll*"></a>
  2256. <h4 id="Terminal_Gui_TreeView_1_SelectAll" data-uid="Terminal.Gui.TreeView`1.SelectAll">SelectAll()</h4>
  2257. <div class="markdown level1 summary">
  2258. 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
  2259. does nothing
  2260. </div>
  2261. <div class="markdown level1 conceptual"></div>
  2262. <h5 class="decalaration">Declaration</h5>
  2263. <div class="codewrapper">
  2264. <pre><code class="lang-csharp hljs">public void SelectAll()</code></pre>
  2265. </div>
  2266. <h3 id="events">Events
  2267. </h3>
  2268. <h4 id="Terminal_Gui_TreeView_1_ObjectActivated" data-uid="Terminal.Gui.TreeView`1.ObjectActivated">ObjectActivated</h4>
  2269. <div class="markdown level1 summary">
  2270. This event is raised when an object is activated e.g. by double clicking or
  2271. pressing <a class="xref" href="Terminal.Gui.TreeView-1.html#Terminal_Gui_TreeView_1_ObjectActivationKey">ObjectActivationKey</a>
  2272. </div>
  2273. <div class="markdown level1 conceptual"></div>
  2274. <h5 class="decalaration">Declaration</h5>
  2275. <div class="codewrapper">
  2276. <pre><code class="lang-csharp hljs">public event Action&lt;ObjectActivatedEventArgs&lt;T&gt;&gt; ObjectActivated</code></pre>
  2277. </div>
  2278. <h5 class="eventType">Event Type</h5>
  2279. <table class="table table-bordered table-striped table-condensed">
  2280. <thead>
  2281. <tr>
  2282. <th>Type</th>
  2283. <th>Description</th>
  2284. </tr>
  2285. </thead>
  2286. <tbody>
  2287. <tr>
  2288. <td><span class="xref">System.Action</span>&lt;<a class="xref" href="Terminal.Gui.Trees.ObjectActivatedEventArgs-1.html">ObjectActivatedEventArgs</a>&lt;T&gt;&gt;</td>
  2289. <td></td>
  2290. </tr>
  2291. </tbody>
  2292. </table>
  2293. <h4 id="Terminal_Gui_TreeView_1_SelectionChanged" data-uid="Terminal.Gui.TreeView`1.SelectionChanged">SelectionChanged</h4>
  2294. <div class="markdown level1 summary">
  2295. Called when the <a class="xref" href="Terminal.Gui.TreeView-1.html#Terminal_Gui_TreeView_1_SelectedObject">SelectedObject</a> changes
  2296. </div>
  2297. <div class="markdown level1 conceptual"></div>
  2298. <h5 class="decalaration">Declaration</h5>
  2299. <div class="codewrapper">
  2300. <pre><code class="lang-csharp hljs">public event EventHandler&lt;SelectionChangedEventArgs&lt;T&gt;&gt; SelectionChanged</code></pre>
  2301. </div>
  2302. <h5 class="eventType">Event Type</h5>
  2303. <table class="table table-bordered table-striped table-condensed">
  2304. <thead>
  2305. <tr>
  2306. <th>Type</th>
  2307. <th>Description</th>
  2308. </tr>
  2309. </thead>
  2310. <tbody>
  2311. <tr>
  2312. <td><span class="xref">System.EventHandler</span>&lt;<a class="xref" href="Terminal.Gui.Trees.SelectionChangedEventArgs-1.html">SelectionChangedEventArgs</a>&lt;T&gt;&gt;</td>
  2313. <td></td>
  2314. </tr>
  2315. </tbody>
  2316. </table>
  2317. <h3 id="implements">Implements</h3>
  2318. <div>
  2319. <span class="xref">System.IDisposable</span>
  2320. </div>
  2321. <div>
  2322. <span class="xref">System.ComponentModel.ISupportInitializeNotification</span>
  2323. </div>
  2324. <div>
  2325. <span class="xref">System.ComponentModel.ISupportInitialize</span>
  2326. </div>
  2327. <div>
  2328. <a class="xref" href="Terminal.Gui.ITreeView.html">ITreeView</a>
  2329. </div>
  2330. </article>
  2331. </div>
  2332. <div class="hidden-sm col-md-2" role="complementary">
  2333. <div class="sideaffix">
  2334. <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
  2335. <h5>In This Article</h5>
  2336. <div></div>
  2337. </nav>
  2338. </div>
  2339. </div>
  2340. </div>
  2341. </div>
  2342. <footer>
  2343. <div class="grad-bottom"></div>
  2344. <div class="footer">
  2345. <div class="container">
  2346. <span class="pull-right">
  2347. <a href="#top">Back to top</a>
  2348. </span>
  2349. <span>Generated by <strong>DocFX</strong></span>
  2350. </div>
  2351. </div>
  2352. </footer>
  2353. </div>
  2354. <script type="text/javascript" src="../../styles/docfx.vendor.js"></script>
  2355. <script type="text/javascript" src="../../styles/docfx.js"></script>
  2356. <script type="text/javascript" src="../../styles/main.js"></script>
  2357. </body>
  2358. </html>