Terminal.Gui.MenuBarItem.html 28 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589
  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 MenuBarItem
  8. </title>
  9. <meta name="viewport" content="width=device-width">
  10. <meta name="title" content="Class MenuBarItem
  11. ">
  12. <meta name="generator" content="docfx 2.59.4.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.MenuBarItem">
  74. <h1 id="Terminal_Gui_MenuBarItem" data-uid="Terminal.Gui.MenuBarItem" class="text-break">Class MenuBarItem
  75. </h1>
  76. <div class="markdown level0 summary">
  77. A <a class="xref" href="Terminal.Gui.MenuBarItem.html">MenuBarItem</a> contains <a class="xref" href="Terminal.Gui.MenuBarItem.html">MenuBarItem</a>s or <a class="xref" href="Terminal.Gui.MenuItem.html">MenuItem</a>s.
  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"><a class="xref" href="Terminal.Gui.MenuItem.html">MenuItem</a></div>
  84. <div class="level2"><span class="xref">MenuBarItem</span></div>
  85. </div>
  86. <div class="inheritedMembers">
  87. <h5>Inherited Members</h5>
  88. <div>
  89. <a class="xref" href="Terminal.Gui.MenuItem.html#Terminal_Gui_MenuItem_Data">MenuItem.Data</a>
  90. </div>
  91. <div>
  92. <a class="xref" href="Terminal.Gui.MenuItem.html#Terminal_Gui_MenuItem_HotKey">MenuItem.HotKey</a>
  93. </div>
  94. <div>
  95. <a class="xref" href="Terminal.Gui.MenuItem.html#Terminal_Gui_MenuItem_Shortcut">MenuItem.Shortcut</a>
  96. </div>
  97. <div>
  98. <a class="xref" href="Terminal.Gui.MenuItem.html#Terminal_Gui_MenuItem_ShortcutTag">MenuItem.ShortcutTag</a>
  99. </div>
  100. <div>
  101. <a class="xref" href="Terminal.Gui.MenuItem.html#Terminal_Gui_MenuItem_Title">MenuItem.Title</a>
  102. </div>
  103. <div>
  104. <a class="xref" href="Terminal.Gui.MenuItem.html#Terminal_Gui_MenuItem_Help">MenuItem.Help</a>
  105. </div>
  106. <div>
  107. <a class="xref" href="Terminal.Gui.MenuItem.html#Terminal_Gui_MenuItem_Action">MenuItem.Action</a>
  108. </div>
  109. <div>
  110. <a class="xref" href="Terminal.Gui.MenuItem.html#Terminal_Gui_MenuItem_CanExecute">MenuItem.CanExecute</a>
  111. </div>
  112. <div>
  113. <a class="xref" href="Terminal.Gui.MenuItem.html#Terminal_Gui_MenuItem_IsEnabled">MenuItem.IsEnabled()</a>
  114. </div>
  115. <div>
  116. <a class="xref" href="Terminal.Gui.MenuItem.html#Terminal_Gui_MenuItem_Checked">MenuItem.Checked</a>
  117. </div>
  118. <div>
  119. <a class="xref" href="Terminal.Gui.MenuItem.html#Terminal_Gui_MenuItem_CheckType">MenuItem.CheckType</a>
  120. </div>
  121. <div>
  122. <a class="xref" href="Terminal.Gui.MenuItem.html#Terminal_Gui_MenuItem_Parent">MenuItem.Parent</a>
  123. </div>
  124. <div>
  125. <a class="xref" href="Terminal.Gui.MenuItem.html#Terminal_Gui_MenuItem_GetMenuItem">MenuItem.GetMenuItem()</a>
  126. </div>
  127. <div>
  128. <a class="xref" href="Terminal.Gui.MenuItem.html#Terminal_Gui_MenuItem_GetMenuBarItem">MenuItem.GetMenuBarItem()</a>
  129. </div>
  130. <div>
  131. <span class="xref">System.Object.Equals(System.Object)</span>
  132. </div>
  133. <div>
  134. <span class="xref">System.Object.Equals(System.Object, System.Object)</span>
  135. </div>
  136. <div>
  137. <span class="xref">System.Object.GetHashCode()</span>
  138. </div>
  139. <div>
  140. <span class="xref">System.Object.GetType()</span>
  141. </div>
  142. <div>
  143. <span class="xref">System.Object.MemberwiseClone()</span>
  144. </div>
  145. <div>
  146. <span class="xref">System.Object.ReferenceEquals(System.Object, System.Object)</span>
  147. </div>
  148. <div>
  149. <span class="xref">System.Object.ToString()</span>
  150. </div>
  151. </div>
  152. <h6><strong>Namespace</strong>: <a class="xref" href="Terminal.Gui.html">Terminal.Gui</a></h6>
  153. <h6><strong>Assembly</strong>: Terminal.Gui.dll</h6>
  154. <h5 id="Terminal_Gui_MenuBarItem_syntax">Syntax</h5>
  155. <div class="codewrapper">
  156. <pre><code class="lang-csharp hljs">public class MenuBarItem : MenuItem</code></pre>
  157. </div>
  158. <h3 id="constructors">Constructors
  159. </h3>
  160. <span class="small pull-right mobile-hide">
  161. <span class="divider">|</span>
  162. <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/apidoc/new?filename=Terminal_Gui_MenuBarItem__ctor.md&amp;value=---%0Auid%3A%20Terminal.Gui.MenuBarItem.%23ctor%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
  163. </span>
  164. <span class="small pull-right mobile-hide">
  165. <a href="tig:tig/gui.cs/blob/main/Terminal.Gui/Views/Menu.cs/#L263">View Source</a>
  166. </span>
  167. <a id="Terminal_Gui_MenuBarItem__ctor_" data-uid="Terminal.Gui.MenuBarItem.#ctor*"></a>
  168. <h4 id="Terminal_Gui_MenuBarItem__ctor" data-uid="Terminal.Gui.MenuBarItem.#ctor">MenuBarItem()</h4>
  169. <div class="markdown level1 summary">
  170. Initializes a new <a class="xref" href="Terminal.Gui.MenuBarItem.html">MenuBarItem</a>.
  171. </div>
  172. <div class="markdown level1 conceptual"></div>
  173. <h5 class="decalaration">Declaration</h5>
  174. <div class="codewrapper">
  175. <pre><code class="lang-csharp hljs">public MenuBarItem()</code></pre>
  176. </div>
  177. <span class="small pull-right mobile-hide">
  178. <span class="divider">|</span>
  179. <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/apidoc/new?filename=Terminal_Gui_MenuBarItem__ctor_NStack_ustring_NStack_ustring_System_Action_System_Func_System_Boolean__Terminal_Gui_MenuItem_.md&amp;value=---%0Auid%3A%20Terminal.Gui.MenuBarItem.%23ctor(NStack.ustring%2CNStack.ustring%2CSystem.Action%2CSystem.Func%7BSystem.Boolean%7D%2CTerminal.Gui.MenuItem)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
  180. </span>
  181. <span class="small pull-right mobile-hide">
  182. <a href="tig:tig/gui.cs/blob/main/Terminal.Gui/Views/Menu.cs/#L227">View Source</a>
  183. </span>
  184. <a id="Terminal_Gui_MenuBarItem__ctor_" data-uid="Terminal.Gui.MenuBarItem.#ctor*"></a>
  185. <h4 id="Terminal_Gui_MenuBarItem__ctor_NStack_ustring_NStack_ustring_System_Action_System_Func_System_Boolean__Terminal_Gui_MenuItem_" data-uid="Terminal.Gui.MenuBarItem.#ctor(NStack.ustring,NStack.ustring,System.Action,System.Func{System.Boolean},Terminal.Gui.MenuItem)">MenuBarItem(ustring, ustring, Action, Func&lt;Boolean&gt;, MenuItem)</h4>
  186. <div class="markdown level1 summary">
  187. Initializes a new <a class="xref" href="Terminal.Gui.MenuBarItem.html">MenuBarItem</a> as a <a class="xref" href="Terminal.Gui.MenuItem.html">MenuItem</a>.
  188. </div>
  189. <div class="markdown level1 conceptual"></div>
  190. <h5 class="decalaration">Declaration</h5>
  191. <div class="codewrapper">
  192. <pre><code class="lang-csharp hljs">public MenuBarItem(ustring title, ustring help, Action action, Func&lt;bool&gt; canExecute = null, MenuItem parent = null)</code></pre>
  193. </div>
  194. <h5 class="parameters">Parameters</h5>
  195. <table class="table table-bordered table-striped table-condensed">
  196. <thead>
  197. <tr>
  198. <th>Type</th>
  199. <th>Name</th>
  200. <th>Description</th>
  201. </tr>
  202. </thead>
  203. <tbody>
  204. <tr>
  205. <td><span class="xref">NStack.ustring</span></td>
  206. <td><span class="parametername">title</span></td>
  207. <td>Title for the menu item.</td>
  208. </tr>
  209. <tr>
  210. <td><span class="xref">NStack.ustring</span></td>
  211. <td><span class="parametername">help</span></td>
  212. <td>Help text to display.</td>
  213. </tr>
  214. <tr>
  215. <td><span class="xref">System.Action</span></td>
  216. <td><span class="parametername">action</span></td>
  217. <td>Action to invoke when the menu item is activated.</td>
  218. </tr>
  219. <tr>
  220. <td><span class="xref">System.Func</span>&lt;<span class="xref">System.Boolean</span>&gt;</td>
  221. <td><span class="parametername">canExecute</span></td>
  222. <td>Function to determine if the action can currently be executed.</td>
  223. </tr>
  224. <tr>
  225. <td><a class="xref" href="Terminal.Gui.MenuItem.html">MenuItem</a></td>
  226. <td><span class="parametername">parent</span></td>
  227. <td>The parent <a class="xref" href="Terminal.Gui.MenuItem.html">MenuItem</a> of this if exist, otherwise is null.</td>
  228. </tr>
  229. </tbody>
  230. </table>
  231. <span class="small pull-right mobile-hide">
  232. <span class="divider">|</span>
  233. <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/apidoc/new?filename=Terminal_Gui_MenuBarItem__ctor_NStack_ustring_System_Collections_Generic_List_Terminal_Gui_MenuItem____Terminal_Gui_MenuItem_.md&amp;value=---%0Auid%3A%20Terminal.Gui.MenuBarItem.%23ctor(NStack.ustring%2CSystem.Collections.Generic.List%7BTerminal.Gui.MenuItem%5B%5D%7D%2CTerminal.Gui.MenuItem)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
  234. </span>
  235. <span class="small pull-right mobile-hide">
  236. <a href="tig:tig/gui.cs/blob/main/Terminal.Gui/Views/Menu.cs/#L249">View Source</a>
  237. </span>
  238. <a id="Terminal_Gui_MenuBarItem__ctor_" data-uid="Terminal.Gui.MenuBarItem.#ctor*"></a>
  239. <h4 id="Terminal_Gui_MenuBarItem__ctor_NStack_ustring_System_Collections_Generic_List_Terminal_Gui_MenuItem____Terminal_Gui_MenuItem_" data-uid="Terminal.Gui.MenuBarItem.#ctor(NStack.ustring,System.Collections.Generic.List{Terminal.Gui.MenuItem[]},Terminal.Gui.MenuItem)">MenuBarItem(ustring, List&lt;MenuItem[]&gt;, MenuItem)</h4>
  240. <div class="markdown level1 summary">
  241. Initializes a new <a class="xref" href="Terminal.Gui.MenuBarItem.html">MenuBarItem</a> with separate list of items.
  242. </div>
  243. <div class="markdown level1 conceptual"></div>
  244. <h5 class="decalaration">Declaration</h5>
  245. <div class="codewrapper">
  246. <pre><code class="lang-csharp hljs">public MenuBarItem(ustring title, List&lt;MenuItem[]&gt; children, MenuItem parent = null)</code></pre>
  247. </div>
  248. <h5 class="parameters">Parameters</h5>
  249. <table class="table table-bordered table-striped table-condensed">
  250. <thead>
  251. <tr>
  252. <th>Type</th>
  253. <th>Name</th>
  254. <th>Description</th>
  255. </tr>
  256. </thead>
  257. <tbody>
  258. <tr>
  259. <td><span class="xref">NStack.ustring</span></td>
  260. <td><span class="parametername">title</span></td>
  261. <td>Title for the menu item.</td>
  262. </tr>
  263. <tr>
  264. <td><span class="xref">System.Collections.Generic.List</span>&lt;<a class="xref" href="Terminal.Gui.MenuItem.html">MenuItem</a>[]&gt;</td>
  265. <td><span class="parametername">children</span></td>
  266. <td>The list of items in the current menu.</td>
  267. </tr>
  268. <tr>
  269. <td><a class="xref" href="Terminal.Gui.MenuItem.html">MenuItem</a></td>
  270. <td><span class="parametername">parent</span></td>
  271. <td>The parent <a class="xref" href="Terminal.Gui.MenuItem.html">MenuItem</a> of this if exist, otherwise is null.</td>
  272. </tr>
  273. </tbody>
  274. </table>
  275. <span class="small pull-right mobile-hide">
  276. <span class="divider">|</span>
  277. <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/apidoc/new?filename=Terminal_Gui_MenuBarItem__ctor_NStack_ustring_Terminal_Gui_MenuItem___Terminal_Gui_MenuItem_.md&amp;value=---%0Auid%3A%20Terminal.Gui.MenuBarItem.%23ctor(NStack.ustring%2CTerminal.Gui.MenuItem%5B%5D%2CTerminal.Gui.MenuItem)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
  278. </span>
  279. <span class="small pull-right mobile-hide">
  280. <a href="tig:tig/gui.cs/blob/main/Terminal.Gui/Views/Menu.cs/#L238">View Source</a>
  281. </span>
  282. <a id="Terminal_Gui_MenuBarItem__ctor_" data-uid="Terminal.Gui.MenuBarItem.#ctor*"></a>
  283. <h4 id="Terminal_Gui_MenuBarItem__ctor_NStack_ustring_Terminal_Gui_MenuItem___Terminal_Gui_MenuItem_" data-uid="Terminal.Gui.MenuBarItem.#ctor(NStack.ustring,Terminal.Gui.MenuItem[],Terminal.Gui.MenuItem)">MenuBarItem(ustring, MenuItem[], MenuItem)</h4>
  284. <div class="markdown level1 summary">
  285. Initializes a new <a class="xref" href="Terminal.Gui.MenuBarItem.html">MenuBarItem</a>.
  286. </div>
  287. <div class="markdown level1 conceptual"></div>
  288. <h5 class="decalaration">Declaration</h5>
  289. <div class="codewrapper">
  290. <pre><code class="lang-csharp hljs">public MenuBarItem(ustring title, MenuItem[] children, MenuItem parent = null)</code></pre>
  291. </div>
  292. <h5 class="parameters">Parameters</h5>
  293. <table class="table table-bordered table-striped table-condensed">
  294. <thead>
  295. <tr>
  296. <th>Type</th>
  297. <th>Name</th>
  298. <th>Description</th>
  299. </tr>
  300. </thead>
  301. <tbody>
  302. <tr>
  303. <td><span class="xref">NStack.ustring</span></td>
  304. <td><span class="parametername">title</span></td>
  305. <td>Title for the menu item.</td>
  306. </tr>
  307. <tr>
  308. <td><a class="xref" href="Terminal.Gui.MenuItem.html">MenuItem</a>[]</td>
  309. <td><span class="parametername">children</span></td>
  310. <td>The items in the current menu.</td>
  311. </tr>
  312. <tr>
  313. <td><a class="xref" href="Terminal.Gui.MenuItem.html">MenuItem</a></td>
  314. <td><span class="parametername">parent</span></td>
  315. <td>The parent <a class="xref" href="Terminal.Gui.MenuItem.html">MenuItem</a> of this if exist, otherwise is null.</td>
  316. </tr>
  317. </tbody>
  318. </table>
  319. <span class="small pull-right mobile-hide">
  320. <span class="divider">|</span>
  321. <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/apidoc/new?filename=Terminal_Gui_MenuBarItem__ctor_Terminal_Gui_MenuItem___.md&amp;value=---%0Auid%3A%20Terminal.Gui.MenuBarItem.%23ctor(Terminal.Gui.MenuItem%5B%5D)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
  322. </span>
  323. <span class="small pull-right mobile-hide">
  324. <a href="tig:tig/gui.cs/blob/main/Terminal.Gui/Views/Menu.cs/#L258">View Source</a>
  325. </span>
  326. <a id="Terminal_Gui_MenuBarItem__ctor_" data-uid="Terminal.Gui.MenuBarItem.#ctor*"></a>
  327. <h4 id="Terminal_Gui_MenuBarItem__ctor_Terminal_Gui_MenuItem___" data-uid="Terminal.Gui.MenuBarItem.#ctor(Terminal.Gui.MenuItem[])">MenuBarItem(MenuItem[])</h4>
  328. <div class="markdown level1 summary">
  329. Initializes a new <a class="xref" href="Terminal.Gui.MenuBarItem.html">MenuBarItem</a>.
  330. </div>
  331. <div class="markdown level1 conceptual"></div>
  332. <h5 class="decalaration">Declaration</h5>
  333. <div class="codewrapper">
  334. <pre><code class="lang-csharp hljs">public MenuBarItem(MenuItem[] children)</code></pre>
  335. </div>
  336. <h5 class="parameters">Parameters</h5>
  337. <table class="table table-bordered table-striped table-condensed">
  338. <thead>
  339. <tr>
  340. <th>Type</th>
  341. <th>Name</th>
  342. <th>Description</th>
  343. </tr>
  344. </thead>
  345. <tbody>
  346. <tr>
  347. <td><a class="xref" href="Terminal.Gui.MenuItem.html">MenuItem</a>[]</td>
  348. <td><span class="parametername">children</span></td>
  349. <td>The items in the current menu.</td>
  350. </tr>
  351. </tbody>
  352. </table>
  353. <h3 id="properties">Properties
  354. </h3>
  355. <span class="small pull-right mobile-hide">
  356. <span class="divider">|</span>
  357. <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/apidoc/new?filename=Terminal_Gui_MenuBarItem_Children.md&amp;value=---%0Auid%3A%20Terminal.Gui.MenuBarItem.Children%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
  358. </span>
  359. <span class="small pull-right mobile-hide">
  360. <a href="tig:tig/gui.cs/blob/main/Terminal.Gui/Views/Menu.cs/#L376">View Source</a>
  361. </span>
  362. <a id="Terminal_Gui_MenuBarItem_Children_" data-uid="Terminal.Gui.MenuBarItem.Children*"></a>
  363. <h4 id="Terminal_Gui_MenuBarItem_Children" data-uid="Terminal.Gui.MenuBarItem.Children">Children</h4>
  364. <div class="markdown level1 summary">
  365. Gets or sets an array of <a class="xref" href="Terminal.Gui.MenuItem.html">MenuItem</a> objects that are the children of this <a class="xref" href="Terminal.Gui.MenuBarItem.html">MenuBarItem</a>
  366. </div>
  367. <div class="markdown level1 conceptual"></div>
  368. <h5 class="decalaration">Declaration</h5>
  369. <div class="codewrapper">
  370. <pre><code class="lang-csharp hljs">public MenuItem[] Children { get; set; }</code></pre>
  371. </div>
  372. <h5 class="propertyValue">Property Value</h5>
  373. <table class="table table-bordered table-striped table-condensed">
  374. <thead>
  375. <tr>
  376. <th>Type</th>
  377. <th>Description</th>
  378. </tr>
  379. </thead>
  380. <tbody>
  381. <tr>
  382. <td><a class="xref" href="Terminal.Gui.MenuItem.html">MenuItem</a>[]</td>
  383. <td>The children.</td>
  384. </tr>
  385. </tbody>
  386. </table>
  387. <h3 id="methods">Methods
  388. </h3>
  389. <span class="small pull-right mobile-hide">
  390. <span class="divider">|</span>
  391. <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/apidoc/new?filename=Terminal_Gui_MenuBarItem_GetChildrenIndex_Terminal_Gui_MenuItem_.md&amp;value=---%0Auid%3A%20Terminal.Gui.MenuBarItem.GetChildrenIndex(Terminal.Gui.MenuItem)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
  392. </span>
  393. <span class="small pull-right mobile-hide">
  394. <a href="tig:tig/gui.cs/blob/main/Terminal.Gui/Views/Menu.cs/#L344">View Source</a>
  395. </span>
  396. <a id="Terminal_Gui_MenuBarItem_GetChildrenIndex_" data-uid="Terminal.Gui.MenuBarItem.GetChildrenIndex*"></a>
  397. <h4 id="Terminal_Gui_MenuBarItem_GetChildrenIndex_Terminal_Gui_MenuItem_" data-uid="Terminal.Gui.MenuBarItem.GetChildrenIndex(Terminal.Gui.MenuItem)">GetChildrenIndex(MenuItem)</h4>
  398. <div class="markdown level1 summary">
  399. Get the index of the <a class="xref" href="Terminal.Gui.MenuItem.html">MenuItem</a> parameter.
  400. </div>
  401. <div class="markdown level1 conceptual"></div>
  402. <h5 class="decalaration">Declaration</h5>
  403. <div class="codewrapper">
  404. <pre><code class="lang-csharp hljs">public int GetChildrenIndex(MenuItem children)</code></pre>
  405. </div>
  406. <h5 class="parameters">Parameters</h5>
  407. <table class="table table-bordered table-striped table-condensed">
  408. <thead>
  409. <tr>
  410. <th>Type</th>
  411. <th>Name</th>
  412. <th>Description</th>
  413. </tr>
  414. </thead>
  415. <tbody>
  416. <tr>
  417. <td><a class="xref" href="Terminal.Gui.MenuItem.html">MenuItem</a></td>
  418. <td><span class="parametername">children</span></td>
  419. <td></td>
  420. </tr>
  421. </tbody>
  422. </table>
  423. <h5 class="returns">Returns</h5>
  424. <table class="table table-bordered table-striped table-condensed">
  425. <thead>
  426. <tr>
  427. <th>Type</th>
  428. <th>Description</th>
  429. </tr>
  430. </thead>
  431. <tbody>
  432. <tr>
  433. <td><span class="xref">System.Int32</span></td>
  434. <td>Returns a value bigger than -1 if the <a class="xref" href="Terminal.Gui.MenuItem.html">MenuItem</a> is a child of this.</td>
  435. </tr>
  436. </tbody>
  437. </table>
  438. <span class="small pull-right mobile-hide">
  439. <span class="divider">|</span>
  440. <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/apidoc/new?filename=Terminal_Gui_MenuBarItem_IsSubMenuOf_Terminal_Gui_MenuItem_.md&amp;value=---%0Auid%3A%20Terminal.Gui.MenuBarItem.IsSubMenuOf(Terminal.Gui.MenuItem)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
  441. </span>
  442. <span class="small pull-right mobile-hide">
  443. <a href="tig:tig/gui.cs/blob/main/Terminal.Gui/Views/Menu.cs/#L329">View Source</a>
  444. </span>
  445. <a id="Terminal_Gui_MenuBarItem_IsSubMenuOf_" data-uid="Terminal.Gui.MenuBarItem.IsSubMenuOf*"></a>
  446. <h4 id="Terminal_Gui_MenuBarItem_IsSubMenuOf_Terminal_Gui_MenuItem_" data-uid="Terminal.Gui.MenuBarItem.IsSubMenuOf(Terminal.Gui.MenuItem)">IsSubMenuOf(MenuItem)</h4>
  447. <div class="markdown level1 summary">
  448. Check if the <a class="xref" href="Terminal.Gui.MenuItem.html">MenuItem</a> parameter is a child of this.
  449. </div>
  450. <div class="markdown level1 conceptual"></div>
  451. <h5 class="decalaration">Declaration</h5>
  452. <div class="codewrapper">
  453. <pre><code class="lang-csharp hljs">public bool IsSubMenuOf(MenuItem menuItem)</code></pre>
  454. </div>
  455. <h5 class="parameters">Parameters</h5>
  456. <table class="table table-bordered table-striped table-condensed">
  457. <thead>
  458. <tr>
  459. <th>Type</th>
  460. <th>Name</th>
  461. <th>Description</th>
  462. </tr>
  463. </thead>
  464. <tbody>
  465. <tr>
  466. <td><a class="xref" href="Terminal.Gui.MenuItem.html">MenuItem</a></td>
  467. <td><span class="parametername">menuItem</span></td>
  468. <td></td>
  469. </tr>
  470. </tbody>
  471. </table>
  472. <h5 class="returns">Returns</h5>
  473. <table class="table table-bordered table-striped table-condensed">
  474. <thead>
  475. <tr>
  476. <th>Type</th>
  477. <th>Description</th>
  478. </tr>
  479. </thead>
  480. <tbody>
  481. <tr>
  482. <td><span class="xref">System.Boolean</span></td>
  483. <td>Returns <code>true</code> if it is a child of this. <code>false</code> otherwise.</td>
  484. </tr>
  485. </tbody>
  486. </table>
  487. <span class="small pull-right mobile-hide">
  488. <span class="divider">|</span>
  489. <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/apidoc/new?filename=Terminal_Gui_MenuBarItem_SubMenu_Terminal_Gui_MenuItem_.md&amp;value=---%0Auid%3A%20Terminal.Gui.MenuBarItem.SubMenu(Terminal.Gui.MenuItem)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
  490. </span>
  491. <span class="small pull-right mobile-hide">
  492. <a href="tig:tig/gui.cs/blob/main/Terminal.Gui/Views/Menu.cs/#L319">View Source</a>
  493. </span>
  494. <a id="Terminal_Gui_MenuBarItem_SubMenu_" data-uid="Terminal.Gui.MenuBarItem.SubMenu*"></a>
  495. <h4 id="Terminal_Gui_MenuBarItem_SubMenu_Terminal_Gui_MenuItem_" data-uid="Terminal.Gui.MenuBarItem.SubMenu(Terminal.Gui.MenuItem)">SubMenu(MenuItem)</h4>
  496. <div class="markdown level1 summary">
  497. Check if the children parameter is a <a class="xref" href="Terminal.Gui.MenuBarItem.html">MenuBarItem</a>.
  498. </div>
  499. <div class="markdown level1 conceptual"></div>
  500. <h5 class="decalaration">Declaration</h5>
  501. <div class="codewrapper">
  502. <pre><code class="lang-csharp hljs">public MenuBarItem SubMenu(MenuItem children)</code></pre>
  503. </div>
  504. <h5 class="parameters">Parameters</h5>
  505. <table class="table table-bordered table-striped table-condensed">
  506. <thead>
  507. <tr>
  508. <th>Type</th>
  509. <th>Name</th>
  510. <th>Description</th>
  511. </tr>
  512. </thead>
  513. <tbody>
  514. <tr>
  515. <td><a class="xref" href="Terminal.Gui.MenuItem.html">MenuItem</a></td>
  516. <td><span class="parametername">children</span></td>
  517. <td></td>
  518. </tr>
  519. </tbody>
  520. </table>
  521. <h5 class="returns">Returns</h5>
  522. <table class="table table-bordered table-striped table-condensed">
  523. <thead>
  524. <tr>
  525. <th>Type</th>
  526. <th>Description</th>
  527. </tr>
  528. </thead>
  529. <tbody>
  530. <tr>
  531. <td><a class="xref" href="Terminal.Gui.MenuBarItem.html">MenuBarItem</a></td>
  532. <td>Returns a <a class="xref" href="Terminal.Gui.MenuBarItem.html">MenuBarItem</a> or null otherwise.</td>
  533. </tr>
  534. </tbody>
  535. </table>
  536. </article>
  537. </div>
  538. <div class="hidden-sm col-md-2" role="complementary">
  539. <div class="sideaffix">
  540. <div class="contribution">
  541. <ul class="nav">
  542. <li>
  543. <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/apidoc/new?filename=Terminal_Gui_MenuBarItem.md&amp;value=---%0Auid%3A%20Terminal.Gui.MenuBarItem%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A" class="contribution-link">Improve this Doc</a>
  544. </li>
  545. <li>
  546. <a href="tig:tig/gui.cs/blob/main/Terminal.Gui/Views/Menu.cs/#L218" class="contribution-link">View Source</a>
  547. </li>
  548. </ul>
  549. </div>
  550. <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
  551. <h5>In This Article</h5>
  552. <div></div>
  553. </nav>
  554. </div>
  555. </div>
  556. </div>
  557. </div>
  558. <footer>
  559. <div class="grad-bottom"></div>
  560. <div class="footer">
  561. <div class="container">
  562. <span class="pull-right">
  563. <a href="#top">Back to top</a>
  564. </span>
  565. <span>Generated by <strong>DocFX</strong></span>
  566. </div>
  567. </div>
  568. </footer>
  569. </div>
  570. <script type="text/javascript" src="../../styles/docfx.vendor.js"></script>
  571. <script type="text/javascript" src="../../styles/docfx.js"></script>
  572. <script type="text/javascript" src="../../styles/main.js"></script>
  573. </body>
  574. </html>