Terminal.Gui.MenuItem.yml 6.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249
  1. ### YamlMime:ManagedReference
  2. items:
  3. - uid: Terminal.Gui.MenuItem
  4. id: MenuItem
  5. children:
  6. - Terminal.Gui.MenuItem.#ctor(NStack.ustring,System.String,System.Action)
  7. - Terminal.Gui.MenuItem.Action
  8. - Terminal.Gui.MenuItem.Help
  9. - Terminal.Gui.MenuItem.HotKey
  10. - Terminal.Gui.MenuItem.ShortCut
  11. - Terminal.Gui.MenuItem.Title
  12. langs:
  13. - csharp
  14. name: MenuItem
  15. nameWithType: MenuItem
  16. fullName: Terminal.Gui.MenuItem
  17. type: Class
  18. assemblies:
  19. - Terminal.Gui
  20. namespace: Terminal.Gui
  21. summary: A menu item has a title, an associated help text, and an action to execute on activation.
  22. syntax:
  23. content: public class MenuItem
  24. inheritance:
  25. - System.Object
  26. implements: []
  27. inheritedMembers: []
  28. - uid: Terminal.Gui.MenuItem.#ctor(NStack.ustring,System.String,System.Action)
  29. id: '#ctor(NStack.ustring,System.String,System.Action)'
  30. parent: Terminal.Gui.MenuItem
  31. langs:
  32. - csharp
  33. name: MenuItem(ustring, String, Action)
  34. nameWithType: MenuItem.MenuItem(ustring, String, Action)
  35. fullName: MenuItem.MenuItem(ustring, String, Action)
  36. type: Constructor
  37. assemblies:
  38. - Terminal.Gui
  39. namespace: Terminal.Gui
  40. summary: Initializes a new <xref href="Terminal.Gui.MenuItem"></xref>.
  41. syntax:
  42. content: public MenuItem (NStack.ustring title, string help, Action action);
  43. parameters:
  44. - id: title
  45. type: NStack.ustring
  46. description: Title for the menu item.
  47. - id: help
  48. type: System.String
  49. description: Help text to display.
  50. - id: action
  51. type: System.Action
  52. description: Action to invoke when the menu item is activated.
  53. overload: Terminal.Gui.MenuItem.#ctor*
  54. exceptions: []
  55. - uid: Terminal.Gui.MenuItem.Action
  56. id: Action
  57. parent: Terminal.Gui.MenuItem
  58. langs:
  59. - csharp
  60. name: Action
  61. nameWithType: MenuItem.Action
  62. fullName: MenuItem.Action
  63. type: Property
  64. assemblies:
  65. - Terminal.Gui
  66. namespace: Terminal.Gui
  67. summary: Gets or sets the action to be invoked when the menu is triggered
  68. syntax:
  69. content: public Action Action { get; set; }
  70. return:
  71. type: System.Action
  72. description: Method to invoke.
  73. overload: Terminal.Gui.MenuItem.Action*
  74. exceptions: []
  75. - uid: Terminal.Gui.MenuItem.Help
  76. id: Help
  77. parent: Terminal.Gui.MenuItem
  78. langs:
  79. - csharp
  80. name: Help
  81. nameWithType: MenuItem.Help
  82. fullName: MenuItem.Help
  83. type: Property
  84. assemblies:
  85. - Terminal.Gui
  86. namespace: Terminal.Gui
  87. summary: Gets or sets the help text for the menu item.
  88. syntax:
  89. content: public NStack.ustring Help { get; set; }
  90. return:
  91. type: NStack.ustring
  92. description: The help text.
  93. overload: Terminal.Gui.MenuItem.Help*
  94. exceptions: []
  95. - uid: Terminal.Gui.MenuItem.HotKey
  96. id: HotKey
  97. parent: Terminal.Gui.MenuItem
  98. langs:
  99. - csharp
  100. name: HotKey
  101. nameWithType: MenuItem.HotKey
  102. fullName: MenuItem.HotKey
  103. type: Field
  104. assemblies:
  105. - Terminal.Gui
  106. namespace: Terminal.Gui
  107. 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"
  108. syntax:
  109. content: public Rune HotKey;
  110. return:
  111. type: System.Rune
  112. description: To be added.
  113. exceptions: []
  114. - uid: Terminal.Gui.MenuItem.ShortCut
  115. id: ShortCut
  116. parent: Terminal.Gui.MenuItem
  117. langs:
  118. - csharp
  119. name: ShortCut
  120. nameWithType: MenuItem.ShortCut
  121. fullName: MenuItem.ShortCut
  122. type: Field
  123. assemblies:
  124. - Terminal.Gui
  125. namespace: Terminal.Gui
  126. summary: This is the global setting that can be used as a global shortcut to invoke the action on the menu.
  127. syntax:
  128. content: public Terminal.Gui.Key ShortCut;
  129. return:
  130. type: Terminal.Gui.Key
  131. description: To be added.
  132. exceptions: []
  133. - uid: Terminal.Gui.MenuItem.Title
  134. id: Title
  135. parent: Terminal.Gui.MenuItem
  136. langs:
  137. - csharp
  138. name: Title
  139. nameWithType: MenuItem.Title
  140. fullName: MenuItem.Title
  141. type: Property
  142. assemblies:
  143. - Terminal.Gui
  144. namespace: Terminal.Gui
  145. summary: Gets or sets the title.
  146. syntax:
  147. content: public NStack.ustring Title { get; set; }
  148. return:
  149. type: NStack.ustring
  150. description: The title.
  151. overload: Terminal.Gui.MenuItem.Title*
  152. exceptions: []
  153. references:
  154. - uid: System.Object
  155. parent: System
  156. isExternal: true
  157. name: Object
  158. nameWithType: Object
  159. fullName: System.Object
  160. - uid: Terminal.Gui.MenuItem.#ctor(NStack.ustring,System.String,System.Action)
  161. parent: Terminal.Gui.MenuItem
  162. isExternal: false
  163. name: MenuItem(ustring, String, Action)
  164. nameWithType: MenuItem.MenuItem(ustring, String, Action)
  165. fullName: MenuItem.MenuItem(ustring, String, Action)
  166. - uid: NStack.ustring
  167. parent: NStack
  168. isExternal: true
  169. name: ustring
  170. nameWithType: ustring
  171. fullName: NStack.ustring
  172. - uid: System.String
  173. parent: System
  174. isExternal: true
  175. name: String
  176. nameWithType: String
  177. fullName: System.String
  178. - uid: System.Action
  179. parent: System
  180. isExternal: true
  181. name: Action
  182. nameWithType: Action
  183. fullName: System.Action
  184. - uid: Terminal.Gui.MenuItem.Action
  185. parent: Terminal.Gui.MenuItem
  186. isExternal: false
  187. name: Action
  188. nameWithType: MenuItem.Action
  189. fullName: MenuItem.Action
  190. - uid: Terminal.Gui.MenuItem.Help
  191. parent: Terminal.Gui.MenuItem
  192. isExternal: false
  193. name: Help
  194. nameWithType: MenuItem.Help
  195. fullName: MenuItem.Help
  196. - uid: Terminal.Gui.MenuItem.HotKey
  197. parent: Terminal.Gui.MenuItem
  198. isExternal: false
  199. name: HotKey
  200. nameWithType: MenuItem.HotKey
  201. fullName: MenuItem.HotKey
  202. - uid: System.Rune
  203. parent: System
  204. isExternal: true
  205. name: Rune
  206. nameWithType: Rune
  207. fullName: System.Rune
  208. - uid: Terminal.Gui.MenuItem.ShortCut
  209. parent: Terminal.Gui.MenuItem
  210. isExternal: false
  211. name: ShortCut
  212. nameWithType: MenuItem.ShortCut
  213. fullName: MenuItem.ShortCut
  214. - uid: Terminal.Gui.Key
  215. parent: Terminal.Gui
  216. isExternal: false
  217. name: Key
  218. nameWithType: Key
  219. fullName: Terminal.Gui.Key
  220. - uid: Terminal.Gui.MenuItem.Title
  221. parent: Terminal.Gui.MenuItem
  222. isExternal: false
  223. name: Title
  224. nameWithType: MenuItem.Title
  225. fullName: MenuItem.Title
  226. - uid: Terminal.Gui.MenuItem.#ctor*
  227. parent: Terminal.Gui.MenuItem
  228. isExternal: false
  229. name: MenuItem
  230. nameWithType: MenuItem.MenuItem
  231. fullName: MenuItem.MenuItem
  232. - uid: Terminal.Gui.MenuItem.Action*
  233. parent: Terminal.Gui.MenuItem
  234. isExternal: false
  235. name: Action
  236. nameWithType: MenuItem.Action
  237. fullName: MenuItem.Action
  238. - uid: Terminal.Gui.MenuItem.Help*
  239. parent: Terminal.Gui.MenuItem
  240. isExternal: false
  241. name: Help
  242. nameWithType: MenuItem.Help
  243. fullName: MenuItem.Help
  244. - uid: Terminal.Gui.MenuItem.Title*
  245. parent: Terminal.Gui.MenuItem
  246. isExternal: false
  247. name: Title
  248. nameWithType: MenuItem.Title
  249. fullName: MenuItem.Title