2
0

Terminal.Gui.MenuBarItem.html 19 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494
  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.56.2.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"></div>
  57. <div class="sr-items">
  58. <p><i class="glyphicon glyphicon-refresh index-loading"></i></p>
  59. </div>
  60. <ul id="pagination"></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.MenuBarItem">
  73. <h1 id="Terminal_Gui_MenuBarItem" data-uid="Terminal.Gui.MenuBarItem" class="text-break">Class MenuBarItem
  74. </h1>
  75. <div class="markdown level0 summary">
  76. 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.
  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.MenuItem.html">MenuItem</a></div>
  83. <div class="level2"><span class="xref">MenuBarItem</span></div>
  84. </div>
  85. <div class="inheritedMembers">
  86. <h5>Inherited Members</h5>
  87. <div>
  88. <a class="xref" href="Terminal.Gui.MenuItem.html#Terminal_Gui_MenuItem_HotKey">MenuItem.HotKey</a>
  89. </div>
  90. <div>
  91. <a class="xref" href="Terminal.Gui.MenuItem.html#Terminal_Gui_MenuItem_Shortcut">MenuItem.Shortcut</a>
  92. </div>
  93. <div>
  94. <a class="xref" href="Terminal.Gui.MenuItem.html#Terminal_Gui_MenuItem_ShortcutTag">MenuItem.ShortcutTag</a>
  95. </div>
  96. <div>
  97. <a class="xref" href="Terminal.Gui.MenuItem.html#Terminal_Gui_MenuItem_Title">MenuItem.Title</a>
  98. </div>
  99. <div>
  100. <a class="xref" href="Terminal.Gui.MenuItem.html#Terminal_Gui_MenuItem_Help">MenuItem.Help</a>
  101. </div>
  102. <div>
  103. <a class="xref" href="Terminal.Gui.MenuItem.html#Terminal_Gui_MenuItem_Action">MenuItem.Action</a>
  104. </div>
  105. <div>
  106. <a class="xref" href="Terminal.Gui.MenuItem.html#Terminal_Gui_MenuItem_CanExecute">MenuItem.CanExecute</a>
  107. </div>
  108. <div>
  109. <a class="xref" href="Terminal.Gui.MenuItem.html#Terminal_Gui_MenuItem_IsEnabled">MenuItem.IsEnabled()</a>
  110. </div>
  111. <div>
  112. <a class="xref" href="Terminal.Gui.MenuItem.html#Terminal_Gui_MenuItem_Checked">MenuItem.Checked</a>
  113. </div>
  114. <div>
  115. <a class="xref" href="Terminal.Gui.MenuItem.html#Terminal_Gui_MenuItem_CheckType">MenuItem.CheckType</a>
  116. </div>
  117. <div>
  118. <a class="xref" href="Terminal.Gui.MenuItem.html#Terminal_Gui_MenuItem_Parent">MenuItem.Parent</a>
  119. </div>
  120. <div>
  121. <a class="xref" href="Terminal.Gui.MenuItem.html#Terminal_Gui_MenuItem_GetMenuItem">MenuItem.GetMenuItem()</a>
  122. </div>
  123. <div>
  124. <a class="xref" href="Terminal.Gui.MenuItem.html#Terminal_Gui_MenuItem_GetMenuBarItem">MenuItem.GetMenuBarItem()</a>
  125. </div>
  126. <div>
  127. <span class="xref">System.Object.Equals(System.Object)</span>
  128. </div>
  129. <div>
  130. <span class="xref">System.Object.Equals(System.Object, System.Object)</span>
  131. </div>
  132. <div>
  133. <span class="xref">System.Object.GetHashCode()</span>
  134. </div>
  135. <div>
  136. <span class="xref">System.Object.GetType()</span>
  137. </div>
  138. <div>
  139. <span class="xref">System.Object.MemberwiseClone()</span>
  140. </div>
  141. <div>
  142. <span class="xref">System.Object.ReferenceEquals(System.Object, System.Object)</span>
  143. </div>
  144. <div>
  145. <span class="xref">System.Object.ToString()</span>
  146. </div>
  147. </div>
  148. <h6><strong>Namespace</strong>: <a class="xref" href="Terminal.Gui.html">Terminal.Gui</a></h6>
  149. <h6><strong>Assembly</strong>: Terminal.Gui.dll</h6>
  150. <h5 id="Terminal_Gui_MenuBarItem_syntax">Syntax</h5>
  151. <div class="codewrapper">
  152. <pre><code class="lang-csharp hljs">public class MenuBarItem : MenuItem</code></pre>
  153. </div>
  154. <h3 id="constructors">Constructors
  155. </h3>
  156. <a id="Terminal_Gui_MenuBarItem__ctor_" data-uid="Terminal.Gui.MenuBarItem.#ctor*"></a>
  157. <h4 id="Terminal_Gui_MenuBarItem__ctor" data-uid="Terminal.Gui.MenuBarItem.#ctor">MenuBarItem()</h4>
  158. <div class="markdown level1 summary">
  159. Initializes a new <a class="xref" href="Terminal.Gui.MenuBarItem.html">MenuBarItem</a>.
  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 MenuBarItem()</code></pre>
  165. </div>
  166. <a id="Terminal_Gui_MenuBarItem__ctor_" data-uid="Terminal.Gui.MenuBarItem.#ctor*"></a>
  167. <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>
  168. <div class="markdown level1 summary">
  169. 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>.
  170. </div>
  171. <div class="markdown level1 conceptual"></div>
  172. <h5 class="decalaration">Declaration</h5>
  173. <div class="codewrapper">
  174. <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>
  175. </div>
  176. <h5 class="parameters">Parameters</h5>
  177. <table class="table table-bordered table-striped table-condensed">
  178. <thead>
  179. <tr>
  180. <th>Type</th>
  181. <th>Name</th>
  182. <th>Description</th>
  183. </tr>
  184. </thead>
  185. <tbody>
  186. <tr>
  187. <td><span class="xref">NStack.ustring</span></td>
  188. <td><span class="parametername">title</span></td>
  189. <td>Title for the menu item.</td>
  190. </tr>
  191. <tr>
  192. <td><span class="xref">NStack.ustring</span></td>
  193. <td><span class="parametername">help</span></td>
  194. <td>Help text to display.</td>
  195. </tr>
  196. <tr>
  197. <td><span class="xref">System.Action</span></td>
  198. <td><span class="parametername">action</span></td>
  199. <td>Action to invoke when the menu item is activated.</td>
  200. </tr>
  201. <tr>
  202. <td><span class="xref">System.Func</span>&lt;<span class="xref">System.Boolean</span>&gt;</td>
  203. <td><span class="parametername">canExecute</span></td>
  204. <td>Function to determine if the action can currently be executed.</td>
  205. </tr>
  206. <tr>
  207. <td><a class="xref" href="Terminal.Gui.MenuItem.html">MenuItem</a></td>
  208. <td><span class="parametername">parent</span></td>
  209. <td>The parent <a class="xref" href="Terminal.Gui.MenuItem.html">MenuItem</a> of this if exist, otherwise is null.</td>
  210. </tr>
  211. </tbody>
  212. </table>
  213. <a id="Terminal_Gui_MenuBarItem__ctor_" data-uid="Terminal.Gui.MenuBarItem.#ctor*"></a>
  214. <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>
  215. <div class="markdown level1 summary">
  216. Initializes a new <a class="xref" href="Terminal.Gui.MenuBarItem.html">MenuBarItem</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 MenuBarItem(ustring title, MenuItem[] children, MenuItem parent = null)</code></pre>
  222. </div>
  223. <h5 class="parameters">Parameters</h5>
  224. <table class="table table-bordered table-striped table-condensed">
  225. <thead>
  226. <tr>
  227. <th>Type</th>
  228. <th>Name</th>
  229. <th>Description</th>
  230. </tr>
  231. </thead>
  232. <tbody>
  233. <tr>
  234. <td><span class="xref">NStack.ustring</span></td>
  235. <td><span class="parametername">title</span></td>
  236. <td>Title for the menu item.</td>
  237. </tr>
  238. <tr>
  239. <td><a class="xref" href="Terminal.Gui.MenuItem.html">MenuItem</a>[]</td>
  240. <td><span class="parametername">children</span></td>
  241. <td>The items in the current menu.</td>
  242. </tr>
  243. <tr>
  244. <td><a class="xref" href="Terminal.Gui.MenuItem.html">MenuItem</a></td>
  245. <td><span class="parametername">parent</span></td>
  246. <td>The parent <a class="xref" href="Terminal.Gui.MenuItem.html">MenuItem</a> of this if exist, otherwise is null.</td>
  247. </tr>
  248. </tbody>
  249. </table>
  250. <a id="Terminal_Gui_MenuBarItem__ctor_" data-uid="Terminal.Gui.MenuBarItem.#ctor*"></a>
  251. <h4 id="Terminal_Gui_MenuBarItem__ctor_Terminal_Gui_MenuItem___" data-uid="Terminal.Gui.MenuBarItem.#ctor(Terminal.Gui.MenuItem[])">MenuBarItem(MenuItem[])</h4>
  252. <div class="markdown level1 summary">
  253. Initializes a new <a class="xref" href="Terminal.Gui.MenuBarItem.html">MenuBarItem</a>.
  254. </div>
  255. <div class="markdown level1 conceptual"></div>
  256. <h5 class="decalaration">Declaration</h5>
  257. <div class="codewrapper">
  258. <pre><code class="lang-csharp hljs">public MenuBarItem(MenuItem[] children)</code></pre>
  259. </div>
  260. <h5 class="parameters">Parameters</h5>
  261. <table class="table table-bordered table-striped table-condensed">
  262. <thead>
  263. <tr>
  264. <th>Type</th>
  265. <th>Name</th>
  266. <th>Description</th>
  267. </tr>
  268. </thead>
  269. <tbody>
  270. <tr>
  271. <td><a class="xref" href="Terminal.Gui.MenuItem.html">MenuItem</a>[]</td>
  272. <td><span class="parametername">children</span></td>
  273. <td>The items in the current menu.</td>
  274. </tr>
  275. </tbody>
  276. </table>
  277. <h3 id="properties">Properties
  278. </h3>
  279. <a id="Terminal_Gui_MenuBarItem_Children_" data-uid="Terminal.Gui.MenuBarItem.Children*"></a>
  280. <h4 id="Terminal_Gui_MenuBarItem_Children" data-uid="Terminal.Gui.MenuBarItem.Children">Children</h4>
  281. <div class="markdown level1 summary">
  282. 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>
  283. </div>
  284. <div class="markdown level1 conceptual"></div>
  285. <h5 class="decalaration">Declaration</h5>
  286. <div class="codewrapper">
  287. <pre><code class="lang-csharp hljs">public MenuItem[] Children { get; set; }</code></pre>
  288. </div>
  289. <h5 class="propertyValue">Property Value</h5>
  290. <table class="table table-bordered table-striped table-condensed">
  291. <thead>
  292. <tr>
  293. <th>Type</th>
  294. <th>Description</th>
  295. </tr>
  296. </thead>
  297. <tbody>
  298. <tr>
  299. <td><a class="xref" href="Terminal.Gui.MenuItem.html">MenuItem</a>[]</td>
  300. <td>The children.</td>
  301. </tr>
  302. </tbody>
  303. </table>
  304. <h3 id="methods">Methods
  305. </h3>
  306. <a id="Terminal_Gui_MenuBarItem_GetChildrenIndex_" data-uid="Terminal.Gui.MenuBarItem.GetChildrenIndex*"></a>
  307. <h4 id="Terminal_Gui_MenuBarItem_GetChildrenIndex_Terminal_Gui_MenuItem_" data-uid="Terminal.Gui.MenuBarItem.GetChildrenIndex(Terminal.Gui.MenuItem)">GetChildrenIndex(MenuItem)</h4>
  308. <div class="markdown level1 summary">
  309. Get the index of the <a class="xref" href="Terminal.Gui.MenuItem.html">MenuItem</a> parameter.
  310. </div>
  311. <div class="markdown level1 conceptual"></div>
  312. <h5 class="decalaration">Declaration</h5>
  313. <div class="codewrapper">
  314. <pre><code class="lang-csharp hljs">public int GetChildrenIndex(MenuItem children)</code></pre>
  315. </div>
  316. <h5 class="parameters">Parameters</h5>
  317. <table class="table table-bordered table-striped table-condensed">
  318. <thead>
  319. <tr>
  320. <th>Type</th>
  321. <th>Name</th>
  322. <th>Description</th>
  323. </tr>
  324. </thead>
  325. <tbody>
  326. <tr>
  327. <td><a class="xref" href="Terminal.Gui.MenuItem.html">MenuItem</a></td>
  328. <td><span class="parametername">children</span></td>
  329. <td></td>
  330. </tr>
  331. </tbody>
  332. </table>
  333. <h5 class="returns">Returns</h5>
  334. <table class="table table-bordered table-striped table-condensed">
  335. <thead>
  336. <tr>
  337. <th>Type</th>
  338. <th>Description</th>
  339. </tr>
  340. </thead>
  341. <tbody>
  342. <tr>
  343. <td><span class="xref">System.Int32</span></td>
  344. <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>
  345. </tr>
  346. </tbody>
  347. </table>
  348. <a id="Terminal_Gui_MenuBarItem_IsSubMenuOf_" data-uid="Terminal.Gui.MenuBarItem.IsSubMenuOf*"></a>
  349. <h4 id="Terminal_Gui_MenuBarItem_IsSubMenuOf_Terminal_Gui_MenuItem_" data-uid="Terminal.Gui.MenuBarItem.IsSubMenuOf(Terminal.Gui.MenuItem)">IsSubMenuOf(MenuItem)</h4>
  350. <div class="markdown level1 summary">
  351. Check if the <a class="xref" href="Terminal.Gui.MenuItem.html">MenuItem</a> parameter is a child of this.
  352. </div>
  353. <div class="markdown level1 conceptual"></div>
  354. <h5 class="decalaration">Declaration</h5>
  355. <div class="codewrapper">
  356. <pre><code class="lang-csharp hljs">public bool IsSubMenuOf(MenuItem menuItem)</code></pre>
  357. </div>
  358. <h5 class="parameters">Parameters</h5>
  359. <table class="table table-bordered table-striped table-condensed">
  360. <thead>
  361. <tr>
  362. <th>Type</th>
  363. <th>Name</th>
  364. <th>Description</th>
  365. </tr>
  366. </thead>
  367. <tbody>
  368. <tr>
  369. <td><a class="xref" href="Terminal.Gui.MenuItem.html">MenuItem</a></td>
  370. <td><span class="parametername">menuItem</span></td>
  371. <td></td>
  372. </tr>
  373. </tbody>
  374. </table>
  375. <h5 class="returns">Returns</h5>
  376. <table class="table table-bordered table-striped table-condensed">
  377. <thead>
  378. <tr>
  379. <th>Type</th>
  380. <th>Description</th>
  381. </tr>
  382. </thead>
  383. <tbody>
  384. <tr>
  385. <td><span class="xref">System.Boolean</span></td>
  386. <td>Returns <code>true</code> if it is a child of this. <code>false</code> otherwise.</td>
  387. </tr>
  388. </tbody>
  389. </table>
  390. <a id="Terminal_Gui_MenuBarItem_SubMenu_" data-uid="Terminal.Gui.MenuBarItem.SubMenu*"></a>
  391. <h4 id="Terminal_Gui_MenuBarItem_SubMenu_Terminal_Gui_MenuItem_" data-uid="Terminal.Gui.MenuBarItem.SubMenu(Terminal.Gui.MenuItem)">SubMenu(MenuItem)</h4>
  392. <div class="markdown level1 summary">
  393. Check if the children parameter is a <a class="xref" href="Terminal.Gui.MenuBarItem.html">MenuBarItem</a>.
  394. </div>
  395. <div class="markdown level1 conceptual"></div>
  396. <h5 class="decalaration">Declaration</h5>
  397. <div class="codewrapper">
  398. <pre><code class="lang-csharp hljs">public MenuBarItem SubMenu(MenuItem children)</code></pre>
  399. </div>
  400. <h5 class="parameters">Parameters</h5>
  401. <table class="table table-bordered table-striped table-condensed">
  402. <thead>
  403. <tr>
  404. <th>Type</th>
  405. <th>Name</th>
  406. <th>Description</th>
  407. </tr>
  408. </thead>
  409. <tbody>
  410. <tr>
  411. <td><a class="xref" href="Terminal.Gui.MenuItem.html">MenuItem</a></td>
  412. <td><span class="parametername">children</span></td>
  413. <td></td>
  414. </tr>
  415. </tbody>
  416. </table>
  417. <h5 class="returns">Returns</h5>
  418. <table class="table table-bordered table-striped table-condensed">
  419. <thead>
  420. <tr>
  421. <th>Type</th>
  422. <th>Description</th>
  423. </tr>
  424. </thead>
  425. <tbody>
  426. <tr>
  427. <td><a class="xref" href="Terminal.Gui.MenuBarItem.html">MenuBarItem</a></td>
  428. <td>Returns a <a class="xref" href="Terminal.Gui.MenuBarItem.html">MenuBarItem</a> or null otherwise.</td>
  429. </tr>
  430. </tbody>
  431. </table>
  432. </article>
  433. </div>
  434. <div class="hidden-sm col-md-2" role="complementary">
  435. <div class="sideaffix">
  436. <div class="contribution">
  437. <ul class="nav">
  438. </ul>
  439. </div>
  440. <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
  441. <!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
  442. </nav>
  443. </div>
  444. </div>
  445. </div>
  446. </div>
  447. <footer>
  448. <div class="grad-bottom"></div>
  449. <div class="footer">
  450. <div class="container">
  451. <span class="pull-right">
  452. <a href="#top">Back to top</a>
  453. </span>
  454. <span>Generated by <strong>DocFX</strong></span>
  455. </div>
  456. </div>
  457. </footer>
  458. </div>
  459. <script type="text/javascript" src="../../styles/docfx.vendor.js"></script>
  460. <script type="text/javascript" src="../../styles/docfx.js"></script>
  461. <script type="text/javascript" src="../../styles/main.js"></script>
  462. </body>
  463. </html>