Files
Terminal.Gui/docs/api/Terminal.Gui/Terminal.Gui.MenuBarItem.html
2020-05-23 19:39:15 -06:00

327 lines
13 KiB
HTML

<!DOCTYPE html>
<!--[if IE]><![endif]-->
<html>
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
<title>Class MenuBarItem
</title>
<meta name="viewport" content="width=device-width">
<meta name="title" content="Class MenuBarItem
">
<meta name="generator" content="docfx 2.53.1.0">
<link rel="shortcut icon" href="../../favicon.ico">
<link rel="stylesheet" href="../../styles/docfx.vendor.css">
<link rel="stylesheet" href="../../styles/docfx.css">
<link rel="stylesheet" href="../../styles/main.css">
<link href="https://fonts.googleapis.com/css?family=Roboto" rel="stylesheet">
<meta property="docfx:navrel" content="">
<meta property="docfx:tocrel" content="toc.html">
<meta property="docfx:rel" content="../../">
</head> <body data-spy="scroll" data-target="#affix" data-offset="120">
<div id="wrapper">
<header>
<nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation">
<div class="container">
<div class="navbar-header">
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<a class="navbar-brand" href="../../index.html">
<img id="logo" class="svg" src="../../images/logo48.png" alt="">
</a>
</div>
<div class="collapse navbar-collapse" id="navbar">
<form class="navbar-form navbar-right" role="search" id="search">
<div class="form-group">
<input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">
</div>
</form>
</div>
</div>
</nav>
<div class="subnav navbar navbar-default">
<div class="container hide-when-search" id="breadcrumb">
<ul class="breadcrumb">
<li></li>
</ul>
</div>
</div>
</header>
<div class="container body-content">
<div id="search-results">
<div class="search-list"></div>
<div class="sr-items">
<p><i class="glyphicon glyphicon-refresh index-loading"></i></p>
</div>
<ul id="pagination"></ul>
</div>
</div>
<div role="main" class="container body-content hide-when-search">
<div class="sidenav hide-when-search">
<a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
<div class="sidetoggle collapse" id="sidetoggle">
<div id="sidetoc"></div>
</div>
</div>
<div class="article row grid-right">
<div class="col-md-10">
<article class="content wrap" id="_content" data-uid="Terminal.Gui.MenuBarItem">
<h1 id="Terminal_Gui_MenuBarItem" data-uid="Terminal.Gui.MenuBarItem" class="text-break">Class MenuBarItem
</h1>
<div class="markdown level0 summary">
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.
</div>
<div class="markdown level0 conceptual"></div>
<div class="inheritance">
<h5>Inheritance</h5>
<div class="level0"><span class="xref">System.Object</span></div>
<div class="level1"><a class="xref" href="Terminal.Gui.MenuItem.html">MenuItem</a></div>
<div class="level2"><span class="xref">MenuBarItem</span></div>
</div>
<div class="inheritedMembers">
<h5>Inherited Members</h5>
<div>
<a class="xref" href="Terminal.Gui.MenuItem.html#Terminal_Gui_MenuItem_HotKey">MenuItem.HotKey</a>
</div>
<div>
<a class="xref" href="Terminal.Gui.MenuItem.html#Terminal_Gui_MenuItem_ShortCut">MenuItem.ShortCut</a>
</div>
<div>
<a class="xref" href="Terminal.Gui.MenuItem.html#Terminal_Gui_MenuItem_Title">MenuItem.Title</a>
</div>
<div>
<a class="xref" href="Terminal.Gui.MenuItem.html#Terminal_Gui_MenuItem_Help">MenuItem.Help</a>
</div>
<div>
<a class="xref" href="Terminal.Gui.MenuItem.html#Terminal_Gui_MenuItem_Action">MenuItem.Action</a>
</div>
<div>
<a class="xref" href="Terminal.Gui.MenuItem.html#Terminal_Gui_MenuItem_CanExecute">MenuItem.CanExecute</a>
</div>
<div>
<a class="xref" href="Terminal.Gui.MenuItem.html#Terminal_Gui_MenuItem_IsEnabled">MenuItem.IsEnabled()</a>
</div>
<div>
<a class="xref" href="Terminal.Gui.MenuItem.html#Terminal_Gui_MenuItem_GetMenuItem">MenuItem.GetMenuItem()</a>
</div>
<div>
<a class="xref" href="Terminal.Gui.MenuItem.html#Terminal_Gui_MenuItem_GetMenuBarItem">MenuItem.GetMenuBarItem()</a>
</div>
<div>
<span class="xref">System.Object.Equals(System.Object)</span>
</div>
<div>
<span class="xref">System.Object.Equals(System.Object, System.Object)</span>
</div>
<div>
<span class="xref">System.Object.GetHashCode()</span>
</div>
<div>
<span class="xref">System.Object.GetType()</span>
</div>
<div>
<span class="xref">System.Object.MemberwiseClone()</span>
</div>
<div>
<span class="xref">System.Object.ReferenceEquals(System.Object, System.Object)</span>
</div>
<div>
<span class="xref">System.Object.ToString()</span>
</div>
</div>
<h6><strong>Namespace</strong>: <a class="xref" href="Terminal.Gui.html">Terminal.Gui</a></h6>
<h6><strong>Assembly</strong>: Terminal.Gui.dll</h6>
<h5 id="Terminal_Gui_MenuBarItem_syntax">Syntax</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public class MenuBarItem : MenuItem</code></pre>
</div>
<h3 id="constructors">Constructors
</h3>
<a id="Terminal_Gui_MenuBarItem__ctor_" data-uid="Terminal.Gui.MenuBarItem.#ctor*"></a>
<h4 id="Terminal_Gui_MenuBarItem__ctor_NStack_ustring_System_String_System_Action_System_Func_System_Boolean__" data-uid="Terminal.Gui.MenuBarItem.#ctor(NStack.ustring,System.String,System.Action,System.Func{System.Boolean})">MenuBarItem(ustring, String, Action, Func&lt;Boolean&gt;)</h4>
<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>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public MenuBarItem(ustring title, string help, Action action, Func&lt;bool&gt; canExecute = null)</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">NStack.ustring</span></td>
<td><span class="parametername">title</span></td>
<td>Title for the menu item.</td>
</tr>
<tr>
<td><span class="xref">System.String</span></td>
<td><span class="parametername">help</span></td>
<td>Help text to display.</td>
</tr>
<tr>
<td><span class="xref">System.Action</span></td>
<td><span class="parametername">action</span></td>
<td>Action to invoke when the menu item is activated.</td>
</tr>
<tr>
<td><span class="xref">System.Func</span>&lt;<span class="xref">System.Boolean</span>&gt;</td>
<td><span class="parametername">canExecute</span></td>
<td>Function to determine if the action can currently be executred.</td>
</tr>
</tbody>
</table>
<a id="Terminal_Gui_MenuBarItem__ctor_" data-uid="Terminal.Gui.MenuBarItem.#ctor*"></a>
<h4 id="Terminal_Gui_MenuBarItem__ctor_NStack_ustring_Terminal_Gui_MenuItem___" data-uid="Terminal.Gui.MenuBarItem.#ctor(NStack.ustring,Terminal.Gui.MenuItem[])">MenuBarItem(ustring, MenuItem[])</h4>
<div class="markdown level1 summary">
Initializes a new <a class="xref" href="Terminal.Gui.MenuBarItem.html">MenuBarItem</a>.
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public MenuBarItem(ustring title, MenuItem[] children)</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">NStack.ustring</span></td>
<td><span class="parametername">title</span></td>
<td>Title for the menu item.</td>
</tr>
<tr>
<td><a class="xref" href="Terminal.Gui.MenuItem.html">MenuItem</a>[]</td>
<td><span class="parametername">children</span></td>
<td>The items in the current menu.</td>
</tr>
</tbody>
</table>
<a id="Terminal_Gui_MenuBarItem__ctor_" data-uid="Terminal.Gui.MenuBarItem.#ctor*"></a>
<h4 id="Terminal_Gui_MenuBarItem__ctor_Terminal_Gui_MenuItem___" data-uid="Terminal.Gui.MenuBarItem.#ctor(Terminal.Gui.MenuItem[])">MenuBarItem(MenuItem[])</h4>
<div class="markdown level1 summary">
Initializes a new <a class="xref" href="Terminal.Gui.MenuBarItem.html">MenuBarItem</a>.
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public MenuBarItem(MenuItem[] children)</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="Terminal.Gui.MenuItem.html">MenuItem</a>[]</td>
<td><span class="parametername">children</span></td>
<td>The items in the current menu.</td>
</tr>
</tbody>
</table>
<h3 id="properties">Properties
</h3>
<a id="Terminal_Gui_MenuBarItem_Children_" data-uid="Terminal.Gui.MenuBarItem.Children*"></a>
<h4 id="Terminal_Gui_MenuBarItem_Children" data-uid="Terminal.Gui.MenuBarItem.Children">Children</h4>
<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>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public MenuItem[] Children { get; set; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="Terminal.Gui.MenuItem.html">MenuItem</a>[]</td>
<td>The children.</td>
</tr>
</tbody>
</table>
</article>
</div>
<div class="hidden-sm col-md-2" role="complementary">
<div class="sideaffix">
<div class="contribution">
<ul class="nav">
</ul>
</div>
<nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
<!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
</nav>
</div>
</div>
</div>
</div>
<footer>
<div class="grad-bottom"></div>
<div class="footer">
<div class="container">
<span class="pull-right">
<a href="#top">Back to top</a>
</span>
<span>Generated by <strong>DocFX</strong></span>
</div>
</div>
</footer>
</div>
<script type="text/javascript" src="../../styles/docfx.vendor.js"></script>
<script type="text/javascript" src="../../styles/docfx.js"></script>
<script type="text/javascript" src="../../styles/main.js"></script>
</body>
</html>