Terminal.Gui.Trees.TreeStyle.html 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301
  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 TreeStyle
  8. </title>
  9. <meta name="viewport" content="width=device-width">
  10. <meta name="title" content="Class TreeStyle
  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.Trees.TreeStyle">
  74. <h1 id="Terminal_Gui_Trees_TreeStyle" data-uid="Terminal.Gui.Trees.TreeStyle" class="text-break">Class TreeStyle
  75. </h1>
  76. <div class="markdown level0 summary">
  77. Defines rendering options that affect how the tree is displayed
  78. </div>
  79. <div class="markdown level0 conceptual"></div>
  80. <div class="inheritance">
  81. <h5>Inheritance</h5>
  82. <div class="level0"><span class="xref">System.Object</span></div>
  83. <div class="level1"><span class="xref">TreeStyle</span></div>
  84. </div>
  85. <h6><strong>Namespace</strong>: <a class="xref" href="Terminal.Gui.Trees.html">Terminal.Gui.Trees</a></h6>
  86. <h6><strong>Assembly</strong>: Terminal.Gui.dll</h6>
  87. <h5 id="Terminal_Gui_Trees_TreeStyle_syntax">Syntax</h5>
  88. <div class="codewrapper">
  89. <pre><code class="lang-csharp hljs">public class TreeStyle : Object</code></pre>
  90. </div>
  91. <h3 id="constructors">Constructors
  92. </h3>
  93. <a id="Terminal_Gui_Trees_TreeStyle__ctor_" data-uid="Terminal.Gui.Trees.TreeStyle.#ctor*"></a>
  94. <h4 id="Terminal_Gui_Trees_TreeStyle__ctor" data-uid="Terminal.Gui.Trees.TreeStyle.#ctor">TreeStyle()</h4>
  95. <div class="markdown level1 summary"></div>
  96. <div class="markdown level1 conceptual"></div>
  97. <h5 class="decalaration">Declaration</h5>
  98. <div class="codewrapper">
  99. <pre><code class="lang-csharp hljs">public TreeStyle()</code></pre>
  100. </div>
  101. <h3 id="properties">Properties
  102. </h3>
  103. <a id="Terminal_Gui_Trees_TreeStyle_CollapseableSymbol_" data-uid="Terminal.Gui.Trees.TreeStyle.CollapseableSymbol*"></a>
  104. <h4 id="Terminal_Gui_Trees_TreeStyle_CollapseableSymbol" data-uid="Terminal.Gui.Trees.TreeStyle.CollapseableSymbol">CollapseableSymbol</h4>
  105. <div class="markdown level1 summary">
  106. Symbol to use for branch nodes that can be collapsed (are currently expanded).
  107. Defaults to &apos;-&apos;. Set to null to hide
  108. </div>
  109. <div class="markdown level1 conceptual"></div>
  110. <h5 class="decalaration">Declaration</h5>
  111. <div class="codewrapper">
  112. <pre><code class="lang-csharp hljs">public Nullable&lt;Rune&gt; CollapseableSymbol { get; set; }</code></pre>
  113. </div>
  114. <h5 class="propertyValue">Property Value</h5>
  115. <table class="table table-bordered table-striped table-condensed">
  116. <thead>
  117. <tr>
  118. <th>Type</th>
  119. <th>Description</th>
  120. </tr>
  121. </thead>
  122. <tbody>
  123. <tr>
  124. <td><span class="xref">System.Nullable</span>&lt;<span class="xref">System.Rune</span>&gt;</td>
  125. <td></td>
  126. </tr>
  127. </tbody>
  128. </table>
  129. <a id="Terminal_Gui_Trees_TreeStyle_ColorExpandSymbol_" data-uid="Terminal.Gui.Trees.TreeStyle.ColorExpandSymbol*"></a>
  130. <h4 id="Terminal_Gui_Trees_TreeStyle_ColorExpandSymbol" data-uid="Terminal.Gui.Trees.TreeStyle.ColorExpandSymbol">ColorExpandSymbol</h4>
  131. <div class="markdown level1 summary">
  132. Set to true to highlight expand/collapse symbols in hot key color
  133. </div>
  134. <div class="markdown level1 conceptual"></div>
  135. <h5 class="decalaration">Declaration</h5>
  136. <div class="codewrapper">
  137. <pre><code class="lang-csharp hljs">public bool ColorExpandSymbol { get; set; }</code></pre>
  138. </div>
  139. <h5 class="propertyValue">Property Value</h5>
  140. <table class="table table-bordered table-striped table-condensed">
  141. <thead>
  142. <tr>
  143. <th>Type</th>
  144. <th>Description</th>
  145. </tr>
  146. </thead>
  147. <tbody>
  148. <tr>
  149. <td><span class="xref">System.Boolean</span></td>
  150. <td></td>
  151. </tr>
  152. </tbody>
  153. </table>
  154. <a id="Terminal_Gui_Trees_TreeStyle_ExpandableSymbol_" data-uid="Terminal.Gui.Trees.TreeStyle.ExpandableSymbol*"></a>
  155. <h4 id="Terminal_Gui_Trees_TreeStyle_ExpandableSymbol" data-uid="Terminal.Gui.Trees.TreeStyle.ExpandableSymbol">ExpandableSymbol</h4>
  156. <div class="markdown level1 summary">
  157. Symbol to use for branch nodes that can be expanded to indicate this to the user.
  158. Defaults to &apos;+&apos;. Set to null to hide
  159. </div>
  160. <div class="markdown level1 conceptual"></div>
  161. <h5 class="decalaration">Declaration</h5>
  162. <div class="codewrapper">
  163. <pre><code class="lang-csharp hljs">public Nullable&lt;Rune&gt; ExpandableSymbol { get; set; }</code></pre>
  164. </div>
  165. <h5 class="propertyValue">Property Value</h5>
  166. <table class="table table-bordered table-striped table-condensed">
  167. <thead>
  168. <tr>
  169. <th>Type</th>
  170. <th>Description</th>
  171. </tr>
  172. </thead>
  173. <tbody>
  174. <tr>
  175. <td><span class="xref">System.Nullable</span>&lt;<span class="xref">System.Rune</span>&gt;</td>
  176. <td></td>
  177. </tr>
  178. </tbody>
  179. </table>
  180. <a id="Terminal_Gui_Trees_TreeStyle_InvertExpandSymbolColors_" data-uid="Terminal.Gui.Trees.TreeStyle.InvertExpandSymbolColors*"></a>
  181. <h4 id="Terminal_Gui_Trees_TreeStyle_InvertExpandSymbolColors" data-uid="Terminal.Gui.Trees.TreeStyle.InvertExpandSymbolColors">InvertExpandSymbolColors</h4>
  182. <div class="markdown level1 summary">
  183. Invert console colours used to render the expand symbol
  184. </div>
  185. <div class="markdown level1 conceptual"></div>
  186. <h5 class="decalaration">Declaration</h5>
  187. <div class="codewrapper">
  188. <pre><code class="lang-csharp hljs">public bool InvertExpandSymbolColors { get; set; }</code></pre>
  189. </div>
  190. <h5 class="propertyValue">Property Value</h5>
  191. <table class="table table-bordered table-striped table-condensed">
  192. <thead>
  193. <tr>
  194. <th>Type</th>
  195. <th>Description</th>
  196. </tr>
  197. </thead>
  198. <tbody>
  199. <tr>
  200. <td><span class="xref">System.Boolean</span></td>
  201. <td></td>
  202. </tr>
  203. </tbody>
  204. </table>
  205. <a id="Terminal_Gui_Trees_TreeStyle_LeaveLastRow_" data-uid="Terminal.Gui.Trees.TreeStyle.LeaveLastRow*"></a>
  206. <h4 id="Terminal_Gui_Trees_TreeStyle_LeaveLastRow" data-uid="Terminal.Gui.Trees.TreeStyle.LeaveLastRow">LeaveLastRow</h4>
  207. <div class="markdown level1 summary">
  208. True to leave the last row of the control free for overwritting (e.g. by a scrollbar)
  209. When True scrolling will be triggered on the second last row of the control rather than
  210. the last.
  211. </div>
  212. <div class="markdown level1 conceptual"></div>
  213. <h5 class="decalaration">Declaration</h5>
  214. <div class="codewrapper">
  215. <pre><code class="lang-csharp hljs">public bool LeaveLastRow { get; set; }</code></pre>
  216. </div>
  217. <h5 class="propertyValue">Property Value</h5>
  218. <table class="table table-bordered table-striped table-condensed">
  219. <thead>
  220. <tr>
  221. <th>Type</th>
  222. <th>Description</th>
  223. </tr>
  224. </thead>
  225. <tbody>
  226. <tr>
  227. <td><span class="xref">System.Boolean</span></td>
  228. <td></td>
  229. </tr>
  230. </tbody>
  231. </table>
  232. <a id="Terminal_Gui_Trees_TreeStyle_ShowBranchLines_" data-uid="Terminal.Gui.Trees.TreeStyle.ShowBranchLines*"></a>
  233. <h4 id="Terminal_Gui_Trees_TreeStyle_ShowBranchLines" data-uid="Terminal.Gui.Trees.TreeStyle.ShowBranchLines">ShowBranchLines</h4>
  234. <div class="markdown level1 summary">
  235. True to render vertical lines under expanded nodes to show which node belongs to which
  236. parent. False to use only whitespace
  237. </div>
  238. <div class="markdown level1 conceptual"></div>
  239. <h5 class="decalaration">Declaration</h5>
  240. <div class="codewrapper">
  241. <pre><code class="lang-csharp hljs">public bool ShowBranchLines { get; set; }</code></pre>
  242. </div>
  243. <h5 class="propertyValue">Property Value</h5>
  244. <table class="table table-bordered table-striped table-condensed">
  245. <thead>
  246. <tr>
  247. <th>Type</th>
  248. <th>Description</th>
  249. </tr>
  250. </thead>
  251. <tbody>
  252. <tr>
  253. <td><span class="xref">System.Boolean</span></td>
  254. <td></td>
  255. </tr>
  256. </tbody>
  257. </table>
  258. </article>
  259. </div>
  260. <div class="hidden-sm col-md-2" role="complementary">
  261. <div class="sideaffix">
  262. <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
  263. <h5>In This Article</h5>
  264. <div></div>
  265. </nav>
  266. </div>
  267. </div>
  268. </div>
  269. </div>
  270. <footer>
  271. <div class="grad-bottom"></div>
  272. <div class="footer">
  273. <div class="container">
  274. <span class="pull-right">
  275. <a href="#top">Back to top</a>
  276. </span>
  277. <span>Generated by <strong>DocFX</strong></span>
  278. </div>
  279. </div>
  280. </footer>
  281. </div>
  282. <script type="text/javascript" src="../../styles/docfx.vendor.js"></script>
  283. <script type="text/javascript" src="../../styles/docfx.js"></script>
  284. <script type="text/javascript" src="../../styles/main.js"></script>
  285. </body>
  286. </html>