Terminal.Gui.Trees.TreeNode.html 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285
  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 TreeNode
  8. </title>
  9. <meta name="viewport" content="width=device-width">
  10. <meta name="title" content="Class TreeNode
  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.TreeNode">
  74. <h1 id="Terminal_Gui_Trees_TreeNode" data-uid="Terminal.Gui.Trees.TreeNode" class="text-break">Class TreeNode
  75. </h1>
  76. <div class="markdown level0 summary">
  77. Simple class for representing nodes, use with regular (non generic) <a class="xref" href="Terminal.Gui.TreeView.html">TreeView</a>.
  78. </div>
  79. <div class="markdown level0 conceptual"></div>
  80. <div class="inheritance">
  81. <h5>Inheritance</h5>
  82. <div class="level0"><span class="xref">System.Object</span></div>
  83. <div class="level1"><span class="xref">TreeNode</span></div>
  84. </div>
  85. <div class="implements">
  86. <h5>Implements</h5>
  87. <div><a class="xref" href="Terminal.Gui.Trees.ITreeNode.html">ITreeNode</a></div>
  88. </div>
  89. <h6><strong>Namespace</strong>: <a class="xref" href="Terminal.Gui.Trees.html">Terminal.Gui.Trees</a></h6>
  90. <h6><strong>Assembly</strong>: Terminal.Gui.dll</h6>
  91. <h5 id="Terminal_Gui_Trees_TreeNode_syntax">Syntax</h5>
  92. <div class="codewrapper">
  93. <pre><code class="lang-csharp hljs">public class TreeNode : Object, ITreeNode</code></pre>
  94. </div>
  95. <h3 id="constructors">Constructors
  96. </h3>
  97. <a id="Terminal_Gui_Trees_TreeNode__ctor_" data-uid="Terminal.Gui.Trees.TreeNode.#ctor*"></a>
  98. <h4 id="Terminal_Gui_Trees_TreeNode__ctor" data-uid="Terminal.Gui.Trees.TreeNode.#ctor">TreeNode()</h4>
  99. <div class="markdown level1 summary">
  100. Initialises a new instance with no <a class="xref" href="Terminal.Gui.Trees.TreeNode.html#Terminal_Gui_Trees_TreeNode_Text">Text</a>
  101. </div>
  102. <div class="markdown level1 conceptual"></div>
  103. <h5 class="decalaration">Declaration</h5>
  104. <div class="codewrapper">
  105. <pre><code class="lang-csharp hljs">public TreeNode()</code></pre>
  106. </div>
  107. <a id="Terminal_Gui_Trees_TreeNode__ctor_" data-uid="Terminal.Gui.Trees.TreeNode.#ctor*"></a>
  108. <h4 id="Terminal_Gui_Trees_TreeNode__ctor_System_String_" data-uid="Terminal.Gui.Trees.TreeNode.#ctor(System.String)">TreeNode(String)</h4>
  109. <div class="markdown level1 summary">
  110. Initialises a new instance and sets starting <a class="xref" href="Terminal.Gui.Trees.TreeNode.html#Terminal_Gui_Trees_TreeNode_Text">Text</a>
  111. </div>
  112. <div class="markdown level1 conceptual"></div>
  113. <h5 class="decalaration">Declaration</h5>
  114. <div class="codewrapper">
  115. <pre><code class="lang-csharp hljs">public TreeNode(string text)</code></pre>
  116. </div>
  117. <h5 class="parameters">Parameters</h5>
  118. <table class="table table-bordered table-striped table-condensed">
  119. <thead>
  120. <tr>
  121. <th>Type</th>
  122. <th>Name</th>
  123. <th>Description</th>
  124. </tr>
  125. </thead>
  126. <tbody>
  127. <tr>
  128. <td><span class="xref">System.String</span></td>
  129. <td><span class="parametername">text</span></td>
  130. <td></td>
  131. </tr>
  132. </tbody>
  133. </table>
  134. <h3 id="properties">Properties
  135. </h3>
  136. <a id="Terminal_Gui_Trees_TreeNode_Children_" data-uid="Terminal.Gui.Trees.TreeNode.Children*"></a>
  137. <h4 id="Terminal_Gui_Trees_TreeNode_Children" data-uid="Terminal.Gui.Trees.TreeNode.Children">Children</h4>
  138. <div class="markdown level1 summary">
  139. Children of the current node
  140. </div>
  141. <div class="markdown level1 conceptual"></div>
  142. <h5 class="decalaration">Declaration</h5>
  143. <div class="codewrapper">
  144. <pre><code class="lang-csharp hljs">public virtual IList&lt;ITreeNode&gt; Children { get; set; }</code></pre>
  145. </div>
  146. <h5 class="propertyValue">Property Value</h5>
  147. <table class="table table-bordered table-striped table-condensed">
  148. <thead>
  149. <tr>
  150. <th>Type</th>
  151. <th>Description</th>
  152. </tr>
  153. </thead>
  154. <tbody>
  155. <tr>
  156. <td><span class="xref">System.Collections.Generic.IList</span>&lt;<a class="xref" href="Terminal.Gui.Trees.ITreeNode.html">ITreeNode</a>&gt;</td>
  157. <td></td>
  158. </tr>
  159. </tbody>
  160. </table>
  161. <a id="Terminal_Gui_Trees_TreeNode_Tag_" data-uid="Terminal.Gui.Trees.TreeNode.Tag*"></a>
  162. <h4 id="Terminal_Gui_Trees_TreeNode_Tag" data-uid="Terminal.Gui.Trees.TreeNode.Tag">Tag</h4>
  163. <div class="markdown level1 summary">
  164. Optionally allows you to store some custom data/class here.
  165. </div>
  166. <div class="markdown level1 conceptual"></div>
  167. <h5 class="decalaration">Declaration</h5>
  168. <div class="codewrapper">
  169. <pre><code class="lang-csharp hljs">public object Tag { get; set; }</code></pre>
  170. </div>
  171. <h5 class="propertyValue">Property Value</h5>
  172. <table class="table table-bordered table-striped table-condensed">
  173. <thead>
  174. <tr>
  175. <th>Type</th>
  176. <th>Description</th>
  177. </tr>
  178. </thead>
  179. <tbody>
  180. <tr>
  181. <td><span class="xref">System.Object</span></td>
  182. <td></td>
  183. </tr>
  184. </tbody>
  185. </table>
  186. <a id="Terminal_Gui_Trees_TreeNode_Text_" data-uid="Terminal.Gui.Trees.TreeNode.Text*"></a>
  187. <h4 id="Terminal_Gui_Trees_TreeNode_Text" data-uid="Terminal.Gui.Trees.TreeNode.Text">Text</h4>
  188. <div class="markdown level1 summary">
  189. Text to display in tree node for current entry
  190. </div>
  191. <div class="markdown level1 conceptual"></div>
  192. <h5 class="decalaration">Declaration</h5>
  193. <div class="codewrapper">
  194. <pre><code class="lang-csharp hljs">public virtual string Text { get; set; }</code></pre>
  195. </div>
  196. <h5 class="propertyValue">Property Value</h5>
  197. <table class="table table-bordered table-striped table-condensed">
  198. <thead>
  199. <tr>
  200. <th>Type</th>
  201. <th>Description</th>
  202. </tr>
  203. </thead>
  204. <tbody>
  205. <tr>
  206. <td><span class="xref">System.String</span></td>
  207. <td></td>
  208. </tr>
  209. </tbody>
  210. </table>
  211. <h3 id="methods">Methods
  212. </h3>
  213. <a id="Terminal_Gui_Trees_TreeNode_ToString_" data-uid="Terminal.Gui.Trees.TreeNode.ToString*"></a>
  214. <h4 id="Terminal_Gui_Trees_TreeNode_ToString" data-uid="Terminal.Gui.Trees.TreeNode.ToString">ToString()</h4>
  215. <div class="markdown level1 summary">
  216. returns <a class="xref" href="Terminal.Gui.Trees.TreeNode.html#Terminal_Gui_Trees_TreeNode_Text">Text</a>
  217. </div>
  218. <div class="markdown level1 conceptual"></div>
  219. <h5 class="decalaration">Declaration</h5>
  220. <div class="codewrapper">
  221. <pre><code class="lang-csharp hljs">public override string ToString()</code></pre>
  222. </div>
  223. <h5 class="returns">Returns</h5>
  224. <table class="table table-bordered table-striped table-condensed">
  225. <thead>
  226. <tr>
  227. <th>Type</th>
  228. <th>Description</th>
  229. </tr>
  230. </thead>
  231. <tbody>
  232. <tr>
  233. <td><span class="xref">System.String</span></td>
  234. <td></td>
  235. </tr>
  236. </tbody>
  237. </table>
  238. <h3 id="implements">Implements</h3>
  239. <div>
  240. <a class="xref" href="Terminal.Gui.Trees.ITreeNode.html">ITreeNode</a>
  241. </div>
  242. </article>
  243. </div>
  244. <div class="hidden-sm col-md-2" role="complementary">
  245. <div class="sideaffix">
  246. <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
  247. <h5>In This Article</h5>
  248. <div></div>
  249. </nav>
  250. </div>
  251. </div>
  252. </div>
  253. </div>
  254. <footer>
  255. <div class="grad-bottom"></div>
  256. <div class="footer">
  257. <div class="container">
  258. <span class="pull-right">
  259. <a href="#top">Back to top</a>
  260. </span>
  261. <span>Generated by <strong>DocFX</strong></span>
  262. </div>
  263. </div>
  264. </footer>
  265. </div>
  266. <script type="text/javascript" src="../../styles/docfx.vendor.js"></script>
  267. <script type="text/javascript" src="../../styles/docfx.js"></script>
  268. <script type="text/javascript" src="../../styles/main.js"></script>
  269. </body>
  270. </html>