Terminal.Gui.Command.html 17 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452
  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>Enum Command
  8. </title>
  9. <meta name="viewport" content="width=device-width">
  10. <meta name="title" content="Enum Command
  11. ">
  12. <link rel="shortcut icon" href="../../favicon.ico">
  13. <link rel="stylesheet" href="../../styles/docfx.vendor.min.css">
  14. <link rel="stylesheet" href="../../styles/docfx.css">
  15. <link rel="stylesheet" href="../../styles/main.css">
  16. <meta property="docfx:navrel" content="../../toc.html">
  17. <meta property="docfx:tocrel" content="toc.html">
  18. <meta property="docfx:rel" content="../../">
  19. </head>
  20. <body data-spy="scroll" data-target="#affix" data-offset="120">
  21. <div id="wrapper">
  22. <header>
  23. <nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation">
  24. <div class="container">
  25. <div class="navbar-header">
  26. <button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
  27. <span class="sr-only">Toggle navigation</span>
  28. <span class="icon-bar"></span>
  29. <span class="icon-bar"></span>
  30. <span class="icon-bar"></span>
  31. </button>
  32. <a class="navbar-brand" href="../../index.html">
  33. <img id="logo" class="svg" src="../../images/logo48.png" alt="">
  34. </a>
  35. </div>
  36. <div class="collapse navbar-collapse" id="navbar">
  37. <form class="navbar-form navbar-right" role="search" id="search">
  38. <div class="form-group">
  39. <input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">
  40. </div>
  41. </form>
  42. </div>
  43. </div>
  44. </nav>
  45. <div class="subnav navbar navbar-default">
  46. <div class="container hide-when-search" id="breadcrumb">
  47. <ul class="breadcrumb">
  48. <li></li>
  49. </ul>
  50. </div>
  51. </div>
  52. </header>
  53. <div class="container body-content">
  54. <div id="search-results">
  55. <div class="search-list">Search Results for <span></span></div>
  56. <div class="sr-items">
  57. <p><i class="glyphicon glyphicon-refresh index-loading"></i></p>
  58. </div>
  59. <ul id="pagination" data-first="First" data-prev="Previous" data-next="Next" data-last="Last"></ul>
  60. </div>
  61. </div>
  62. <div role="main" class="container body-content hide-when-search">
  63. <div class="sidenav hide-when-search">
  64. <a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
  65. <div class="sidetoggle collapse" id="sidetoggle">
  66. <div id="sidetoc"></div>
  67. </div>
  68. </div>
  69. <div class="article row grid-right">
  70. <div class="col-md-10">
  71. <article class="content wrap" id="_content" data-uid="Terminal.Gui.Command">
  72. <h1 id="Terminal_Gui_Command" data-uid="Terminal.Gui.Command" class="text-break">Enum Command
  73. </h1>
  74. <div class="markdown level0 summary">Actions which can be performed by the application or bound to keys in a <a class="xref" href="Terminal.Gui.View.html">View</a> control.</div>
  75. <div class="markdown level0 conceptual"></div>
  76. <h6><strong>Namespace</strong>: <a class="xref" href="Terminal.html">Terminal</a>.<a class="xref" href="Terminal.Gui.html">Gui</a></h6>
  77. <h6><strong>Assembly</strong>: Terminal.Gui.dll</h6>
  78. <h5 id="Terminal_Gui_Command_syntax">Syntax</h5>
  79. <div class="codewrapper">
  80. <pre><code class="lang-csharp hljs">public enum Command</code></pre>
  81. </div>
  82. <h3 id="fields">Fields
  83. </h3>
  84. <table class="table table-bordered table-condensed">
  85. <thead>
  86. <tr>
  87. <th>Name</th>
  88. <th>Description</th>
  89. </tr>
  90. <thead>
  91. <tbody>
  92. <tr>
  93. <td id="Terminal_Gui_Command_Accept">Accept</td>
  94. <td>Accepts the current state (e.g. selection, button press etc).</td>
  95. </tr>
  96. <tr>
  97. <td id="Terminal_Gui_Command_BackTab">BackTab</td>
  98. <td>Tabs back to the previous item.</td>
  99. </tr>
  100. <tr>
  101. <td id="Terminal_Gui_Command_BottomEnd">BottomEnd</td>
  102. <td>Moves to the bottom/end.</td>
  103. </tr>
  104. <tr>
  105. <td id="Terminal_Gui_Command_BottomEndExtend">BottomEndExtend</td>
  106. <td>Extends the selection to the bottom/end.</td>
  107. </tr>
  108. <tr>
  109. <td id="Terminal_Gui_Command_Cancel">Cancel</td>
  110. <td>Cancels an action or any temporary states on the control e.g. expanding
  111. a combo list.</td>
  112. </tr>
  113. <tr>
  114. <td id="Terminal_Gui_Command_Collapse">Collapse</td>
  115. <td>Collapses a list or item (with subitems).</td>
  116. </tr>
  117. <tr>
  118. <td id="Terminal_Gui_Command_CollapseAll">CollapseAll</td>
  119. <td>Recursively collapses a list items of their children (if any).</td>
  120. </tr>
  121. <tr>
  122. <td id="Terminal_Gui_Command_Copy">Copy</td>
  123. <td>Copies the current selection.</td>
  124. </tr>
  125. <tr>
  126. <td id="Terminal_Gui_Command_Cut">Cut</td>
  127. <td>Cuts the current selection.</td>
  128. </tr>
  129. <tr>
  130. <td id="Terminal_Gui_Command_CutToEndLine">CutToEndLine</td>
  131. <td>Cuts to the clipboard the characters from the current position to the end of the line.</td>
  132. </tr>
  133. <tr>
  134. <td id="Terminal_Gui_Command_CutToStartLine">CutToStartLine</td>
  135. <td>Cuts to the clipboard the characters from the current position to the start of the line.</td>
  136. </tr>
  137. <tr>
  138. <td id="Terminal_Gui_Command_DeleteAll">DeleteAll</td>
  139. <td>Deletes all objects.</td>
  140. </tr>
  141. <tr>
  142. <td id="Terminal_Gui_Command_DeleteCharLeft">DeleteCharLeft</td>
  143. <td>Deletes the character on the left.</td>
  144. </tr>
  145. <tr>
  146. <td id="Terminal_Gui_Command_DeleteCharRight">DeleteCharRight</td>
  147. <td>Deletes the character on the right.</td>
  148. </tr>
  149. <tr>
  150. <td id="Terminal_Gui_Command_DisableOverwrite">DisableOverwrite</td>
  151. <td>Disables overwrite mode (<a class="xref" href="Terminal.Gui.Command.html#Terminal_Gui_Command_EnableOverwrite">EnableOverwrite</a>)</td>
  152. </tr>
  153. <tr>
  154. <td id="Terminal_Gui_Command_EnableOverwrite">EnableOverwrite</td>
  155. <td>Enables overwrite mode such that newly typed text overwrites the text that is
  156. already there (typically associated with the Insert key).</td>
  157. </tr>
  158. <tr>
  159. <td id="Terminal_Gui_Command_EndOfLine">EndOfLine</td>
  160. <td>Moves the cursor to the end of line.</td>
  161. </tr>
  162. <tr>
  163. <td id="Terminal_Gui_Command_EndOfLineExtend">EndOfLineExtend</td>
  164. <td>Extends the selection to the end of line.</td>
  165. </tr>
  166. <tr>
  167. <td id="Terminal_Gui_Command_EndOfPage">EndOfPage</td>
  168. <td>Moves the cursor to the bottom of page.</td>
  169. </tr>
  170. <tr>
  171. <td id="Terminal_Gui_Command_Expand">Expand</td>
  172. <td>Expands a list or item (with subitems).</td>
  173. </tr>
  174. <tr>
  175. <td id="Terminal_Gui_Command_ExpandAll">ExpandAll</td>
  176. <td>Recursively Expands all child items and their child items (if any).</td>
  177. </tr>
  178. <tr>
  179. <td id="Terminal_Gui_Command_KillWordBackwards">KillWordBackwards</td>
  180. <td>Deletes the characters backwards.</td>
  181. </tr>
  182. <tr>
  183. <td id="Terminal_Gui_Command_KillWordForwards">KillWordForwards</td>
  184. <td>Deletes the characters forwards.</td>
  185. </tr>
  186. <tr>
  187. <td id="Terminal_Gui_Command_Left">Left</td>
  188. <td>Moves the selection left one by the minimum increment supported by the <a class="xref" href="Terminal.Gui.View.html">View</a> e.g. single character, cell, item etc.</td>
  189. </tr>
  190. <tr>
  191. <td id="Terminal_Gui_Command_LeftExtend">LeftExtend</td>
  192. <td>Extends the selection left one by the minimum increment supported by the view e.g. single character, cell, item etc.</td>
  193. </tr>
  194. <tr>
  195. <td id="Terminal_Gui_Command_LeftHome">LeftHome</td>
  196. <td>Moves to the left begin.</td>
  197. </tr>
  198. <tr>
  199. <td id="Terminal_Gui_Command_LeftHomeExtend">LeftHomeExtend</td>
  200. <td>Extends the selection to the left begin.</td>
  201. </tr>
  202. <tr>
  203. <td id="Terminal_Gui_Command_LineDown">LineDown</td>
  204. <td>Moves down one item (cell, line, etc...).</td>
  205. </tr>
  206. <tr>
  207. <td id="Terminal_Gui_Command_LineDownExtend">LineDownExtend</td>
  208. <td>Extends the selection down one (cell, line, etc...).</td>
  209. </tr>
  210. <tr>
  211. <td id="Terminal_Gui_Command_LineDownToLastBranch">LineDownToLastBranch</td>
  212. <td>Moves down to the last child node of the branch that holds the current selection.</td>
  213. </tr>
  214. <tr>
  215. <td id="Terminal_Gui_Command_LineUp">LineUp</td>
  216. <td>Moves up one (cell, line, etc...).</td>
  217. </tr>
  218. <tr>
  219. <td id="Terminal_Gui_Command_LineUpExtend">LineUpExtend</td>
  220. <td>Extends the selection up one item (cell, line, etc...).</td>
  221. </tr>
  222. <tr>
  223. <td id="Terminal_Gui_Command_LineUpToFirstBranch">LineUpToFirstBranch</td>
  224. <td>Moves up to the first child node of the branch that holds the current selection.</td>
  225. </tr>
  226. <tr>
  227. <td id="Terminal_Gui_Command_NewLine">NewLine</td>
  228. <td>Inserts a new item.</td>
  229. </tr>
  230. <tr>
  231. <td id="Terminal_Gui_Command_NextView">NextView</td>
  232. <td>Moves focus to the next view.</td>
  233. </tr>
  234. <tr>
  235. <td id="Terminal_Gui_Command_NextViewOrTop">NextViewOrTop</td>
  236. <td>Moves focus to the next view or toplevel (case of MDI).</td>
  237. </tr>
  238. <tr>
  239. <td id="Terminal_Gui_Command_OpenSelectedItem">OpenSelectedItem</td>
  240. <td>Open the selected item.</td>
  241. </tr>
  242. <tr>
  243. <td id="Terminal_Gui_Command_PageDown">PageDown</td>
  244. <td>Move one page down.</td>
  245. </tr>
  246. <tr>
  247. <td id="Terminal_Gui_Command_PageDownExtend">PageDownExtend</td>
  248. <td>Move one page page extending the selection to cover revealed objects/characters.</td>
  249. </tr>
  250. <tr>
  251. <td id="Terminal_Gui_Command_PageLeft">PageLeft</td>
  252. <td>Moves to the left page.</td>
  253. </tr>
  254. <tr>
  255. <td id="Terminal_Gui_Command_PageRight">PageRight</td>
  256. <td>Moves to the right page.</td>
  257. </tr>
  258. <tr>
  259. <td id="Terminal_Gui_Command_PageUp">PageUp</td>
  260. <td>Move one page up.</td>
  261. </tr>
  262. <tr>
  263. <td id="Terminal_Gui_Command_PageUpExtend">PageUpExtend</td>
  264. <td>Move one page up extending the selection to cover revealed objects/characters.</td>
  265. </tr>
  266. <tr>
  267. <td id="Terminal_Gui_Command_Paste">Paste</td>
  268. <td>Pastes the current selection.</td>
  269. </tr>
  270. <tr>
  271. <td id="Terminal_Gui_Command_PreviousView">PreviousView</td>
  272. <td>Moves focuss to the previous view.</td>
  273. </tr>
  274. <tr>
  275. <td id="Terminal_Gui_Command_PreviousViewOrTop">PreviousViewOrTop</td>
  276. <td>Moves focus to the next previous or toplevel (case of MDI).</td>
  277. </tr>
  278. <tr>
  279. <td id="Terminal_Gui_Command_QuitToplevel">QuitToplevel</td>
  280. <td>Quit a <a class="xref" href="Terminal.Gui.Toplevel.html">Toplevel</a>.</td>
  281. </tr>
  282. <tr>
  283. <td id="Terminal_Gui_Command_Redo">Redo</td>
  284. <td>Redo changes.</td>
  285. </tr>
  286. <tr>
  287. <td id="Terminal_Gui_Command_Refresh">Refresh</td>
  288. <td>Refresh.</td>
  289. </tr>
  290. <tr>
  291. <td id="Terminal_Gui_Command_Right">Right</td>
  292. <td>Moves the selection right one by the minimum increment supported by the view e.g. single character, cell, item etc.</td>
  293. </tr>
  294. <tr>
  295. <td id="Terminal_Gui_Command_RightEnd">RightEnd</td>
  296. <td>Moves to the right end.</td>
  297. </tr>
  298. <tr>
  299. <td id="Terminal_Gui_Command_RightEndExtend">RightEndExtend</td>
  300. <td>Extends the selection to the right end.</td>
  301. </tr>
  302. <tr>
  303. <td id="Terminal_Gui_Command_RightExtend">RightExtend</td>
  304. <td>Extends the selection right one by the minimum increment supported by the view e.g. single character, cell, item etc.</td>
  305. </tr>
  306. <tr>
  307. <td id="Terminal_Gui_Command_ScrollDown">ScrollDown</td>
  308. <td>Scrolls down one (cell, line, etc...) (without changing the selection).</td>
  309. </tr>
  310. <tr>
  311. <td id="Terminal_Gui_Command_ScrollLeft">ScrollLeft</td>
  312. <td>Scrolls one item (cell, character, etc...) to the left</td>
  313. </tr>
  314. <tr>
  315. <td id="Terminal_Gui_Command_ScrollRight">ScrollRight</td>
  316. <td>Scrolls one item (cell, character, etc...) to the right.</td>
  317. </tr>
  318. <tr>
  319. <td id="Terminal_Gui_Command_ScrollUp">ScrollUp</td>
  320. <td>Scrolls up one item (cell, line, etc...) (without changing the selection).</td>
  321. </tr>
  322. <tr>
  323. <td id="Terminal_Gui_Command_SelectAll">SelectAll</td>
  324. <td>Selects all objects.</td>
  325. </tr>
  326. <tr>
  327. <td id="Terminal_Gui_Command_StartOfLine">StartOfLine</td>
  328. <td>Moves the cursor to the start of line.</td>
  329. </tr>
  330. <tr>
  331. <td id="Terminal_Gui_Command_StartOfLineExtend">StartOfLineExtend</td>
  332. <td>Extends the selection to the start of line.</td>
  333. </tr>
  334. <tr>
  335. <td id="Terminal_Gui_Command_StartOfPage">StartOfPage</td>
  336. <td>Moves the cursor to the top of page.</td>
  337. </tr>
  338. <tr>
  339. <td id="Terminal_Gui_Command_Suspend">Suspend</td>
  340. <td>Suspend a application (used on Linux).</td>
  341. </tr>
  342. <tr>
  343. <td id="Terminal_Gui_Command_Tab">Tab</td>
  344. <td>Tabs to the next item.</td>
  345. </tr>
  346. <tr>
  347. <td id="Terminal_Gui_Command_ToggleChecked">ToggleChecked</td>
  348. <td>Toggle the checked state.</td>
  349. </tr>
  350. <tr>
  351. <td id="Terminal_Gui_Command_ToggleExpandCollapse">ToggleExpandCollapse</td>
  352. <td>Toggles the Expanded or collapsed state of a a list or item (with subitems).</td>
  353. </tr>
  354. <tr>
  355. <td id="Terminal_Gui_Command_ToggleExtend">ToggleExtend</td>
  356. <td>Toggles the selection.</td>
  357. </tr>
  358. <tr>
  359. <td id="Terminal_Gui_Command_ToggleOverwrite">ToggleOverwrite</td>
  360. <td>Toggles overwrite mode such that newly typed text overwrites the text that is
  361. already there (typically associated with the Insert key).</td>
  362. </tr>
  363. <tr>
  364. <td id="Terminal_Gui_Command_TopHome">TopHome</td>
  365. <td>Moves to the top/home.</td>
  366. </tr>
  367. <tr>
  368. <td id="Terminal_Gui_Command_TopHomeExtend">TopHomeExtend</td>
  369. <td>Extends the selection to the top/home.</td>
  370. </tr>
  371. <tr>
  372. <td id="Terminal_Gui_Command_Undo">Undo</td>
  373. <td>Undo changes.</td>
  374. </tr>
  375. <tr>
  376. <td id="Terminal_Gui_Command_UnixEmulation">UnixEmulation</td>
  377. <td>Unix emulation.</td>
  378. </tr>
  379. <tr>
  380. <td id="Terminal_Gui_Command_WordLeft">WordLeft</td>
  381. <td>Moves the caret to the start of the previous word.</td>
  382. </tr>
  383. <tr>
  384. <td id="Terminal_Gui_Command_WordLeftExtend">WordLeftExtend</td>
  385. <td>Extends the selection to the start of the previous word.</td>
  386. </tr>
  387. <tr>
  388. <td id="Terminal_Gui_Command_WordRight">WordRight</td>
  389. <td>Moves the caret to the start of the next word.</td>
  390. </tr>
  391. <tr>
  392. <td id="Terminal_Gui_Command_WordRightExtend">WordRightExtend</td>
  393. <td>Extends the selection to the start of the next word.</td>
  394. </tr>
  395. </tbody>
  396. </thead></thead></table>
  397. </article>
  398. </div>
  399. <div class="hidden-sm col-md-2" role="complementary">
  400. <div class="sideaffix">
  401. <div class="contribution">
  402. <ul class="nav">
  403. <li>
  404. <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/docfx/overrides/new?filename=Terminal_Gui_Command.md&amp;value=---%0Auid%3A%20Terminal.Gui.Command%0Asummary%3A%20&#39;*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax&#39;%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A" class="contribution-link">Edit this page</a>
  405. </li>
  406. <li>
  407. <a href="tig:tig/Terminal.Gui/blob/v2_develop/Terminal.Gui/Core/Command.cs/#L10" class="contribution-link">View Source</a>
  408. </li>
  409. </ul>
  410. </div>
  411. <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
  412. <h5>In this article</h5>
  413. <div></div>
  414. </nav>
  415. </div>
  416. </div>
  417. </div>
  418. </div>
  419. <footer>
  420. <div class="grad-bottom"></div>
  421. <div class="footer">
  422. <div class="container">
  423. <span class="pull-right">
  424. <a href="#top">Back to top</a>
  425. </span>
  426. <span>Generated by <strong>DocFX</strong></span>
  427. </div>
  428. </div>
  429. </footer>
  430. </div>
  431. <script type="text/javascript" src="../../styles/docfx.vendor.min.js"></script>
  432. <script type="text/javascript" src="../../styles/docfx.js"></script>
  433. <script type="text/javascript" src="../../styles/main.js"></script>
  434. </body>
  435. </html>