Terminal.Gui.TreeNode.html 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323
  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.56.7.0">
  13. <link rel="shortcut icon" href="../../favicon.ico">
  14. <link rel="stylesheet" href="../../styles/docfx.vendor.css">
  15. <link rel="stylesheet" href="../../styles/docfx.css">
  16. <link rel="stylesheet" href="../../styles/main.css">
  17. <meta property="docfx:navrel" content="../../toc.html">
  18. <meta property="docfx:tocrel" content="toc.html">
  19. <meta property="docfx:rel" content="../../">
  20. </head>
  21. <body data-spy="scroll" data-target="#affix" data-offset="120">
  22. <div id="wrapper">
  23. <header>
  24. <nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation">
  25. <div class="container">
  26. <div class="navbar-header">
  27. <button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
  28. <span class="sr-only">Toggle navigation</span>
  29. <span class="icon-bar"></span>
  30. <span class="icon-bar"></span>
  31. <span class="icon-bar"></span>
  32. </button>
  33. <a class="navbar-brand" href="../../index.html">
  34. <img id="logo" class="svg" src="../../images/logo48.png" alt="">
  35. </a>
  36. </div>
  37. <div class="collapse navbar-collapse" id="navbar">
  38. <form class="navbar-form navbar-right" role="search" id="search">
  39. <div class="form-group">
  40. <input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">
  41. </div>
  42. </form>
  43. </div>
  44. </div>
  45. </nav>
  46. <div class="subnav navbar navbar-default">
  47. <div class="container hide-when-search" id="breadcrumb">
  48. <ul class="breadcrumb">
  49. <li></li>
  50. </ul>
  51. </div>
  52. </div>
  53. </header>
  54. <div class="container body-content">
  55. <div id="search-results">
  56. <div class="search-list">Search Results for <span></span></div>
  57. <div class="sr-items">
  58. <p><i class="glyphicon glyphicon-refresh index-loading"></i></p>
  59. </div>
  60. <ul id="pagination" data-first="First" data-prev="Previous" data-next="Next" data-last="Last"></ul>
  61. </div>
  62. </div>
  63. <div role="main" class="container body-content hide-when-search">
  64. <div class="sidenav hide-when-search">
  65. <a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
  66. <div class="sidetoggle collapse" id="sidetoggle">
  67. <div id="sidetoc"></div>
  68. </div>
  69. </div>
  70. <div class="article row grid-right">
  71. <div class="col-md-10">
  72. <article class="content wrap" id="_content" data-uid="Terminal.Gui.TreeNode">
  73. <h1 id="Terminal_Gui_TreeNode" data-uid="Terminal.Gui.TreeNode" class="text-break">Class TreeNode
  74. </h1>
  75. <div class="markdown level0 summary">
  76. Simple class for representing nodes, use with regular (non generic) <a class="xref" href="Terminal.Gui.TreeView.html">TreeView</a>.
  77. </div>
  78. <div class="markdown level0 conceptual"></div>
  79. <div class="inheritance">
  80. <h5>Inheritance</h5>
  81. <div class="level0"><span class="xref">System.Object</span></div>
  82. <div class="level1"><span class="xref">TreeNode</span></div>
  83. </div>
  84. <div classs="implements">
  85. <h5>Implements</h5>
  86. <div><a class="xref" href="Terminal.Gui.ITreeNode.html">ITreeNode</a></div>
  87. </div>
  88. <div class="inheritedMembers">
  89. <h5>Inherited Members</h5>
  90. <div>
  91. <span class="xref">System.Object.Equals(System.Object)</span>
  92. </div>
  93. <div>
  94. <span class="xref">System.Object.Equals(System.Object, System.Object)</span>
  95. </div>
  96. <div>
  97. <span class="xref">System.Object.GetHashCode()</span>
  98. </div>
  99. <div>
  100. <span class="xref">System.Object.GetType()</span>
  101. </div>
  102. <div>
  103. <span class="xref">System.Object.MemberwiseClone()</span>
  104. </div>
  105. <div>
  106. <span class="xref">System.Object.ReferenceEquals(System.Object, System.Object)</span>
  107. </div>
  108. </div>
  109. <h6><strong>Namespace</strong>: <a class="xref" href="Terminal.Gui.html">Terminal.Gui</a></h6>
  110. <h6><strong>Assembly</strong>: Terminal.Gui.dll</h6>
  111. <h5 id="Terminal_Gui_TreeNode_syntax">Syntax</h5>
  112. <div class="codewrapper">
  113. <pre><code class="lang-csharp hljs">public class TreeNode : ITreeNode</code></pre>
  114. </div>
  115. <h3 id="constructors">Constructors
  116. </h3>
  117. <a id="Terminal_Gui_TreeNode__ctor_" data-uid="Terminal.Gui.TreeNode.#ctor*"></a>
  118. <h4 id="Terminal_Gui_TreeNode__ctor" data-uid="Terminal.Gui.TreeNode.#ctor">TreeNode()</h4>
  119. <div class="markdown level1 summary">
  120. Initialises a new instance with no <a class="xref" href="Terminal.Gui.TreeNode.html#Terminal_Gui_TreeNode_Text">Text</a>
  121. </div>
  122. <div class="markdown level1 conceptual"></div>
  123. <h5 class="decalaration">Declaration</h5>
  124. <div class="codewrapper">
  125. <pre><code class="lang-csharp hljs">public TreeNode()</code></pre>
  126. </div>
  127. <a id="Terminal_Gui_TreeNode__ctor_" data-uid="Terminal.Gui.TreeNode.#ctor*"></a>
  128. <h4 id="Terminal_Gui_TreeNode__ctor_System_String_" data-uid="Terminal.Gui.TreeNode.#ctor(System.String)">TreeNode(String)</h4>
  129. <div class="markdown level1 summary">
  130. Initialises a new instance and sets starting <a class="xref" href="Terminal.Gui.TreeNode.html#Terminal_Gui_TreeNode_Text">Text</a>
  131. </div>
  132. <div class="markdown level1 conceptual"></div>
  133. <h5 class="decalaration">Declaration</h5>
  134. <div class="codewrapper">
  135. <pre><code class="lang-csharp hljs">public TreeNode(string text)</code></pre>
  136. </div>
  137. <h5 class="parameters">Parameters</h5>
  138. <table class="table table-bordered table-striped table-condensed">
  139. <thead>
  140. <tr>
  141. <th>Type</th>
  142. <th>Name</th>
  143. <th>Description</th>
  144. </tr>
  145. </thead>
  146. <tbody>
  147. <tr>
  148. <td><span class="xref">System.String</span></td>
  149. <td><span class="parametername">text</span></td>
  150. <td></td>
  151. </tr>
  152. </tbody>
  153. </table>
  154. <h3 id="properties">Properties
  155. </h3>
  156. <a id="Terminal_Gui_TreeNode_Children_" data-uid="Terminal.Gui.TreeNode.Children*"></a>
  157. <h4 id="Terminal_Gui_TreeNode_Children" data-uid="Terminal.Gui.TreeNode.Children">Children</h4>
  158. <div class="markdown level1 summary">
  159. Children of the current node
  160. </div>
  161. <div class="markdown level1 conceptual"></div>
  162. <h5 class="decalaration">Declaration</h5>
  163. <div class="codewrapper">
  164. <pre><code class="lang-csharp hljs">public virtual IList&lt;ITreeNode&gt; Children { get; set; }</code></pre>
  165. </div>
  166. <h5 class="propertyValue">Property Value</h5>
  167. <table class="table table-bordered table-striped table-condensed">
  168. <thead>
  169. <tr>
  170. <th>Type</th>
  171. <th>Description</th>
  172. </tr>
  173. </thead>
  174. <tbody>
  175. <tr>
  176. <td><span class="xref">System.Collections.Generic.IList</span>&lt;<a class="xref" href="Terminal.Gui.ITreeNode.html">ITreeNode</a>&gt;</td>
  177. <td></td>
  178. </tr>
  179. </tbody>
  180. </table>
  181. <a id="Terminal_Gui_TreeNode_Tag_" data-uid="Terminal.Gui.TreeNode.Tag*"></a>
  182. <h4 id="Terminal_Gui_TreeNode_Tag" data-uid="Terminal.Gui.TreeNode.Tag">Tag</h4>
  183. <div class="markdown level1 summary">
  184. Optionally allows you to store some custom data/class here.
  185. </div>
  186. <div class="markdown level1 conceptual"></div>
  187. <h5 class="decalaration">Declaration</h5>
  188. <div class="codewrapper">
  189. <pre><code class="lang-csharp hljs">public object Tag { get; set; }</code></pre>
  190. </div>
  191. <h5 class="propertyValue">Property Value</h5>
  192. <table class="table table-bordered table-striped table-condensed">
  193. <thead>
  194. <tr>
  195. <th>Type</th>
  196. <th>Description</th>
  197. </tr>
  198. </thead>
  199. <tbody>
  200. <tr>
  201. <td><span class="xref">System.Object</span></td>
  202. <td></td>
  203. </tr>
  204. </tbody>
  205. </table>
  206. <a id="Terminal_Gui_TreeNode_Text_" data-uid="Terminal.Gui.TreeNode.Text*"></a>
  207. <h4 id="Terminal_Gui_TreeNode_Text" data-uid="Terminal.Gui.TreeNode.Text">Text</h4>
  208. <div class="markdown level1 summary">
  209. Text to display in tree node for current entry
  210. </div>
  211. <div class="markdown level1 conceptual"></div>
  212. <h5 class="decalaration">Declaration</h5>
  213. <div class="codewrapper">
  214. <pre><code class="lang-csharp hljs">public virtual string Text { get; set; }</code></pre>
  215. </div>
  216. <h5 class="propertyValue">Property Value</h5>
  217. <table class="table table-bordered table-striped table-condensed">
  218. <thead>
  219. <tr>
  220. <th>Type</th>
  221. <th>Description</th>
  222. </tr>
  223. </thead>
  224. <tbody>
  225. <tr>
  226. <td><span class="xref">System.String</span></td>
  227. <td></td>
  228. </tr>
  229. </tbody>
  230. </table>
  231. <h3 id="methods">Methods
  232. </h3>
  233. <a id="Terminal_Gui_TreeNode_ToString_" data-uid="Terminal.Gui.TreeNode.ToString*"></a>
  234. <h4 id="Terminal_Gui_TreeNode_ToString" data-uid="Terminal.Gui.TreeNode.ToString">ToString()</h4>
  235. <div class="markdown level1 summary">
  236. returns <a class="xref" href="Terminal.Gui.TreeNode.html#Terminal_Gui_TreeNode_Text">Text</a>
  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 override string ToString()</code></pre>
  242. </div>
  243. <h5 class="returns">Returns</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.String</span></td>
  254. <td></td>
  255. </tr>
  256. </tbody>
  257. </table>
  258. <h5 class="overrides">Overrides</h5>
  259. <div><span class="xref">System.Object.ToString()</span></div>
  260. <h3 id="implements">Implements</h3>
  261. <div>
  262. <a class="xref" href="Terminal.Gui.ITreeNode.html">ITreeNode</a>
  263. </div>
  264. </article>
  265. </div>
  266. <div class="hidden-sm col-md-2" role="complementary">
  267. <div class="sideaffix">
  268. <div class="contribution">
  269. <ul class="nav">
  270. </ul>
  271. </div>
  272. <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
  273. <h5>In This Article</h5>
  274. <div></div>
  275. </nav>
  276. </div>
  277. </div>
  278. </div>
  279. </div>
  280. <footer>
  281. <div class="grad-bottom"></div>
  282. <div class="footer">
  283. <div class="container">
  284. <span class="pull-right">
  285. <a href="#top">Back to top</a>
  286. </span>
  287. <span>Generated by <strong>DocFX</strong></span>
  288. </div>
  289. </div>
  290. </footer>
  291. </div>
  292. <script type="text/javascript" src="../../styles/docfx.vendor.js"></script>
  293. <script type="text/javascript" src="../../styles/docfx.js"></script>
  294. <script type="text/javascript" src="../../styles/main.js"></script>
  295. </body>
  296. </html>