Terminal.MenuItem.yml 6.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243
  1. ### YamlMime:ManagedReference
  2. items:
  3. - uid: Terminal.MenuItem
  4. id: MenuItem
  5. children:
  6. - Terminal.MenuItem.#ctor(System.String,System.String,System.Action)
  7. - Terminal.MenuItem.Action
  8. - Terminal.MenuItem.Help
  9. - Terminal.MenuItem.HotKey
  10. - Terminal.MenuItem.ShortCut
  11. - Terminal.MenuItem.Title
  12. langs:
  13. - csharp
  14. name: MenuItem
  15. nameWithType: MenuItem
  16. fullName: Terminal.MenuItem
  17. type: Class
  18. assemblies:
  19. - Terminal
  20. namespace: Terminal
  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.MenuItem.#ctor(System.String,System.String,System.Action)
  29. id: '#ctor(System.String,System.String,System.Action)'
  30. parent: Terminal.MenuItem
  31. langs:
  32. - csharp
  33. name: MenuItem(String, String, Action)
  34. nameWithType: MenuItem.MenuItem(String, String, Action)
  35. fullName: MenuItem.MenuItem(String, String, Action)
  36. type: Constructor
  37. assemblies:
  38. - Terminal
  39. namespace: Terminal
  40. summary: Initializes a new <xref href="Terminal.MenuItem"></xref>.
  41. syntax:
  42. content: public MenuItem (string title, string help, Action action);
  43. parameters:
  44. - id: title
  45. type: System.String
  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.MenuItem.#ctor*
  54. exceptions: []
  55. - uid: Terminal.MenuItem.Action
  56. id: Action
  57. parent: Terminal.MenuItem
  58. langs:
  59. - csharp
  60. name: Action
  61. nameWithType: MenuItem.Action
  62. fullName: MenuItem.Action
  63. type: Property
  64. assemblies:
  65. - Terminal
  66. namespace: Terminal
  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.MenuItem.Action*
  74. exceptions: []
  75. - uid: Terminal.MenuItem.Help
  76. id: Help
  77. parent: Terminal.MenuItem
  78. langs:
  79. - csharp
  80. name: Help
  81. nameWithType: MenuItem.Help
  82. fullName: MenuItem.Help
  83. type: Property
  84. assemblies:
  85. - Terminal
  86. namespace: Terminal
  87. summary: Gets or sets the help text for the menu item.
  88. syntax:
  89. content: public string Help { get; set; }
  90. return:
  91. type: System.String
  92. description: The help text.
  93. overload: Terminal.MenuItem.Help*
  94. exceptions: []
  95. - uid: Terminal.MenuItem.HotKey
  96. id: HotKey
  97. parent: Terminal.MenuItem
  98. langs:
  99. - csharp
  100. name: HotKey
  101. nameWithType: MenuItem.HotKey
  102. fullName: MenuItem.HotKey
  103. type: Field
  104. assemblies:
  105. - Terminal
  106. namespace: Terminal
  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 char HotKey;
  110. return:
  111. type: System.Char
  112. description: To be added.
  113. exceptions: []
  114. - uid: Terminal.MenuItem.ShortCut
  115. id: ShortCut
  116. parent: Terminal.MenuItem
  117. langs:
  118. - csharp
  119. name: ShortCut
  120. nameWithType: MenuItem.ShortCut
  121. fullName: MenuItem.ShortCut
  122. type: Field
  123. assemblies:
  124. - Terminal
  125. namespace: Terminal
  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.Key ShortCut;
  129. return:
  130. type: Terminal.Key
  131. description: To be added.
  132. exceptions: []
  133. - uid: Terminal.MenuItem.Title
  134. id: Title
  135. parent: Terminal.MenuItem
  136. langs:
  137. - csharp
  138. name: Title
  139. nameWithType: MenuItem.Title
  140. fullName: MenuItem.Title
  141. type: Property
  142. assemblies:
  143. - Terminal
  144. namespace: Terminal
  145. summary: Gets or sets the title.
  146. syntax:
  147. content: public string Title { get; set; }
  148. return:
  149. type: System.String
  150. description: The title.
  151. overload: Terminal.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.MenuItem.#ctor(System.String,System.String,System.Action)
  161. parent: Terminal.MenuItem
  162. isExternal: false
  163. name: MenuItem(String, String, Action)
  164. nameWithType: MenuItem.MenuItem(String, String, Action)
  165. fullName: MenuItem.MenuItem(String, String, Action)
  166. - uid: System.String
  167. parent: System
  168. isExternal: true
  169. name: String
  170. nameWithType: String
  171. fullName: System.String
  172. - uid: System.Action
  173. parent: System
  174. isExternal: true
  175. name: Action
  176. nameWithType: Action
  177. fullName: System.Action
  178. - uid: Terminal.MenuItem.Action
  179. parent: Terminal.MenuItem
  180. isExternal: false
  181. name: Action
  182. nameWithType: MenuItem.Action
  183. fullName: MenuItem.Action
  184. - uid: Terminal.MenuItem.Help
  185. parent: Terminal.MenuItem
  186. isExternal: false
  187. name: Help
  188. nameWithType: MenuItem.Help
  189. fullName: MenuItem.Help
  190. - uid: Terminal.MenuItem.HotKey
  191. parent: Terminal.MenuItem
  192. isExternal: false
  193. name: HotKey
  194. nameWithType: MenuItem.HotKey
  195. fullName: MenuItem.HotKey
  196. - uid: System.Char
  197. parent: System
  198. isExternal: true
  199. name: Char
  200. nameWithType: Char
  201. fullName: System.Char
  202. - uid: Terminal.MenuItem.ShortCut
  203. parent: Terminal.MenuItem
  204. isExternal: false
  205. name: ShortCut
  206. nameWithType: MenuItem.ShortCut
  207. fullName: MenuItem.ShortCut
  208. - uid: Terminal.Key
  209. parent: Terminal
  210. isExternal: false
  211. name: Key
  212. nameWithType: Key
  213. fullName: Terminal.Key
  214. - uid: Terminal.MenuItem.Title
  215. parent: Terminal.MenuItem
  216. isExternal: false
  217. name: Title
  218. nameWithType: MenuItem.Title
  219. fullName: MenuItem.Title
  220. - uid: Terminal.MenuItem.#ctor*
  221. parent: Terminal.MenuItem
  222. isExternal: false
  223. name: MenuItem
  224. nameWithType: MenuItem.MenuItem
  225. fullName: MenuItem.MenuItem
  226. - uid: Terminal.MenuItem.Action*
  227. parent: Terminal.MenuItem
  228. isExternal: false
  229. name: Action
  230. nameWithType: MenuItem.Action
  231. fullName: MenuItem.Action
  232. - uid: Terminal.MenuItem.Help*
  233. parent: Terminal.MenuItem
  234. isExternal: false
  235. name: Help
  236. nameWithType: MenuItem.Help
  237. fullName: MenuItem.Help
  238. - uid: Terminal.MenuItem.Title*
  239. parent: Terminal.MenuItem
  240. isExternal: false
  241. name: Title
  242. nameWithType: MenuItem.Title
  243. fullName: MenuItem.Title