Terminal.Gui.ContextMenu.html 33 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688
  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 ContextMenu
  8. </title>
  9. <meta name="viewport" content="width=device-width">
  10. <meta name="title" content="Class ContextMenu
  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.ContextMenu">
  74. <h1 id="Terminal_Gui_ContextMenu" data-uid="Terminal.Gui.ContextMenu" class="text-break">Class ContextMenu
  75. </h1>
  76. <div class="markdown level0 summary">
  77. A context menu window derived from <a class="xref" href="Terminal.Gui.ContextMenu.html#Terminal_Gui_ContextMenu_MenuBar">MenuBar</a> containing menu items
  78. which can be opened in any position.
  79. </div>
  80. <div class="markdown level0 conceptual"></div>
  81. <div class="inheritance">
  82. <h5>Inheritance</h5>
  83. <div class="level0"><span class="xref">System.Object</span></div>
  84. <div class="level1"><span class="xref">ContextMenu</span></div>
  85. </div>
  86. <div class="implements">
  87. <h5>Implements</h5>
  88. <div><span class="xref">System.IDisposable</span></div>
  89. </div>
  90. <div class="inheritedMembers">
  91. <h5>Inherited Members</h5>
  92. <div>
  93. <span class="xref">System.Object.Equals(System.Object)</span>
  94. </div>
  95. <div>
  96. <span class="xref">System.Object.Equals(System.Object, System.Object)</span>
  97. </div>
  98. <div>
  99. <span class="xref">System.Object.GetHashCode()</span>
  100. </div>
  101. <div>
  102. <span class="xref">System.Object.GetType()</span>
  103. </div>
  104. <div>
  105. <span class="xref">System.Object.MemberwiseClone()</span>
  106. </div>
  107. <div>
  108. <span class="xref">System.Object.ReferenceEquals(System.Object, System.Object)</span>
  109. </div>
  110. <div>
  111. <span class="xref">System.Object.ToString()</span>
  112. </div>
  113. </div>
  114. <h6><strong>Namespace</strong>: <a class="xref" href="Terminal.Gui.html">Terminal.Gui</a></h6>
  115. <h6><strong>Assembly</strong>: Terminal.Gui.dll</h6>
  116. <h5 id="Terminal_Gui_ContextMenu_syntax">Syntax</h5>
  117. <div class="codewrapper">
  118. <pre><code class="lang-csharp hljs">public sealed class ContextMenu : IDisposable</code></pre>
  119. </div>
  120. <h3 id="constructors">Constructors
  121. </h3>
  122. <span class="small pull-right mobile-hide">
  123. <span class="divider">|</span>
  124. <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/apidoc/new?filename=Terminal_Gui_ContextMenu__ctor.md&amp;value=---%0Auid%3A%20Terminal.Gui.ContextMenu.%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>
  125. </span>
  126. <span class="small pull-right mobile-hide">
  127. <a href="tig:tig/gui.cs/blob/main/Terminal.Gui/Core/ContextMenu.cs/#L17">View Source</a>
  128. </span>
  129. <a id="Terminal_Gui_ContextMenu__ctor_" data-uid="Terminal.Gui.ContextMenu.#ctor*"></a>
  130. <h4 id="Terminal_Gui_ContextMenu__ctor" data-uid="Terminal.Gui.ContextMenu.#ctor">ContextMenu()</h4>
  131. <div class="markdown level1 summary">
  132. Initialize a context menu with empty menu items.
  133. </div>
  134. <div class="markdown level1 conceptual"></div>
  135. <h5 class="decalaration">Declaration</h5>
  136. <div class="codewrapper">
  137. <pre><code class="lang-csharp hljs">public ContextMenu()</code></pre>
  138. </div>
  139. <span class="small pull-right mobile-hide">
  140. <span class="divider">|</span>
  141. <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/apidoc/new?filename=Terminal_Gui_ContextMenu__ctor_System_Int32_System_Int32_Terminal_Gui_MenuBarItem_.md&amp;value=---%0Auid%3A%20Terminal.Gui.ContextMenu.%23ctor(System.Int32%2CSystem.Int32%2CTerminal.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">Improve this Doc</a>
  142. </span>
  143. <span class="small pull-right mobile-hide">
  144. <a href="tig:tig/gui.cs/blob/main/Terminal.Gui/Core/ContextMenu.cs/#L36">View Source</a>
  145. </span>
  146. <a id="Terminal_Gui_ContextMenu__ctor_" data-uid="Terminal.Gui.ContextMenu.#ctor*"></a>
  147. <h4 id="Terminal_Gui_ContextMenu__ctor_System_Int32_System_Int32_Terminal_Gui_MenuBarItem_" data-uid="Terminal.Gui.ContextMenu.#ctor(System.Int32,System.Int32,Terminal.Gui.MenuBarItem)">ContextMenu(Int32, Int32, MenuBarItem)</h4>
  148. <div class="markdown level1 summary">
  149. Initialize a context menu with menu items.
  150. </div>
  151. <div class="markdown level1 conceptual"></div>
  152. <h5 class="decalaration">Declaration</h5>
  153. <div class="codewrapper">
  154. <pre><code class="lang-csharp hljs">public ContextMenu(int x, int y, MenuBarItem menuItems)</code></pre>
  155. </div>
  156. <h5 class="parameters">Parameters</h5>
  157. <table class="table table-bordered table-striped table-condensed">
  158. <thead>
  159. <tr>
  160. <th>Type</th>
  161. <th>Name</th>
  162. <th>Description</th>
  163. </tr>
  164. </thead>
  165. <tbody>
  166. <tr>
  167. <td><span class="xref">System.Int32</span></td>
  168. <td><span class="parametername">x</span></td>
  169. <td>The left position.</td>
  170. </tr>
  171. <tr>
  172. <td><span class="xref">System.Int32</span></td>
  173. <td><span class="parametername">y</span></td>
  174. <td>The top position.</td>
  175. </tr>
  176. <tr>
  177. <td><a class="xref" href="Terminal.Gui.MenuBarItem.html">MenuBarItem</a></td>
  178. <td><span class="parametername">menuItems</span></td>
  179. <td>The menu items.</td>
  180. </tr>
  181. </tbody>
  182. </table>
  183. <span class="small pull-right mobile-hide">
  184. <span class="divider">|</span>
  185. <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/apidoc/new?filename=Terminal_Gui_ContextMenu__ctor_Terminal_Gui_View_Terminal_Gui_MenuBarItem_.md&amp;value=---%0Auid%3A%20Terminal.Gui.ContextMenu.%23ctor(Terminal.Gui.View%2CTerminal.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">Improve this Doc</a>
  186. </span>
  187. <span class="small pull-right mobile-hide">
  188. <a href="tig:tig/gui.cs/blob/main/Terminal.Gui/Core/ContextMenu.cs/#L24">View Source</a>
  189. </span>
  190. <a id="Terminal_Gui_ContextMenu__ctor_" data-uid="Terminal.Gui.ContextMenu.#ctor*"></a>
  191. <h4 id="Terminal_Gui_ContextMenu__ctor_Terminal_Gui_View_Terminal_Gui_MenuBarItem_" data-uid="Terminal.Gui.ContextMenu.#ctor(Terminal.Gui.View,Terminal.Gui.MenuBarItem)">ContextMenu(View, MenuBarItem)</h4>
  192. <div class="markdown level1 summary">
  193. Initialize a context menu with menu items from a host <a class="xref" href="Terminal.Gui.View.html">View</a>.
  194. </div>
  195. <div class="markdown level1 conceptual"></div>
  196. <h5 class="decalaration">Declaration</h5>
  197. <div class="codewrapper">
  198. <pre><code class="lang-csharp hljs">public ContextMenu(View host, MenuBarItem menuItems)</code></pre>
  199. </div>
  200. <h5 class="parameters">Parameters</h5>
  201. <table class="table table-bordered table-striped table-condensed">
  202. <thead>
  203. <tr>
  204. <th>Type</th>
  205. <th>Name</th>
  206. <th>Description</th>
  207. </tr>
  208. </thead>
  209. <tbody>
  210. <tr>
  211. <td><a class="xref" href="Terminal.Gui.View.html">View</a></td>
  212. <td><span class="parametername">host</span></td>
  213. <td>The host view.</td>
  214. </tr>
  215. <tr>
  216. <td><a class="xref" href="Terminal.Gui.MenuBarItem.html">MenuBarItem</a></td>
  217. <td><span class="parametername">menuItems</span></td>
  218. <td>The menu items.</td>
  219. </tr>
  220. </tbody>
  221. </table>
  222. <h3 id="properties">Properties
  223. </h3>
  224. <span class="small pull-right mobile-hide">
  225. <span class="divider">|</span>
  226. <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/apidoc/new?filename=Terminal_Gui_ContextMenu_ForceMinimumPosToZero.md&amp;value=---%0Auid%3A%20Terminal.Gui.ContextMenu.ForceMinimumPosToZero%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>
  227. </span>
  228. <span class="small pull-right mobile-hide">
  229. <a href="tig:tig/gui.cs/blob/main/Terminal.Gui/Core/ContextMenu.cs/#L208">View Source</a>
  230. </span>
  231. <a id="Terminal_Gui_ContextMenu_ForceMinimumPosToZero_" data-uid="Terminal.Gui.ContextMenu.ForceMinimumPosToZero*"></a>
  232. <h4 id="Terminal_Gui_ContextMenu_ForceMinimumPosToZero" data-uid="Terminal.Gui.ContextMenu.ForceMinimumPosToZero">ForceMinimumPosToZero</h4>
  233. <div class="markdown level1 summary">
  234. Gets or sets whether forces the minimum position to zero
  235. if the left or right position are negative.
  236. </div>
  237. <div class="markdown level1 conceptual"></div>
  238. <h5 class="decalaration">Declaration</h5>
  239. <div class="codewrapper">
  240. <pre><code class="lang-csharp hljs">public bool ForceMinimumPosToZero { get; set; }</code></pre>
  241. </div>
  242. <h5 class="propertyValue">Property Value</h5>
  243. <table class="table table-bordered table-striped table-condensed">
  244. <thead>
  245. <tr>
  246. <th>Type</th>
  247. <th>Description</th>
  248. </tr>
  249. </thead>
  250. <tbody>
  251. <tr>
  252. <td><span class="xref">System.Boolean</span></td>
  253. <td></td>
  254. </tr>
  255. </tbody>
  256. </table>
  257. <span class="small pull-right mobile-hide">
  258. <span class="divider">|</span>
  259. <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/apidoc/new?filename=Terminal_Gui_ContextMenu_Host.md&amp;value=---%0Auid%3A%20Terminal.Gui.ContextMenu.Host%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>
  260. </span>
  261. <span class="small pull-right mobile-hide">
  262. <a href="tig:tig/gui.cs/blob/main/Terminal.Gui/Core/ContextMenu.cs/#L202">View Source</a>
  263. </span>
  264. <a id="Terminal_Gui_ContextMenu_Host_" data-uid="Terminal.Gui.ContextMenu.Host*"></a>
  265. <h4 id="Terminal_Gui_ContextMenu_Host" data-uid="Terminal.Gui.ContextMenu.Host">Host</h4>
  266. <div class="markdown level1 summary">
  267. The host <a class="xref" href="Terminal.Gui.View.html">View</a> which position will be used,
  268. otherwise if it&apos;s null the container will be used.
  269. </div>
  270. <div class="markdown level1 conceptual"></div>
  271. <h5 class="decalaration">Declaration</h5>
  272. <div class="codewrapper">
  273. <pre><code class="lang-csharp hljs">public View Host { get; set; }</code></pre>
  274. </div>
  275. <h5 class="propertyValue">Property Value</h5>
  276. <table class="table table-bordered table-striped table-condensed">
  277. <thead>
  278. <tr>
  279. <th>Type</th>
  280. <th>Description</th>
  281. </tr>
  282. </thead>
  283. <tbody>
  284. <tr>
  285. <td><a class="xref" href="Terminal.Gui.View.html">View</a></td>
  286. <td></td>
  287. </tr>
  288. </tbody>
  289. </table>
  290. <span class="small pull-right mobile-hide">
  291. <span class="divider">|</span>
  292. <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/apidoc/new?filename=Terminal_Gui_ContextMenu_IsShow.md&amp;value=---%0Auid%3A%20Terminal.Gui.ContextMenu.IsShow%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>
  293. </span>
  294. <span class="small pull-right mobile-hide">
  295. <a href="tig:tig/gui.cs/blob/main/Terminal.Gui/Core/ContextMenu.cs/#L196">View Source</a>
  296. </span>
  297. <a id="Terminal_Gui_ContextMenu_IsShow_" data-uid="Terminal.Gui.ContextMenu.IsShow*"></a>
  298. <h4 id="Terminal_Gui_ContextMenu_IsShow" data-uid="Terminal.Gui.ContextMenu.IsShow">IsShow</h4>
  299. <div class="markdown level1 summary">
  300. Gets information whether menu is showing or not.
  301. </div>
  302. <div class="markdown level1 conceptual"></div>
  303. <h5 class="decalaration">Declaration</h5>
  304. <div class="codewrapper">
  305. <pre><code class="lang-csharp hljs">public static bool IsShow { get; }</code></pre>
  306. </div>
  307. <h5 class="propertyValue">Property Value</h5>
  308. <table class="table table-bordered table-striped table-condensed">
  309. <thead>
  310. <tr>
  311. <th>Type</th>
  312. <th>Description</th>
  313. </tr>
  314. </thead>
  315. <tbody>
  316. <tr>
  317. <td><span class="xref">System.Boolean</span></td>
  318. <td></td>
  319. </tr>
  320. </tbody>
  321. </table>
  322. <span class="small pull-right mobile-hide">
  323. <span class="divider">|</span>
  324. <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/apidoc/new?filename=Terminal_Gui_ContextMenu_Key.md&amp;value=---%0Auid%3A%20Terminal.Gui.ContextMenu.Key%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>
  325. </span>
  326. <span class="small pull-right mobile-hide">
  327. <a href="tig:tig/gui.cs/blob/main/Terminal.Gui/Core/ContextMenu.cs/#L172">View Source</a>
  328. </span>
  329. <a id="Terminal_Gui_ContextMenu_Key_" data-uid="Terminal.Gui.ContextMenu.Key*"></a>
  330. <h4 id="Terminal_Gui_ContextMenu_Key" data-uid="Terminal.Gui.ContextMenu.Key">Key</h4>
  331. <div class="markdown level1 summary">
  332. The <a class="xref" href="Terminal.Gui.Key.html">Key</a> used to activate the context menu by keyboard.
  333. </div>
  334. <div class="markdown level1 conceptual"></div>
  335. <h5 class="decalaration">Declaration</h5>
  336. <div class="codewrapper">
  337. <pre><code class="lang-csharp hljs">public Key Key { get; set; }</code></pre>
  338. </div>
  339. <h5 class="propertyValue">Property Value</h5>
  340. <table class="table table-bordered table-striped table-condensed">
  341. <thead>
  342. <tr>
  343. <th>Type</th>
  344. <th>Description</th>
  345. </tr>
  346. </thead>
  347. <tbody>
  348. <tr>
  349. <td><a class="xref" href="Terminal.Gui.Key.html">Key</a></td>
  350. <td></td>
  351. </tr>
  352. </tbody>
  353. </table>
  354. <span class="small pull-right mobile-hide">
  355. <span class="divider">|</span>
  356. <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/apidoc/new?filename=Terminal_Gui_ContextMenu_MenuBar.md&amp;value=---%0Auid%3A%20Terminal.Gui.ContextMenu.MenuBar%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>
  357. </span>
  358. <span class="small pull-right mobile-hide">
  359. <a href="tig:tig/gui.cs/blob/main/Terminal.Gui/Core/ContextMenu.cs/#L213">View Source</a>
  360. </span>
  361. <a id="Terminal_Gui_ContextMenu_MenuBar_" data-uid="Terminal.Gui.ContextMenu.MenuBar*"></a>
  362. <h4 id="Terminal_Gui_ContextMenu_MenuBar" data-uid="Terminal.Gui.ContextMenu.MenuBar">MenuBar</h4>
  363. <div class="markdown level1 summary">
  364. Gets the <a class="xref" href="Terminal.Gui.MenuBar.html">MenuBar</a> that is hosting this context menu.
  365. </div>
  366. <div class="markdown level1 conceptual"></div>
  367. <h5 class="decalaration">Declaration</h5>
  368. <div class="codewrapper">
  369. <pre><code class="lang-csharp hljs">public MenuBar MenuBar { get; }</code></pre>
  370. </div>
  371. <h5 class="propertyValue">Property Value</h5>
  372. <table class="table table-bordered table-striped table-condensed">
  373. <thead>
  374. <tr>
  375. <th>Type</th>
  376. <th>Description</th>
  377. </tr>
  378. </thead>
  379. <tbody>
  380. <tr>
  381. <td><a class="xref" href="Terminal.Gui.MenuBar.html">MenuBar</a></td>
  382. <td></td>
  383. </tr>
  384. </tbody>
  385. </table>
  386. <span class="small pull-right mobile-hide">
  387. <span class="divider">|</span>
  388. <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/apidoc/new?filename=Terminal_Gui_ContextMenu_MenuItems.md&amp;value=---%0Auid%3A%20Terminal.Gui.ContextMenu.MenuItems%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>
  389. </span>
  390. <span class="small pull-right mobile-hide">
  391. <a href="tig:tig/gui.cs/blob/main/Terminal.Gui/Core/ContextMenu.cs/#L167">View Source</a>
  392. </span>
  393. <a id="Terminal_Gui_ContextMenu_MenuItems_" data-uid="Terminal.Gui.ContextMenu.MenuItems*"></a>
  394. <h4 id="Terminal_Gui_ContextMenu_MenuItems" data-uid="Terminal.Gui.ContextMenu.MenuItems">MenuItems</h4>
  395. <div class="markdown level1 summary">
  396. Gets or sets the menu items for this context menu.
  397. </div>
  398. <div class="markdown level1 conceptual"></div>
  399. <h5 class="decalaration">Declaration</h5>
  400. <div class="codewrapper">
  401. <pre><code class="lang-csharp hljs">public MenuBarItem MenuItems { get; set; }</code></pre>
  402. </div>
  403. <h5 class="propertyValue">Property Value</h5>
  404. <table class="table table-bordered table-striped table-condensed">
  405. <thead>
  406. <tr>
  407. <th>Type</th>
  408. <th>Description</th>
  409. </tr>
  410. </thead>
  411. <tbody>
  412. <tr>
  413. <td><a class="xref" href="Terminal.Gui.MenuBarItem.html">MenuBarItem</a></td>
  414. <td></td>
  415. </tr>
  416. </tbody>
  417. </table>
  418. <span class="small pull-right mobile-hide">
  419. <span class="divider">|</span>
  420. <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/apidoc/new?filename=Terminal_Gui_ContextMenu_MouseFlags.md&amp;value=---%0Auid%3A%20Terminal.Gui.ContextMenu.MouseFlags%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>
  421. </span>
  422. <span class="small pull-right mobile-hide">
  423. <a href="tig:tig/gui.cs/blob/main/Terminal.Gui/Core/ContextMenu.cs/#L184">View Source</a>
  424. </span>
  425. <a id="Terminal_Gui_ContextMenu_MouseFlags_" data-uid="Terminal.Gui.ContextMenu.MouseFlags*"></a>
  426. <h4 id="Terminal_Gui_ContextMenu_MouseFlags" data-uid="Terminal.Gui.ContextMenu.MouseFlags">MouseFlags</h4>
  427. <div class="markdown level1 summary">
  428. The <a class="xref" href="Terminal.Gui.MouseFlags.html">MouseFlags</a> used to activate the context menu by mouse.
  429. </div>
  430. <div class="markdown level1 conceptual"></div>
  431. <h5 class="decalaration">Declaration</h5>
  432. <div class="codewrapper">
  433. <pre><code class="lang-csharp hljs">public MouseFlags MouseFlags { get; set; }</code></pre>
  434. </div>
  435. <h5 class="propertyValue">Property Value</h5>
  436. <table class="table table-bordered table-striped table-condensed">
  437. <thead>
  438. <tr>
  439. <th>Type</th>
  440. <th>Description</th>
  441. </tr>
  442. </thead>
  443. <tbody>
  444. <tr>
  445. <td><a class="xref" href="Terminal.Gui.MouseFlags.html">MouseFlags</a></td>
  446. <td></td>
  447. </tr>
  448. </tbody>
  449. </table>
  450. <span class="small pull-right mobile-hide">
  451. <span class="divider">|</span>
  452. <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/apidoc/new?filename=Terminal_Gui_ContextMenu_Position.md&amp;value=---%0Auid%3A%20Terminal.Gui.ContextMenu.Position%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>
  453. </span>
  454. <span class="small pull-right mobile-hide">
  455. <a href="tig:tig/gui.cs/blob/main/Terminal.Gui/Core/ContextMenu.cs/#L162">View Source</a>
  456. </span>
  457. <a id="Terminal_Gui_ContextMenu_Position_" data-uid="Terminal.Gui.ContextMenu.Position*"></a>
  458. <h4 id="Terminal_Gui_ContextMenu_Position" data-uid="Terminal.Gui.ContextMenu.Position">Position</h4>
  459. <div class="markdown level1 summary">
  460. Gets or set the menu position.
  461. </div>
  462. <div class="markdown level1 conceptual"></div>
  463. <h5 class="decalaration">Declaration</h5>
  464. <div class="codewrapper">
  465. <pre><code class="lang-csharp hljs">public Point Position { get; set; }</code></pre>
  466. </div>
  467. <h5 class="propertyValue">Property Value</h5>
  468. <table class="table table-bordered table-striped table-condensed">
  469. <thead>
  470. <tr>
  471. <th>Type</th>
  472. <th>Description</th>
  473. </tr>
  474. </thead>
  475. <tbody>
  476. <tr>
  477. <td><a class="xref" href="Terminal.Gui.Point.html">Point</a></td>
  478. <td></td>
  479. </tr>
  480. </tbody>
  481. </table>
  482. <span class="small pull-right mobile-hide">
  483. <span class="divider">|</span>
  484. <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/apidoc/new?filename=Terminal_Gui_ContextMenu_UseSubMenusSingleFrame.md&amp;value=---%0Auid%3A%20Terminal.Gui.ContextMenu.UseSubMenusSingleFrame%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>
  485. </span>
  486. <span class="small pull-right mobile-hide">
  487. <a href="tig:tig/gui.cs/blob/main/Terminal.Gui/Core/ContextMenu.cs/#L218">View Source</a>
  488. </span>
  489. <a id="Terminal_Gui_ContextMenu_UseSubMenusSingleFrame_" data-uid="Terminal.Gui.ContextMenu.UseSubMenusSingleFrame*"></a>
  490. <h4 id="Terminal_Gui_ContextMenu_UseSubMenusSingleFrame" data-uid="Terminal.Gui.ContextMenu.UseSubMenusSingleFrame">UseSubMenusSingleFrame</h4>
  491. <div class="markdown level1 summary">
  492. Gets or sets if the sub-menus must be displayed in a single or multiple frames.
  493. </div>
  494. <div class="markdown level1 conceptual"></div>
  495. <h5 class="decalaration">Declaration</h5>
  496. <div class="codewrapper">
  497. <pre><code class="lang-csharp hljs">public bool UseSubMenusSingleFrame { get; set; }</code></pre>
  498. </div>
  499. <h5 class="propertyValue">Property Value</h5>
  500. <table class="table table-bordered table-striped table-condensed">
  501. <thead>
  502. <tr>
  503. <th>Type</th>
  504. <th>Description</th>
  505. </tr>
  506. </thead>
  507. <tbody>
  508. <tr>
  509. <td><span class="xref">System.Boolean</span></td>
  510. <td></td>
  511. </tr>
  512. </tbody>
  513. </table>
  514. <h3 id="methods">Methods
  515. </h3>
  516. <span class="small pull-right mobile-hide">
  517. <span class="divider">|</span>
  518. <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/apidoc/new?filename=Terminal_Gui_ContextMenu_Dispose.md&amp;value=---%0Auid%3A%20Terminal.Gui.ContextMenu.Dispose%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>
  519. </span>
  520. <span class="small pull-right mobile-hide">
  521. <a href="tig:tig/gui.cs/blob/main/Terminal.Gui/Core/ContextMenu.cs/#L53">View Source</a>
  522. </span>
  523. <a id="Terminal_Gui_ContextMenu_Dispose_" data-uid="Terminal.Gui.ContextMenu.Dispose*"></a>
  524. <h4 id="Terminal_Gui_ContextMenu_Dispose" data-uid="Terminal.Gui.ContextMenu.Dispose">Dispose()</h4>
  525. <div class="markdown level1 summary">
  526. Disposes the all the context menu objects instances.
  527. </div>
  528. <div class="markdown level1 conceptual"></div>
  529. <h5 class="decalaration">Declaration</h5>
  530. <div class="codewrapper">
  531. <pre><code class="lang-csharp hljs">public void Dispose()</code></pre>
  532. </div>
  533. <span class="small pull-right mobile-hide">
  534. <span class="divider">|</span>
  535. <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/apidoc/new?filename=Terminal_Gui_ContextMenu_Hide.md&amp;value=---%0Auid%3A%20Terminal.Gui.ContextMenu.Hide%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>
  536. </span>
  537. <span class="small pull-right mobile-hide">
  538. <a href="tig:tig/gui.cs/blob/main/Terminal.Gui/Core/ContextMenu.cs/#L143">View Source</a>
  539. </span>
  540. <a id="Terminal_Gui_ContextMenu_Hide_" data-uid="Terminal.Gui.ContextMenu.Hide*"></a>
  541. <h4 id="Terminal_Gui_ContextMenu_Hide" data-uid="Terminal.Gui.ContextMenu.Hide">Hide()</h4>
  542. <div class="markdown level1 summary">
  543. Close the <a class="xref" href="Terminal.Gui.ContextMenu.html#Terminal_Gui_ContextMenu_MenuItems">MenuItems</a> menu items.
  544. </div>
  545. <div class="markdown level1 conceptual"></div>
  546. <h5 class="decalaration">Declaration</h5>
  547. <div class="codewrapper">
  548. <pre><code class="lang-csharp hljs">public void Hide()</code></pre>
  549. </div>
  550. <span class="small pull-right mobile-hide">
  551. <span class="divider">|</span>
  552. <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/apidoc/new?filename=Terminal_Gui_ContextMenu_Show.md&amp;value=---%0Auid%3A%20Terminal.Gui.ContextMenu.Show%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>
  553. </span>
  554. <span class="small pull-right mobile-hide">
  555. <a href="tig:tig/gui.cs/blob/main/Terminal.Gui/Core/ContextMenu.cs/#L70">View Source</a>
  556. </span>
  557. <a id="Terminal_Gui_ContextMenu_Show_" data-uid="Terminal.Gui.ContextMenu.Show*"></a>
  558. <h4 id="Terminal_Gui_ContextMenu_Show" data-uid="Terminal.Gui.ContextMenu.Show">Show()</h4>
  559. <div class="markdown level1 summary">
  560. Open the <a class="xref" href="Terminal.Gui.ContextMenu.html#Terminal_Gui_ContextMenu_MenuItems">MenuItems</a> menu items.
  561. </div>
  562. <div class="markdown level1 conceptual"></div>
  563. <h5 class="decalaration">Declaration</h5>
  564. <div class="codewrapper">
  565. <pre><code class="lang-csharp hljs">public void Show()</code></pre>
  566. </div>
  567. <h3 id="events">Events
  568. </h3>
  569. <span class="small pull-right mobile-hide">
  570. <span class="divider">|</span>
  571. <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/apidoc/new?filename=Terminal_Gui_ContextMenu_KeyChanged.md&amp;value=---%0Auid%3A%20Terminal.Gui.ContextMenu.KeyChanged%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>
  572. </span>
  573. <span class="small pull-right mobile-hide">
  574. <a href="tig:tig/gui.cs/blob/main/Terminal.Gui/Core/ContextMenu.cs/#L152">View Source</a>
  575. </span>
  576. <h4 id="Terminal_Gui_ContextMenu_KeyChanged" data-uid="Terminal.Gui.ContextMenu.KeyChanged">KeyChanged</h4>
  577. <div class="markdown level1 summary">
  578. Event invoked when the <a class="xref" href="Terminal.Gui.ContextMenu.html#Terminal_Gui_ContextMenu_Key">Key</a> is changed.
  579. </div>
  580. <div class="markdown level1 conceptual"></div>
  581. <h5 class="decalaration">Declaration</h5>
  582. <div class="codewrapper">
  583. <pre><code class="lang-csharp hljs">public event Action&lt;Key&gt; KeyChanged</code></pre>
  584. </div>
  585. <h5 class="eventType">Event Type</h5>
  586. <table class="table table-bordered table-striped table-condensed">
  587. <thead>
  588. <tr>
  589. <th>Type</th>
  590. <th>Description</th>
  591. </tr>
  592. </thead>
  593. <tbody>
  594. <tr>
  595. <td><span class="xref">System.Action</span>&lt;<a class="xref" href="Terminal.Gui.Key.html">Key</a>&gt;</td>
  596. <td></td>
  597. </tr>
  598. </tbody>
  599. </table>
  600. <span class="small pull-right mobile-hide">
  601. <span class="divider">|</span>
  602. <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/apidoc/new?filename=Terminal_Gui_ContextMenu_MouseFlagsChanged.md&amp;value=---%0Auid%3A%20Terminal.Gui.ContextMenu.MouseFlagsChanged%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>
  603. </span>
  604. <span class="small pull-right mobile-hide">
  605. <a href="tig:tig/gui.cs/blob/main/Terminal.Gui/Core/ContextMenu.cs/#L157">View Source</a>
  606. </span>
  607. <h4 id="Terminal_Gui_ContextMenu_MouseFlagsChanged" data-uid="Terminal.Gui.ContextMenu.MouseFlagsChanged">MouseFlagsChanged</h4>
  608. <div class="markdown level1 summary">
  609. Event invoked when the <a class="xref" href="Terminal.Gui.ContextMenu.html#Terminal_Gui_ContextMenu_MouseFlags">MouseFlags</a> is changed.
  610. </div>
  611. <div class="markdown level1 conceptual"></div>
  612. <h5 class="decalaration">Declaration</h5>
  613. <div class="codewrapper">
  614. <pre><code class="lang-csharp hljs">public event Action&lt;MouseFlags&gt; MouseFlagsChanged</code></pre>
  615. </div>
  616. <h5 class="eventType">Event Type</h5>
  617. <table class="table table-bordered table-striped table-condensed">
  618. <thead>
  619. <tr>
  620. <th>Type</th>
  621. <th>Description</th>
  622. </tr>
  623. </thead>
  624. <tbody>
  625. <tr>
  626. <td><span class="xref">System.Action</span>&lt;<a class="xref" href="Terminal.Gui.MouseFlags.html">MouseFlags</a>&gt;</td>
  627. <td></td>
  628. </tr>
  629. </tbody>
  630. </table>
  631. <h3 id="implements">Implements</h3>
  632. <div>
  633. <span class="xref">System.IDisposable</span>
  634. </div>
  635. </article>
  636. </div>
  637. <div class="hidden-sm col-md-2" role="complementary">
  638. <div class="sideaffix">
  639. <div class="contribution">
  640. <ul class="nav">
  641. <li>
  642. <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/apidoc/new?filename=Terminal_Gui_ContextMenu.md&amp;value=---%0Auid%3A%20Terminal.Gui.ContextMenu%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>
  643. </li>
  644. <li>
  645. <a href="tig:tig/gui.cs/blob/main/Terminal.Gui/Core/ContextMenu.cs/#L8" class="contribution-link">View Source</a>
  646. </li>
  647. </ul>
  648. </div>
  649. <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
  650. <h5>In This Article</h5>
  651. <div></div>
  652. </nav>
  653. </div>
  654. </div>
  655. </div>
  656. </div>
  657. <footer>
  658. <div class="grad-bottom"></div>
  659. <div class="footer">
  660. <div class="container">
  661. <span class="pull-right">
  662. <a href="#top">Back to top</a>
  663. </span>
  664. <span>Generated by <strong>DocFX</strong></span>
  665. </div>
  666. </div>
  667. </footer>
  668. </div>
  669. <script type="text/javascript" src="../../styles/docfx.vendor.js"></script>
  670. <script type="text/javascript" src="../../styles/docfx.js"></script>
  671. <script type="text/javascript" src="../../styles/main.js"></script>
  672. </body>
  673. </html>