Home Explore Help
Sign In
csharp
/
gui-cs.Terminal.Gui
mirror of https://github.com/gui-cs/Terminal.Gui.git
2
0
Fork 0
Files Issues 0 Wiki
Tree: 2a679e01bd
Branches Tags
gui-cs.Terminal...
/
docs
/
api
/
Terminal.Gui
/
Terminal.Gui.MenuBarItem.html

Terminal.Gui.MenuBarItem.html 29 KB
History Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570 
  1. <!DOCTYPE html>
    2. 

  2. <!--[if IE]><![endif]-->
    3. 

  3. <html>
    4. 

  4. 

  5.   <head>
    6. 

  6.     <meta charset="utf-8">
    7. 

  7.       <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
    8. 

  8.       <title>Class MenuBarItem
    9. 

  9.  </title>
    10. 

  10.       <meta name="viewport" content="width=device-width">
    11. 

  11.       <meta name="title" content="Class MenuBarItem
    12. 

  12.  ">
    13. 

  13.     
    14. 

  14.       <link rel="shortcut icon" href="../../favicon.ico">
    15. 

  15.       <link rel="stylesheet" href="../../styles/docfx.vendor.min.css">
    16. 

  16.       <link rel="stylesheet" href="../../styles/docfx.css">
    17. 

  17.       <link rel="stylesheet" href="../../styles/main.css">
    18. 

  18.       <meta property="docfx:navrel" content="../../toc.html">
    19. 

  19.       <meta property="docfx:tocrel" content="toc.html">
    20. 

  20.     
    21. 

  21.     <meta property="docfx:rel" content="../../">
    22. 

  22.     
    23. 

  23.   </head>
    24. 

  24.   <body data-spy="scroll" data-target="#affix" data-offset="120">
    25. 

  25.     <div id="wrapper">
    26. 

  26.       <header>
    27. 

  27. 

  28.         <nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation">
    29. 

  29.           <div class="container">
    30. 

  30.             <div class="navbar-header">
    31. 

  31.               <button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
    32. 

  32.                 <span class="sr-only">Toggle navigation</span>
    33. 

  33.                 <span class="icon-bar"></span>
    34. 

  34.                 <span class="icon-bar"></span>
    35. 

  35.                 <span class="icon-bar"></span>
    36. 

  36.               </button>
    37. 

  37. 

  38.               <a class="navbar-brand" href="../../index.html">
    39. 

  39.                 <img id="logo" class="svg" src="../../images/logo48.png" alt="">
    40. 

  40.               </a>
    41. 

  41.             </div>
    42. 

  42.             <div class="collapse navbar-collapse" id="navbar">
    43. 

  43.               <form class="navbar-form navbar-right" role="search" id="search">
    44. 

  44.                 <div class="form-group">
    45. 

  45.                   <input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">
    46. 

  46.                 </div>
    47. 

  47.               </form>
    48. 

  48.             </div>
    49. 

  49.           </div>
    50. 

  50.         </nav>
    51. 

  51. 

  52.         <div class="subnav navbar navbar-default">
    53. 

  53.           <div class="container hide-when-search" id="breadcrumb">
    54. 

  54.             <ul class="breadcrumb">
    55. 

  55.               <li></li>
    56. 

  56.             </ul>
    57. 

  57.           </div>
    58. 

  58.         </div>
    59. 

  59.       </header>
    60. 

  60.       <div class="container body-content">
    61. 

  61. 

  62.         <div id="search-results">
    63. 

  63.           <div class="search-list">Search Results for <span></span></div>
    64. 

  64.           <div class="sr-items">
    65. 

  65.             <p><i class="glyphicon glyphicon-refresh index-loading"></i></p>
    66. 

  66.           </div>
    67. 

  67.           <ul id="pagination" data-first="First" data-prev="Previous" data-next="Next" data-last="Last"></ul>
    68. 

  68.         </div>
    69. 

  69.       </div>
    70. 

  70.       <div role="main" class="container body-content hide-when-search">
    71. 

  71. 

  72.         <div class="sidenav hide-when-search">
    73. 

  73.           <a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
    74. 

  74.           <div class="sidetoggle collapse" id="sidetoggle">
    75. 

  75.             <div id="sidetoc"></div>
    76. 

  76.           </div>
    77. 

  77.         </div>
    78. 

  78.         <div class="article row grid-right">
    79. 

  79.           <div class="col-md-10">
    80. 

  80.             <article class="content wrap" id="_content" data-uid="Terminal.Gui.MenuBarItem">
    81. 

  81. 

  82. 

  83. 

  84.   <h1 id="Terminal_Gui_MenuBarItem" data-uid="Terminal.Gui.MenuBarItem" class="text-break">Class MenuBarItem
    85. 

  85. </h1>
    86. 

  86.   <div class="markdown level0 summary"><a class="xref" href="Terminal.Gui.MenuBarItem.html">MenuBarItem</a> is a menu item on an app's <a class="xref" href="Terminal.Gui.MenuBar.html">MenuBar</a>. 
    87. 

  87. MenuBarItems do not support <a class="xref" href="Terminal.Gui.MenuItem.html#Terminal_Gui_MenuItem_Shortcut">Shortcut</a>.</div>
    88. 

  88.   <div class="markdown level0 conceptual"></div>
    89. 

  89.   <div class="inheritance">
    90. 

  90.     <h5>Inheritance</h5>
    91. 

  91.     <div class="level0"><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a></div>
    92. 

  92.     <div class="level1"><a class="xref" href="Terminal.Gui.MenuItem.html">MenuItem</a></div>
    93. 

  93.     <div class="level2"><span class="xref">MenuBarItem</span></div>
    94. 

  94.   </div>
    95. 

  95.   <div class="inheritedMembers">
    96. 

  96.     <h5>Inherited Members</h5>
    97. 

  97.     <div>
    98. 

  98.       <a class="xref" href="Terminal.Gui.MenuItem.html#Terminal_Gui_MenuItem_Data">MenuItem.Data</a>
    99. 

  99.     </div>
    100. 

  100.     <div>
    101. 

  101.       <a class="xref" href="Terminal.Gui.MenuItem.html#Terminal_Gui_MenuItem_HotKey">MenuItem.HotKey</a>
    102. 

  102.     </div>
    103. 

  103.     <div>
    104. 

  104.       <a class="xref" href="Terminal.Gui.MenuItem.html#Terminal_Gui_MenuItem_Shortcut">MenuItem.Shortcut</a>
    105. 

  105.     </div>
    106. 

  106.     <div>
    107. 

  107.       <a class="xref" href="Terminal.Gui.MenuItem.html#Terminal_Gui_MenuItem_ShortcutTag">MenuItem.ShortcutTag</a>
    108. 

  108.     </div>
    109. 

  109.     <div>
    110. 

  110.       <a class="xref" href="Terminal.Gui.MenuItem.html#Terminal_Gui_MenuItem_Title">MenuItem.Title</a>
    111. 

  111.     </div>
    112. 

  112.     <div>
    113. 

  113.       <a class="xref" href="Terminal.Gui.MenuItem.html#Terminal_Gui_MenuItem_Help">MenuItem.Help</a>
    114. 

  114.     </div>
    115. 

  115.     <div>
    116. 

  116.       <a class="xref" href="Terminal.Gui.MenuItem.html#Terminal_Gui_MenuItem_Action">MenuItem.Action</a>
    117. 

  117.     </div>
    118. 

  118.     <div>
    119. 

  119.       <a class="xref" href="Terminal.Gui.MenuItem.html#Terminal_Gui_MenuItem_CanExecute">MenuItem.CanExecute</a>
    120. 

  120.     </div>
    121. 

  121.     <div>
    122. 

  122.       <a class="xref" href="Terminal.Gui.MenuItem.html#Terminal_Gui_MenuItem_IsEnabled">MenuItem.IsEnabled()</a>
    123. 

  123.     </div>
    124. 

  124.     <div>
    125. 

  125.       <a class="xref" href="Terminal.Gui.MenuItem.html#Terminal_Gui_MenuItem_Checked">MenuItem.Checked</a>
    126. 

  126.     </div>
    127. 

  127.     <div>
    128. 

  128.       <a class="xref" href="Terminal.Gui.MenuItem.html#Terminal_Gui_MenuItem_CheckType">MenuItem.CheckType</a>
    129. 

  129.     </div>
    130. 

  130.     <div>
    131. 

  131.       <a class="xref" href="Terminal.Gui.MenuItem.html#Terminal_Gui_MenuItem_Parent">MenuItem.Parent</a>
    132. 

  132.     </div>
    133. 

  133.     <div>
    134. 

  134.       <a class="xref" href="Terminal.Gui.MenuItem.html#Terminal_Gui_MenuItem_GetMenuItem">MenuItem.GetMenuItem()</a>
    135. 

  135.     </div>
    136. 

  136.     <div>
    137. 

  137.       <a class="xref" href="Terminal.Gui.MenuItem.html#Terminal_Gui_MenuItem_GetMenuBarItem">MenuItem.GetMenuBarItem()</a>
    138. 

  138.     </div>
    139. 

  139.     <div>
    140. 

  140.       <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)">object.Equals(object)</a>
    141. 

  141.     </div>
    142. 

  142.     <div>
    143. 

  143.       <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)">object.Equals(object, object)</a>
    144. 

  144.     </div>
    145. 

  145.     <div>
    146. 

  146.       <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.gethashcode">object.GetHashCode()</a>
    147. 

  147.     </div>
    148. 

  148.     <div>
    149. 

  149.       <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.gettype">object.GetType()</a>
    150. 

  150.     </div>
    151. 

  151.     <div>
    152. 

  152.       <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone">object.MemberwiseClone()</a>
    153. 

  153.     </div>
    154. 

  154.     <div>
    155. 

  155.       <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.referenceequals">object.ReferenceEquals(object, object)</a>
    156. 

  156.     </div>
    157. 

  157.     <div>
    158. 

  158.       <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.tostring">object.ToString()</a>
    159. 

  159.     </div>
    160. 

  160.   </div>
    161. 

  161.   <h6><strong>Namespace</strong>: <a class="xref" href="Terminal.html">Terminal</a>.<a class="xref" href="Terminal.Gui.html">Gui</a></h6>
    162. 

  162.   <h6><strong>Assembly</strong>: Terminal.Gui.dll</h6>
    163. 

  163.   <h5 id="Terminal_Gui_MenuBarItem_syntax">Syntax</h5>
    164. 

  164.   <div class="codewrapper">
    165. 

  165.     <pre><code class="lang-csharp hljs">public class MenuBarItem : MenuItem</code></pre>
    166. 

  166.   </div>
    167. 

  167.   <h3 id="constructors">Constructors
    168. 

  168. </h3>
    169. 

  169.   <span class="small pull-right mobile-hide">
    170. 

  170.     <span class="divider">|</span>
    171. 

  171.     <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/docfx/overrides/new?filename=Terminal_Gui_MenuBarItem__ctor.md&amp;value=---%0Auid%3A%20Terminal.Gui.MenuBarItem.%23ctor%0Asummary%3A%20&#39;*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax&#39;%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Edit this page</a>
    172. 

  172.   </span>
    173. 

  173.   <span class="small pull-right mobile-hide">
    174. 

  174.     <a href="tig:tig/Terminal.Gui/blob/v2_develop/Terminal.Gui/Views/Menu.cs/#L281">View Source</a>
    175. 

  175.   </span>
    176. 

  176.   <a id="Terminal_Gui_MenuBarItem__ctor_" data-uid="Terminal.Gui.MenuBarItem.#ctor*"></a>
    177. 

  177.   <h4 id="Terminal_Gui_MenuBarItem__ctor" data-uid="Terminal.Gui.MenuBarItem.#ctor">MenuBarItem()</h4>
    178. 

  178.   <div class="markdown level1 summary">Initializes a new <a class="xref" href="Terminal.Gui.MenuBarItem.html">MenuBarItem</a>.</div>
    179. 

  179.   <div class="markdown level1 conceptual"></div>
    180. 

  180.   <h5 class="declaration">Declaration</h5>
    181. 

  181.   <div class="codewrapper">
    182. 

  182.     <pre><code class="lang-csharp hljs">public MenuBarItem()</code></pre>
    183. 

  183.   </div>
    184. 

  184.   <span class="small pull-right mobile-hide">
    185. 

  185.     <span class="divider">|</span>
    186. 

  186.     <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/docfx/overrides/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&#39;*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax&#39;%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Edit this page</a>
    187. 

  187.   </span>
    188. 

  188.   <span class="small pull-right mobile-hide">
    189. 

  189.     <a href="tig:tig/Terminal.Gui/blob/v2_develop/Terminal.Gui/Views/Menu.cs/#L245">View Source</a>
    190. 

  190.   </span>
    191. 

  191.   <a id="Terminal_Gui_MenuBarItem__ctor_" data-uid="Terminal.Gui.MenuBarItem.#ctor*"></a>
    192. 

  192.   <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;bool&gt;, MenuItem)</h4>
    193. 

  193.   <div class="markdown level1 summary">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>.</div>
    194. 

  194.   <div class="markdown level1 conceptual"></div>
    195. 

  195.   <h5 class="declaration">Declaration</h5>
    196. 

  196.   <div class="codewrapper">
    197. 

  197.     <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>
    198. 

  198.   </div>
    199. 

  199.   <h5 class="parameters">Parameters</h5>
    200. 

  200.   <table class="table table-bordered table-condensed">
    201. 

  201.     <thead>
    202. 

  202.       <tr>
    203. 

  203.         <th>Type</th>
    204. 

  204.         <th>Name</th>
    205. 

  205.         <th>Description</th>
    206. 

  206.       </tr>
    207. 

  207.     </thead>
    208. 

  208.     <tbody>
    209. 

  209.       <tr>
    210. 

  210.         <td><span class="xref">ustring</span></td>
    211. 

  211.         <td><span class="parametername">title</span></td>
    212. 

  212.         <td>Title for the menu item.</td>
    213. 

  213.       </tr>
    214. 

  214.       <tr>
    215. 

  215.         <td><span class="xref">ustring</span></td>
    216. 

  216.         <td><span class="parametername">help</span></td>
    217. 

  217.         <td>Help text to display. Will be displayed next to the Title surrounded by parentheses.</td>
    218. 

  218.       </tr>
    219. 

  219.       <tr>
    220. 

  220.         <td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.action">Action</a></td>
    221. 

  221.         <td><span class="parametername">action</span></td>
    222. 

  222.         <td>Action to invoke when the menu item is activated.</td>
    223. 

  223.       </tr>
    224. 

  224.       <tr>
    225. 

  225.         <td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.func-1">Func</a>&lt;<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a>&gt;</td>
    226. 

  226.         <td><span class="parametername">canExecute</span></td>
    227. 

  227.         <td>Function to determine if the action can currently be executed.</td>
    228. 

  228.       </tr>
    229. 

  229.       <tr>
    230. 

  230.         <td><a class="xref" href="Terminal.Gui.MenuItem.html">MenuItem</a></td>
    231. 

  231.         <td><span class="parametername">parent</span></td>
    232. 

  232.         <td>The parent <a class="xref" href="Terminal.Gui.MenuItem.html">MenuItem</a> of this if exist, otherwise is null.</td>
    233. 

  233.       </tr>
    234. 

  234.     </tbody>
    235. 

  235.   </table>
    236. 

  236.   <span class="small pull-right mobile-hide">
    237. 

  237.     <span class="divider">|</span>
    238. 

  238.     <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/docfx/overrides/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&#39;*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax&#39;%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Edit this page</a>
    239. 

  239.   </span>
    240. 

  240.   <span class="small pull-right mobile-hide">
    241. 

  241.     <a href="tig:tig/Terminal.Gui/blob/v2_develop/Terminal.Gui/Views/Menu.cs/#L267">View Source</a>
    242. 

  242.   </span>
    243. 

  243.   <a id="Terminal_Gui_MenuBarItem__ctor_" data-uid="Terminal.Gui.MenuBarItem.#ctor*"></a>
    244. 

  244.   <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>
    245. 

  245.   <div class="markdown level1 summary">Initializes a new <a class="xref" href="Terminal.Gui.MenuBarItem.html">MenuBarItem</a> with separate list of items.</div>
    246. 

  246.   <div class="markdown level1 conceptual"></div>
    247. 

  247.   <h5 class="declaration">Declaration</h5>
    248. 

  248.   <div class="codewrapper">
    249. 

  249.     <pre><code class="lang-csharp hljs">public MenuBarItem(ustring title, List&lt;MenuItem[]&gt; children, MenuItem parent = null)</code></pre>
    250. 

  250.   </div>
    251. 

  251.   <h5 class="parameters">Parameters</h5>
    252. 

  252.   <table class="table table-bordered table-condensed">
    253. 

  253.     <thead>
    254. 

  254.       <tr>
    255. 

  255.         <th>Type</th>
    256. 

  256.         <th>Name</th>
    257. 

  257.         <th>Description</th>
    258. 

  258.       </tr>
    259. 

  259.     </thead>
    260. 

  260.     <tbody>
    261. 

  261.       <tr>
    262. 

  262.         <td><span class="xref">ustring</span></td>
    263. 

  263.         <td><span class="parametername">title</span></td>
    264. 

  264.         <td>Title for the menu item.</td>
    265. 

  265.       </tr>
    266. 

  266.       <tr>
    267. 

  267.         <td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.list-1">List</a>&lt;<a class="xref" href="Terminal.Gui.MenuItem.html">MenuItem</a>[]&gt;</td>
    268. 

  268.         <td><span class="parametername">children</span></td>
    269. 

  269.         <td>The list of items in the current menu.</td>
    270. 

  270.       </tr>
    271. 

  271.       <tr>
    272. 

  272.         <td><a class="xref" href="Terminal.Gui.MenuItem.html">MenuItem</a></td>
    273. 

  273.         <td><span class="parametername">parent</span></td>
    274. 

  274.         <td>The parent <a class="xref" href="Terminal.Gui.MenuItem.html">MenuItem</a> of this if exist, otherwise is null.</td>
    275. 

  275.       </tr>
    276. 

  276.     </tbody>
    277. 

  277.   </table>
    278. 

  278.   <span class="small pull-right mobile-hide">
    279. 

  279.     <span class="divider">|</span>
    280. 

  280.     <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/docfx/overrides/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&#39;*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax&#39;%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Edit this page</a>
    281. 

  281.   </span>
    282. 

  282.   <span class="small pull-right mobile-hide">
    283. 

  283.     <a href="tig:tig/Terminal.Gui/blob/v2_develop/Terminal.Gui/Views/Menu.cs/#L256">View Source</a>
    284. 

  284.   </span>
    285. 

  285.   <a id="Terminal_Gui_MenuBarItem__ctor_" data-uid="Terminal.Gui.MenuBarItem.#ctor*"></a>
    286. 

  286.   <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>
    287. 

  287.   <div class="markdown level1 summary">Initializes a new <a class="xref" href="Terminal.Gui.MenuBarItem.html">MenuBarItem</a>.</div>
    288. 

  288.   <div class="markdown level1 conceptual"></div>
    289. 

  289.   <h5 class="declaration">Declaration</h5>
    290. 

  290.   <div class="codewrapper">
    291. 

  291.     <pre><code class="lang-csharp hljs">public MenuBarItem(ustring title, MenuItem[] children, MenuItem parent = null)</code></pre>
    292. 

  292.   </div>
    293. 

  293.   <h5 class="parameters">Parameters</h5>
    294. 

  294.   <table class="table table-bordered table-condensed">
    295. 

  295.     <thead>
    296. 

  296.       <tr>
    297. 

  297.         <th>Type</th>
    298. 

  298.         <th>Name</th>
    299. 

  299.         <th>Description</th>
    300. 

  300.       </tr>
    301. 

  301.     </thead>
    302. 

  302.     <tbody>
    303. 

  303.       <tr>
    304. 

  304.         <td><span class="xref">ustring</span></td>
    305. 

  305.         <td><span class="parametername">title</span></td>
    306. 

  306.         <td>Title for the menu item.</td>
    307. 

  307.       </tr>
    308. 

  308.       <tr>
    309. 

  309.         <td><a class="xref" href="Terminal.Gui.MenuItem.html">MenuItem</a>[]</td>
    310. 

  310.         <td><span class="parametername">children</span></td>
    311. 

  311.         <td>The items in the current menu.</td>
    312. 

  312.       </tr>
    313. 

  313.       <tr>
    314. 

  314.         <td><a class="xref" href="Terminal.Gui.MenuItem.html">MenuItem</a></td>
    315. 

  315.         <td><span class="parametername">parent</span></td>
    316. 

  316.         <td>The parent <a class="xref" href="Terminal.Gui.MenuItem.html">MenuItem</a> of this if exist, otherwise is null.</td>
    317. 

  317.       </tr>
    318. 

  318.     </tbody>
    319. 

  319.   </table>
    320. 

  320.   <span class="small pull-right mobile-hide">
    321. 

  321.     <span class="divider">|</span>
    322. 

  322.     <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/docfx/overrides/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&#39;*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax&#39;%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Edit this page</a>
    323. 

  323.   </span>
    324. 

  324.   <span class="small pull-right mobile-hide">
    325. 

  325.     <a href="tig:tig/Terminal.Gui/blob/v2_develop/Terminal.Gui/Views/Menu.cs/#L276">View Source</a>
    326. 

  326.   </span>
    327. 

  327.   <a id="Terminal_Gui_MenuBarItem__ctor_" data-uid="Terminal.Gui.MenuBarItem.#ctor*"></a>
    328. 

  328.   <h4 id="Terminal_Gui_MenuBarItem__ctor_Terminal_Gui_MenuItem___" data-uid="Terminal.Gui.MenuBarItem.#ctor(Terminal.Gui.MenuItem[])">MenuBarItem(MenuItem[])</h4>
    329. 

  329.   <div class="markdown level1 summary">Initializes a new <a class="xref" href="Terminal.Gui.MenuBarItem.html">MenuBarItem</a>.</div>
    330. 

  330.   <div class="markdown level1 conceptual"></div>
    331. 

  331.   <h5 class="declaration">Declaration</h5>
    332. 

  332.   <div class="codewrapper">
    333. 

  333.     <pre><code class="lang-csharp hljs">public MenuBarItem(MenuItem[] children)</code></pre>
    334. 

  334.   </div>
    335. 

  335.   <h5 class="parameters">Parameters</h5>
    336. 

  336.   <table class="table table-bordered table-condensed">
    337. 

  337.     <thead>
    338. 

  338.       <tr>
    339. 

  339.         <th>Type</th>
    340. 

  340.         <th>Name</th>
    341. 

  341.         <th>Description</th>
    342. 

  342.       </tr>
    343. 

  343.     </thead>
    344. 

  344.     <tbody>
    345. 

  345.       <tr>
    346. 

  346.         <td><a class="xref" href="Terminal.Gui.MenuItem.html">MenuItem</a>[]</td>
    347. 

  347.         <td><span class="parametername">children</span></td>
    348. 

  348.         <td>The items in the current menu.</td>
    349. 

  349.       </tr>
    350. 

  350.     </tbody>
    351. 

  351.   </table>
    352. 

  352.   <h3 id="properties">Properties
    353. 

  353. </h3>
    354. 

  354.   <span class="small pull-right mobile-hide">
    355. 

  355.     <span class="divider">|</span>
    356. 

  356.     <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/docfx/overrides/new?filename=Terminal_Gui_MenuBarItem_Children.md&amp;value=---%0Auid%3A%20Terminal.Gui.MenuBarItem.Children%0Asummary%3A%20&#39;*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax&#39;%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Edit this page</a>
    357. 

  357.   </span>
    358. 

  358.   <span class="small pull-right mobile-hide">
    359. 

  359.     <a href="tig:tig/Terminal.Gui/blob/v2_develop/Terminal.Gui/Views/Menu.cs/#L375">View Source</a>
    360. 

  360.   </span>
    361. 

  361.   <a id="Terminal_Gui_MenuBarItem_Children_" data-uid="Terminal.Gui.MenuBarItem.Children*"></a>
    362. 

  362.   <h4 id="Terminal_Gui_MenuBarItem_Children" data-uid="Terminal.Gui.MenuBarItem.Children">Children</h4>
    363. 

  363.   <div class="markdown level1 summary">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></div>
    364. 

  364.   <div class="markdown level1 conceptual"></div>
    365. 

  365.   <h5 class="declaration">Declaration</h5>
    366. 

  366.   <div class="codewrapper">
    367. 

  367.     <pre><code class="lang-csharp hljs">public MenuItem[] Children { get; set; }</code></pre>
    368. 

  368.   </div>
    369. 

  369.   <h5 class="propertyValue">Property Value</h5>
    370. 

  370.   <table class="table table-bordered table-condensed">
    371. 

  371.     <thead>
    372. 

  372.       <tr>
    373. 

  373.         <th>Type</th>
    374. 

  374.         <th>Description</th>
    375. 

  375.       </tr>
    376. 

  376.     </thead>
    377. 

  377.     <tbody>
    378. 

  378.       <tr>
    379. 

  379.         <td><a class="xref" href="Terminal.Gui.MenuItem.html">MenuItem</a>[]</td>
    380. 

  380.         <td>The children.</td>
    381. 

  381.       </tr>
    382. 

  382.     </tbody>
    383. 

  383.   </table>
    384. 

  384.   <h3 id="methods">Methods
    385. 

  385. </h3>
    386. 

  386.   <span class="small pull-right mobile-hide">
    387. 

  387.     <span class="divider">|</span>
    388. 

  388.     <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/docfx/overrides/new?filename=Terminal_Gui_MenuBarItem_GetChildrenIndex_Terminal_Gui_MenuItem_.md&amp;value=---%0Auid%3A%20Terminal.Gui.MenuBarItem.GetChildrenIndex(Terminal.Gui.MenuItem)%0Asummary%3A%20&#39;*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax&#39;%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Edit this page</a>
    389. 

  389.   </span>
    390. 

  390.   <span class="small pull-right mobile-hide">
    391. 

  391.     <a href="tig:tig/Terminal.Gui/blob/v2_develop/Terminal.Gui/Views/Menu.cs/#L349">View Source</a>
    392. 

  392.   </span>
    393. 

  393.   <a id="Terminal_Gui_MenuBarItem_GetChildrenIndex_" data-uid="Terminal.Gui.MenuBarItem.GetChildrenIndex*"></a>
    394. 

  394.   <h4 id="Terminal_Gui_MenuBarItem_GetChildrenIndex_Terminal_Gui_MenuItem_" data-uid="Terminal.Gui.MenuBarItem.GetChildrenIndex(Terminal.Gui.MenuItem)">GetChildrenIndex(MenuItem)</h4>
    395. 

  395.   <div class="markdown level1 summary">Get the index of the <a class="xref" href="Terminal.Gui.MenuItem.html">MenuItem</a> parameter.</div>
    396. 

  396.   <div class="markdown level1 conceptual"></div>
    397. 

  397.   <h5 class="declaration">Declaration</h5>
    398. 

  398.   <div class="codewrapper">
    399. 

  399.     <pre><code class="lang-csharp hljs">public int GetChildrenIndex(MenuItem children)</code></pre>
    400. 

  400.   </div>
    401. 

  401.   <h5 class="parameters">Parameters</h5>
    402. 

  402.   <table class="table table-bordered table-condensed">
    403. 

  403.     <thead>
    404. 

  404.       <tr>
    405. 

  405.         <th>Type</th>
    406. 

  406.         <th>Name</th>
    407. 

  407.         <th>Description</th>
    408. 

  408.       </tr>
    409. 

  409.     </thead>
    410. 

  410.     <tbody>
    411. 

  411.       <tr>
    412. 

  412.         <td><a class="xref" href="Terminal.Gui.MenuItem.html">MenuItem</a></td>
    413. 

  413.         <td><span class="parametername">children</span></td>
    414. 

  414.         <td></td>
    415. 

  415.       </tr>
    416. 

  416.     </tbody>
    417. 

  417.   </table>
    418. 

  418.   <h5 class="returns">Returns</h5>
    419. 

  419.   <table class="table table-bordered table-condensed">
    420. 

  420.     <thead>
    421. 

  421.       <tr>
    422. 

  422.         <th>Type</th>
    423. 

  423.         <th>Description</th>
    424. 

  424.       </tr>
    425. 

  425.     </thead>
    426. 

  426.     <tbody>
    427. 

  427.       <tr>
    428. 

  428.         <td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></td>
    429. 

  429.         <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>
    430. 

  430.       </tr>
    431. 

  431.     </tbody>
    432. 

  432.   </table>
    433. 

  433.   <span class="small pull-right mobile-hide">
    434. 

  434.     <span class="divider">|</span>
    435. 

  435.     <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/docfx/overrides/new?filename=Terminal_Gui_MenuBarItem_IsSubMenuOf_Terminal_Gui_MenuItem_.md&amp;value=---%0Auid%3A%20Terminal.Gui.MenuBarItem.IsSubMenuOf(Terminal.Gui.MenuItem)%0Asummary%3A%20&#39;*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax&#39;%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Edit this page</a>
    436. 

  436.   </span>
    437. 

  437.   <span class="small pull-right mobile-hide">
    438. 

  438.     <a href="tig:tig/Terminal.Gui/blob/v2_develop/Terminal.Gui/Views/Menu.cs/#L334">View Source</a>
    439. 

  439.   </span>
    440. 

  440.   <a id="Terminal_Gui_MenuBarItem_IsSubMenuOf_" data-uid="Terminal.Gui.MenuBarItem.IsSubMenuOf*"></a>
    441. 

  441.   <h4 id="Terminal_Gui_MenuBarItem_IsSubMenuOf_Terminal_Gui_MenuItem_" data-uid="Terminal.Gui.MenuBarItem.IsSubMenuOf(Terminal.Gui.MenuItem)">IsSubMenuOf(MenuItem)</h4>
    442. 

  442.   <div class="markdown level1 summary">Check if the <a class="xref" href="Terminal.Gui.MenuItem.html">MenuItem</a> parameter is a child of this.</div>
    443. 

  443.   <div class="markdown level1 conceptual"></div>
    444. 

  444.   <h5 class="declaration">Declaration</h5>
    445. 

  445.   <div class="codewrapper">
    446. 

  446.     <pre><code class="lang-csharp hljs">public bool IsSubMenuOf(MenuItem menuItem)</code></pre>
    447. 

  447.   </div>
    448. 

  448.   <h5 class="parameters">Parameters</h5>
    449. 

  449.   <table class="table table-bordered table-condensed">
    450. 

  450.     <thead>
    451. 

  451.       <tr>
    452. 

  452.         <th>Type</th>
    453. 

  453.         <th>Name</th>
    454. 

  454.         <th>Description</th>
    455. 

  455.       </tr>
    456. 

  456.     </thead>
    457. 

  457.     <tbody>
    458. 

  458.       <tr>
    459. 

  459.         <td><a class="xref" href="Terminal.Gui.MenuItem.html">MenuItem</a></td>
    460. 

  460.         <td><span class="parametername">menuItem</span></td>
    461. 

  461.         <td></td>
    462. 

  462.       </tr>
    463. 

  463.     </tbody>
    464. 

  464.   </table>
    465. 

  465.   <h5 class="returns">Returns</h5>
    466. 

  466.   <table class="table table-bordered table-condensed">
    467. 

  467.     <thead>
    468. 

  468.       <tr>
    469. 

  469.         <th>Type</th>
    470. 

  470.         <th>Description</th>
    471. 

  471.       </tr>
    472. 

  472.     </thead>
    473. 

  473.     <tbody>
    474. 

  474.       <tr>
    475. 

  475.         <td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></td>
    476. 

  476.         <td>Returns <code>true</code> if it is a child of this. <code>false</code> otherwise.</td>
    477. 

  477.       </tr>
    478. 

  478.     </tbody>
    479. 

  479.   </table>
    480. 

  480.   <span class="small pull-right mobile-hide">
    481. 

  481.     <span class="divider">|</span>
    482. 

  482.     <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/docfx/overrides/new?filename=Terminal_Gui_MenuBarItem_SubMenu_Terminal_Gui_MenuItem_.md&amp;value=---%0Auid%3A%20Terminal.Gui.MenuBarItem.SubMenu(Terminal.Gui.MenuItem)%0Asummary%3A%20&#39;*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax&#39;%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Edit this page</a>
    483. 

  483.   </span>
    484. 

  484.   <span class="small pull-right mobile-hide">
    485. 

  485.     <a href="tig:tig/Terminal.Gui/blob/v2_develop/Terminal.Gui/Views/Menu.cs/#L324">View Source</a>
    486. 

  486.   </span>
    487. 

  487.   <a id="Terminal_Gui_MenuBarItem_SubMenu_" data-uid="Terminal.Gui.MenuBarItem.SubMenu*"></a>
    488. 

  488.   <h4 id="Terminal_Gui_MenuBarItem_SubMenu_Terminal_Gui_MenuItem_" data-uid="Terminal.Gui.MenuBarItem.SubMenu(Terminal.Gui.MenuItem)">SubMenu(MenuItem)</h4>
    489. 

  489.   <div class="markdown level1 summary">Check if the children parameter is a <a class="xref" href="Terminal.Gui.MenuBarItem.html">MenuBarItem</a>.</div>
    490. 

  490.   <div class="markdown level1 conceptual"></div>
    491. 

  491.   <h5 class="declaration">Declaration</h5>
    492. 

  492.   <div class="codewrapper">
    493. 

  493.     <pre><code class="lang-csharp hljs">public MenuBarItem SubMenu(MenuItem children)</code></pre>
    494. 

  494.   </div>
    495. 

  495.   <h5 class="parameters">Parameters</h5>
    496. 

  496.   <table class="table table-bordered table-condensed">
    497. 

  497.     <thead>
    498. 

  498.       <tr>
    499. 

  499.         <th>Type</th>
    500. 

  500.         <th>Name</th>
    501. 

  501.         <th>Description</th>
    502. 

  502.       </tr>
    503. 

  503.     </thead>
    504. 

  504.     <tbody>
    505. 

  505.       <tr>
    506. 

  506.         <td><a class="xref" href="Terminal.Gui.MenuItem.html">MenuItem</a></td>
    507. 

  507.         <td><span class="parametername">children</span></td>
    508. 

  508.         <td></td>
    509. 

  509.       </tr>
    510. 

  510.     </tbody>
    511. 

  511.   </table>
    512. 

  512.   <h5 class="returns">Returns</h5>
    513. 

  513.   <table class="table table-bordered table-condensed">
    514. 

  514.     <thead>
    515. 

  515.       <tr>
    516. 

  516.         <th>Type</th>
    517. 

  517.         <th>Description</th>
    518. 

  518.       </tr>
    519. 

  519.     </thead>
    520. 

  520.     <tbody>
    521. 

  521.       <tr>
    522. 

  522.         <td><a class="xref" href="Terminal.Gui.MenuBarItem.html">MenuBarItem</a></td>
    523. 

  523.         <td>Returns a <a class="xref" href="Terminal.Gui.MenuBarItem.html">MenuBarItem</a> or null otherwise.</td>
    524. 

  524.       </tr>
    525. 

  525.     </tbody>
    526. 

  526.   </table>
    527. 

  527. 

  528. </article>
    529. 

  529.           </div>
    530. 

  530. 

  531.           <div class="hidden-sm col-md-2" role="complementary">
    532. 

  532.             <div class="sideaffix">
    533. 

  533.               <div class="contribution">
    534. 

  534.                 <ul class="nav">
    535. 

  535.                   <li>
    536. 

  536.                     <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/docfx/overrides/new?filename=Terminal_Gui_MenuBarItem.md&amp;value=---%0Auid%3A%20Terminal.Gui.MenuBarItem%0Asummary%3A%20&#39;*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax&#39;%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A" class="contribution-link">Edit this page</a>
    537. 

  537.                   </li>
    538. 

  538.                   <li>
    539. 

  539.                     <a href="tig:tig/Terminal.Gui/blob/v2_develop/Terminal.Gui/Views/Menu.cs/#L236" class="contribution-link">View Source</a>
    540. 

  540.                   </li>
    541. 

  541.                 </ul>
    542. 

  542.               </div>
    543. 

  543.               <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
    544. 

  544.                 <h5>In this article</h5>
    545. 

  545.                 <div></div>
    546. 

  546.               </nav>
    547. 

  547.             </div>
    548. 

  548.           </div>
    549. 

  549.         </div>
    550. 

  550.       </div>
    551. 

  551. 

  552.       <footer>
    553. 

  553.         <div class="grad-bottom"></div>
    554. 

  554.         <div class="footer">
    555. 

  555.           <div class="container">
    556. 

  556.             <span class="pull-right">
    557. 

  557.               <a href="#top">Back to top</a>
    558. 

  558.             </span>
    559. 

  559.       
    560. 

  560.       <span>Generated by <strong>DocFX</strong></span>
    561. 

  561.           </div>
    562. 

  562.         </div>
    563. 

  563.       </footer>
    564. 

  564.     </div>
    565. 

  565. 

  566.     <script type="text/javascript" src="../../styles/docfx.vendor.min.js"></script>
    567. 

  567.     <script type="text/javascript" src="../../styles/docfx.js"></script>
    568. 

  568.     <script type="text/javascript" src="../../styles/main.js"></script>
    569. 

  569.   </body>
    570. 

  570. </html>
    571.