Files
Terminal.Gui/docfx/api/Terminal/Terminal.MenuItem.yml
Miguel de Icaza f3f32f6a24 Update docs
2018-01-15 23:17:12 -05:00

244 lines
6.3 KiB
YAML

### YamlMime:ManagedReference
items:
- uid: Terminal.MenuItem
id: MenuItem
children:
- Terminal.MenuItem.#ctor(System.String,System.String,System.Action)
- Terminal.MenuItem.Action
- Terminal.MenuItem.Help
- Terminal.MenuItem.HotKey
- Terminal.MenuItem.ShortCut
- Terminal.MenuItem.Title
langs:
- csharp
name: MenuItem
nameWithType: MenuItem
fullName: Terminal.MenuItem
type: Class
assemblies:
- Terminal
namespace: Terminal
summary: A menu item has a title, an associated help text, and an action to execute on activation.
syntax:
content: public class MenuItem
inheritance:
- System.Object
implements: []
inheritedMembers: []
- uid: Terminal.MenuItem.#ctor(System.String,System.String,System.Action)
id: '#ctor(System.String,System.String,System.Action)'
parent: Terminal.MenuItem
langs:
- csharp
name: MenuItem(String, String, Action)
nameWithType: MenuItem.MenuItem(String, String, Action)
fullName: MenuItem.MenuItem(String, String, Action)
type: Constructor
assemblies:
- Terminal
namespace: Terminal
summary: Initializes a new <xref href="Terminal.MenuItem"></xref>.
syntax:
content: public MenuItem (string title, string help, Action action);
parameters:
- id: title
type: System.String
description: Title for the menu item.
- id: help
type: System.String
description: Help text to display.
- id: action
type: System.Action
description: Action to invoke when the menu item is activated.
overload: Terminal.MenuItem.#ctor*
exceptions: []
- uid: Terminal.MenuItem.Action
id: Action
parent: Terminal.MenuItem
langs:
- csharp
name: Action
nameWithType: MenuItem.Action
fullName: MenuItem.Action
type: Property
assemblies:
- Terminal
namespace: Terminal
summary: Gets or sets the action to be invoked when the menu is triggered
syntax:
content: public Action Action { get; set; }
return:
type: System.Action
description: Method to invoke.
overload: Terminal.MenuItem.Action*
exceptions: []
- uid: Terminal.MenuItem.Help
id: Help
parent: Terminal.MenuItem
langs:
- csharp
name: Help
nameWithType: MenuItem.Help
fullName: MenuItem.Help
type: Property
assemblies:
- Terminal
namespace: Terminal
summary: Gets or sets the help text for the menu item.
syntax:
content: public string Help { get; set; }
return:
type: System.String
description: The help text.
overload: Terminal.MenuItem.Help*
exceptions: []
- uid: Terminal.MenuItem.HotKey
id: HotKey
parent: Terminal.MenuItem
langs:
- csharp
name: HotKey
nameWithType: MenuItem.HotKey
fullName: MenuItem.HotKey
type: Field
assemblies:
- Terminal
namespace: Terminal
summary: "The hotkey is used when the menu is active, the shortcut can be triggered when the menu is not active. \n For example HotKey would be \"N\" when the File Menu is open (assuming there is a \"_New\" entry\n if the ShortCut is set to \"Control-N\", this would be a global hotkey that would trigger as well"
syntax:
content: public char HotKey;
return:
type: System.Char
description: To be added.
exceptions: []
- uid: Terminal.MenuItem.ShortCut
id: ShortCut
parent: Terminal.MenuItem
langs:
- csharp
name: ShortCut
nameWithType: MenuItem.ShortCut
fullName: MenuItem.ShortCut
type: Field
assemblies:
- Terminal
namespace: Terminal
summary: This is the global setting that can be used as a global shortcut to invoke the action on the menu.
syntax:
content: public Terminal.Key ShortCut;
return:
type: Terminal.Key
description: To be added.
exceptions: []
- uid: Terminal.MenuItem.Title
id: Title
parent: Terminal.MenuItem
langs:
- csharp
name: Title
nameWithType: MenuItem.Title
fullName: MenuItem.Title
type: Property
assemblies:
- Terminal
namespace: Terminal
summary: Gets or sets the title.
syntax:
content: public string Title { get; set; }
return:
type: System.String
description: The title.
overload: Terminal.MenuItem.Title*
exceptions: []
references:
- uid: System.Object
parent: System
isExternal: true
name: Object
nameWithType: Object
fullName: System.Object
- uid: Terminal.MenuItem.#ctor(System.String,System.String,System.Action)
parent: Terminal.MenuItem
isExternal: false
name: MenuItem(String, String, Action)
nameWithType: MenuItem.MenuItem(String, String, Action)
fullName: MenuItem.MenuItem(String, String, Action)
- uid: System.String
parent: System
isExternal: true
name: String
nameWithType: String
fullName: System.String
- uid: System.Action
parent: System
isExternal: true
name: Action
nameWithType: Action
fullName: System.Action
- uid: Terminal.MenuItem.Action
parent: Terminal.MenuItem
isExternal: false
name: Action
nameWithType: MenuItem.Action
fullName: MenuItem.Action
- uid: Terminal.MenuItem.Help
parent: Terminal.MenuItem
isExternal: false
name: Help
nameWithType: MenuItem.Help
fullName: MenuItem.Help
- uid: Terminal.MenuItem.HotKey
parent: Terminal.MenuItem
isExternal: false
name: HotKey
nameWithType: MenuItem.HotKey
fullName: MenuItem.HotKey
- uid: System.Char
parent: System
isExternal: true
name: Char
nameWithType: Char
fullName: System.Char
- uid: Terminal.MenuItem.ShortCut
parent: Terminal.MenuItem
isExternal: false
name: ShortCut
nameWithType: MenuItem.ShortCut
fullName: MenuItem.ShortCut
- uid: Terminal.Key
parent: Terminal
isExternal: false
name: Key
nameWithType: Key
fullName: Terminal.Key
- uid: Terminal.MenuItem.Title
parent: Terminal.MenuItem
isExternal: false
name: Title
nameWithType: MenuItem.Title
fullName: MenuItem.Title
- uid: Terminal.MenuItem.#ctor*
parent: Terminal.MenuItem
isExternal: false
name: MenuItem
nameWithType: MenuItem.MenuItem
fullName: MenuItem.MenuItem
- uid: Terminal.MenuItem.Action*
parent: Terminal.MenuItem
isExternal: false
name: Action
nameWithType: MenuItem.Action
fullName: MenuItem.Action
- uid: Terminal.MenuItem.Help*
parent: Terminal.MenuItem
isExternal: false
name: Help
nameWithType: MenuItem.Help
fullName: MenuItem.Help
- uid: Terminal.MenuItem.Title*
parent: Terminal.MenuItem
isExternal: false
name: Title
nameWithType: MenuItem.Title
fullName: MenuItem.Title