Terminal.Gui.Trees.DelegateTreeBuilder-1.html 13 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317
  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 DelegateTreeBuilder&lt;T&gt;
  8. </title>
  9. <meta name="viewport" content="width=device-width">
  10. <meta name="title" content="Class DelegateTreeBuilder&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. <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.Trees.DelegateTreeBuilder`1">
  73. <h1 id="Terminal_Gui_Trees_DelegateTreeBuilder_1" data-uid="Terminal.Gui.Trees.DelegateTreeBuilder`1" class="text-break">Class DelegateTreeBuilder&lt;T&gt;
  74. </h1>
  75. <div class="markdown level0 summary">
  76. Implementation of <a class="xref" href="Terminal.Gui.Trees.ITreeBuilder-1.html">ITreeBuilder&lt;T&gt;</a> that uses user defined functions
  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"><a class="xref" href="Terminal.Gui.Trees.TreeBuilder-1.html">TreeBuilder</a>&lt;T&gt;</div>
  83. <div class="level2"><span class="xref">DelegateTreeBuilder&lt;T&gt;</span></div>
  84. </div>
  85. <div class="implements">
  86. <h5>Implements</h5>
  87. <div><a class="xref" href="Terminal.Gui.Trees.ITreeBuilder-1.html">ITreeBuilder</a>&lt;T&gt;</div>
  88. </div>
  89. <div class="inheritedMembers">
  90. <h5>Inherited Members</h5>
  91. <div>
  92. <a class="xref" href="Terminal.Gui.Trees.TreeBuilder-1.html#Terminal_Gui_Trees_TreeBuilder_1_SupportsCanExpand">TreeBuilder&lt;T&gt;.SupportsCanExpand</a>
  93. </div>
  94. </div>
  95. <h6><strong>Namespace</strong>: <a class="xref" href="Terminal.Gui.Trees.html">Terminal.Gui.Trees</a></h6>
  96. <h6><strong>Assembly</strong>: Terminal.Gui.dll</h6>
  97. <h5 id="Terminal_Gui_Trees_DelegateTreeBuilder_1_syntax">Syntax</h5>
  98. <div class="codewrapper">
  99. <pre><code class="lang-csharp hljs">public class DelegateTreeBuilder&lt;T&gt; : TreeBuilder&lt;T&gt;, ITreeBuilder&lt;T&gt;</code></pre>
  100. </div>
  101. <h5 class="typeParameters">Type Parameters</h5>
  102. <table class="table table-bordered table-striped table-condensed">
  103. <thead>
  104. <tr>
  105. <th>Name</th>
  106. <th>Description</th>
  107. </tr>
  108. </thead>
  109. <tbody>
  110. <tr>
  111. <td><span class="parametername">T</span></td>
  112. <td></td>
  113. </tr>
  114. </tbody>
  115. </table>
  116. <h3 id="constructors">Constructors
  117. </h3>
  118. <a id="Terminal_Gui_Trees_DelegateTreeBuilder_1__ctor_" data-uid="Terminal.Gui.Trees.DelegateTreeBuilder`1.#ctor*"></a>
  119. <h4 id="Terminal_Gui_Trees_DelegateTreeBuilder_1__ctor_System_Func__0_System_Collections_Generic_IEnumerable__0___" data-uid="Terminal.Gui.Trees.DelegateTreeBuilder`1.#ctor(System.Func{`0,System.Collections.Generic.IEnumerable{`0}})">DelegateTreeBuilder(Func&lt;T, IEnumerable&lt;T&gt;&gt;)</h4>
  120. <div class="markdown level1 summary">
  121. Constructs an implementation of <a class="xref" href="Terminal.Gui.Trees.ITreeBuilder-1.html">ITreeBuilder&lt;T&gt;</a> that calls the user
  122. defined method <code data-dev-comment-type="paramref" class="paramref">childGetter</code> to determine children
  123. </div>
  124. <div class="markdown level1 conceptual"></div>
  125. <h5 class="decalaration">Declaration</h5>
  126. <div class="codewrapper">
  127. <pre><code class="lang-csharp hljs">public DelegateTreeBuilder(Func&lt;T, IEnumerable&lt;T&gt;&gt; childGetter)</code></pre>
  128. </div>
  129. <h5 class="parameters">Parameters</h5>
  130. <table class="table table-bordered table-striped table-condensed">
  131. <thead>
  132. <tr>
  133. <th>Type</th>
  134. <th>Name</th>
  135. <th>Description</th>
  136. </tr>
  137. </thead>
  138. <tbody>
  139. <tr>
  140. <td><span class="xref">System.Func</span>&lt;T, <span class="xref">System.Collections.Generic.IEnumerable</span>&lt;T&gt;&gt;</td>
  141. <td><span class="parametername">childGetter</span></td>
  142. <td></td>
  143. </tr>
  144. </tbody>
  145. </table>
  146. <a id="Terminal_Gui_Trees_DelegateTreeBuilder_1__ctor_" data-uid="Terminal.Gui.Trees.DelegateTreeBuilder`1.#ctor*"></a>
  147. <h4 id="Terminal_Gui_Trees_DelegateTreeBuilder_1__ctor_System_Func__0_System_Collections_Generic_IEnumerable__0___System_Func__0_System_Boolean__" data-uid="Terminal.Gui.Trees.DelegateTreeBuilder`1.#ctor(System.Func{`0,System.Collections.Generic.IEnumerable{`0}},System.Func{`0,System.Boolean})">DelegateTreeBuilder(Func&lt;T, IEnumerable&lt;T&gt;&gt;, Func&lt;T, Boolean&gt;)</h4>
  148. <div class="markdown level1 summary">
  149. Constructs an implementation of <a class="xref" href="Terminal.Gui.Trees.ITreeBuilder-1.html">ITreeBuilder&lt;T&gt;</a> that calls the user
  150. defined method <code data-dev-comment-type="paramref" class="paramref">childGetter</code> to determine children
  151. and <code data-dev-comment-type="paramref" class="paramref">canExpand</code> to determine expandability
  152. </div>
  153. <div class="markdown level1 conceptual"></div>
  154. <h5 class="decalaration">Declaration</h5>
  155. <div class="codewrapper">
  156. <pre><code class="lang-csharp hljs">public DelegateTreeBuilder(Func&lt;T, IEnumerable&lt;T&gt;&gt; childGetter, Func&lt;T, bool&gt; canExpand)</code></pre>
  157. </div>
  158. <h5 class="parameters">Parameters</h5>
  159. <table class="table table-bordered table-striped table-condensed">
  160. <thead>
  161. <tr>
  162. <th>Type</th>
  163. <th>Name</th>
  164. <th>Description</th>
  165. </tr>
  166. </thead>
  167. <tbody>
  168. <tr>
  169. <td><span class="xref">System.Func</span>&lt;T, <span class="xref">System.Collections.Generic.IEnumerable</span>&lt;T&gt;&gt;</td>
  170. <td><span class="parametername">childGetter</span></td>
  171. <td></td>
  172. </tr>
  173. <tr>
  174. <td><span class="xref">System.Func</span>&lt;T, <span class="xref">System.Boolean</span>&gt;</td>
  175. <td><span class="parametername">canExpand</span></td>
  176. <td></td>
  177. </tr>
  178. </tbody>
  179. </table>
  180. <h3 id="methods">Methods
  181. </h3>
  182. <a id="Terminal_Gui_Trees_DelegateTreeBuilder_1_CanExpand_" data-uid="Terminal.Gui.Trees.DelegateTreeBuilder`1.CanExpand*"></a>
  183. <h4 id="Terminal_Gui_Trees_DelegateTreeBuilder_1_CanExpand__0_" data-uid="Terminal.Gui.Trees.DelegateTreeBuilder`1.CanExpand(`0)">CanExpand(T)</h4>
  184. <div class="markdown level1 summary">
  185. Returns whether a node can be expanded based on the delegate passed during construction
  186. </div>
  187. <div class="markdown level1 conceptual"></div>
  188. <h5 class="decalaration">Declaration</h5>
  189. <div class="codewrapper">
  190. <pre><code class="lang-csharp hljs">public override bool CanExpand(T toExpand)</code></pre>
  191. </div>
  192. <h5 class="parameters">Parameters</h5>
  193. <table class="table table-bordered table-striped table-condensed">
  194. <thead>
  195. <tr>
  196. <th>Type</th>
  197. <th>Name</th>
  198. <th>Description</th>
  199. </tr>
  200. </thead>
  201. <tbody>
  202. <tr>
  203. <td><span class="xref">T</span></td>
  204. <td><span class="parametername">toExpand</span></td>
  205. <td></td>
  206. </tr>
  207. </tbody>
  208. </table>
  209. <h5 class="returns">Returns</h5>
  210. <table class="table table-bordered table-striped table-condensed">
  211. <thead>
  212. <tr>
  213. <th>Type</th>
  214. <th>Description</th>
  215. </tr>
  216. </thead>
  217. <tbody>
  218. <tr>
  219. <td><span class="xref">System.Boolean</span></td>
  220. <td></td>
  221. </tr>
  222. </tbody>
  223. </table>
  224. <h5 class="overrides">Overrides</h5>
  225. <div><span class="xref">Terminal.Gui.Trees.TreeBuilder&lt;T&gt;.CanExpand(T)</span></div>
  226. <a id="Terminal_Gui_Trees_DelegateTreeBuilder_1_GetChildren_" data-uid="Terminal.Gui.Trees.DelegateTreeBuilder`1.GetChildren*"></a>
  227. <h4 id="Terminal_Gui_Trees_DelegateTreeBuilder_1_GetChildren__0_" data-uid="Terminal.Gui.Trees.DelegateTreeBuilder`1.GetChildren(`0)">GetChildren(T)</h4>
  228. <div class="markdown level1 summary">
  229. Returns children using the delegate method passed during construction
  230. </div>
  231. <div class="markdown level1 conceptual"></div>
  232. <h5 class="decalaration">Declaration</h5>
  233. <div class="codewrapper">
  234. <pre><code class="lang-csharp hljs">public override IEnumerable&lt;T&gt; GetChildren(T forObject)</code></pre>
  235. </div>
  236. <h5 class="parameters">Parameters</h5>
  237. <table class="table table-bordered table-striped table-condensed">
  238. <thead>
  239. <tr>
  240. <th>Type</th>
  241. <th>Name</th>
  242. <th>Description</th>
  243. </tr>
  244. </thead>
  245. <tbody>
  246. <tr>
  247. <td><span class="xref">T</span></td>
  248. <td><span class="parametername">forObject</span></td>
  249. <td></td>
  250. </tr>
  251. </tbody>
  252. </table>
  253. <h5 class="returns">Returns</h5>
  254. <table class="table table-bordered table-striped table-condensed">
  255. <thead>
  256. <tr>
  257. <th>Type</th>
  258. <th>Description</th>
  259. </tr>
  260. </thead>
  261. <tbody>
  262. <tr>
  263. <td><span class="xref">System.Collections.Generic.IEnumerable</span>&lt;T&gt;</td>
  264. <td></td>
  265. </tr>
  266. </tbody>
  267. </table>
  268. <h5 class="overrides">Overrides</h5>
  269. <div><span class="xref">Terminal.Gui.Trees.TreeBuilder&lt;T&gt;.GetChildren(T)</span></div>
  270. <h3 id="implements">Implements</h3>
  271. <div>
  272. <a class="xref" href="Terminal.Gui.Trees.ITreeBuilder-1.html">ITreeBuilder&lt;T&gt;</a>
  273. </div>
  274. </article>
  275. </div>
  276. <div class="hidden-sm col-md-2" role="complementary">
  277. <div class="sideaffix">
  278. <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
  279. <h5>In This Article</h5>
  280. <div></div>
  281. </nav>
  282. </div>
  283. </div>
  284. </div>
  285. </div>
  286. <footer>
  287. <div class="grad-bottom"></div>
  288. <div class="footer">
  289. <div class="container">
  290. <span class="pull-right">
  291. <a href="#top">Back to top</a>
  292. </span>
  293. <span>Generated by <strong>DocFX</strong></span>
  294. </div>
  295. </div>
  296. </footer>
  297. </div>
  298. <script type="text/javascript" src="../../styles/docfx.vendor.js"></script>
  299. <script type="text/javascript" src="../../styles/docfx.js"></script>
  300. <script type="text/javascript" src="../../styles/main.js"></script>
  301. </body>
  302. </html>