Terminal.Gui.Command.html 17 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593
  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. <meta name="generator" content="docfx 2.59.2.0">
  13. <link rel="shortcut icon" href="../../favicon.ico">
  14. <link rel="stylesheet" href="../../styles/docfx.vendor.css">
  15. <link rel="stylesheet" href="../../styles/docfx.css">
  16. <link rel="stylesheet" href="../../styles/main.css">
  17. <meta property="docfx:navrel" content="../../toc.html">
  18. <meta property="docfx:tocrel" content="toc.html">
  19. <meta property="docfx:rel" content="../../">
  20. </head>
  21. <body data-spy="scroll" data-target="#affix" data-offset="120">
  22. <div id="wrapper">
  23. <header>
  24. <nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation">
  25. <div class="container">
  26. <div class="navbar-header">
  27. <button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
  28. <span class="sr-only">Toggle navigation</span>
  29. <span class="icon-bar"></span>
  30. <span class="icon-bar"></span>
  31. <span class="icon-bar"></span>
  32. </button>
  33. <a class="navbar-brand" href="../../index.html">
  34. <img id="logo" class="svg" src="../../images/logo48.png" alt="">
  35. </a>
  36. </div>
  37. <div class="collapse navbar-collapse" id="navbar">
  38. <form class="navbar-form navbar-right" role="search" id="search">
  39. <div class="form-group">
  40. <input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">
  41. </div>
  42. </form>
  43. </div>
  44. </div>
  45. </nav>
  46. <div class="subnav navbar navbar-default">
  47. <div class="container hide-when-search" id="breadcrumb">
  48. <ul class="breadcrumb">
  49. <li></li>
  50. </ul>
  51. </div>
  52. </div>
  53. </header>
  54. <div class="container body-content">
  55. <div id="search-results">
  56. <div class="search-list">Search Results for <span></span></div>
  57. <div class="sr-items">
  58. <p><i class="glyphicon glyphicon-refresh index-loading"></i></p>
  59. </div>
  60. <ul id="pagination" data-first="First" data-prev="Previous" data-next="Next" data-last="Last"></ul>
  61. </div>
  62. </div>
  63. <div role="main" class="container body-content hide-when-search">
  64. <div class="sidenav hide-when-search">
  65. <a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
  66. <div class="sidetoggle collapse" id="sidetoggle">
  67. <div id="sidetoc"></div>
  68. </div>
  69. </div>
  70. <div class="article row grid-right">
  71. <div class="col-md-10">
  72. <article class="content wrap" id="_content" data-uid="Terminal.Gui.Command">
  73. <h1 id="Terminal_Gui_Command" data-uid="Terminal.Gui.Command" class="text-break">Enum Command
  74. </h1>
  75. <div class="markdown level0 summary">
  76. 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.
  77. </div>
  78. <div class="markdown level0 conceptual"></div>
  79. <h6><strong>Namespace</strong>: <a class="xref" href="Terminal.Gui.html">Terminal.Gui</a></h6>
  80. <h6><strong>Assembly</strong>: Terminal.Gui.dll</h6>
  81. <h5 id="Terminal_Gui_Command_syntax">Syntax</h5>
  82. <div class="codewrapper">
  83. <pre><code class="lang-csharp hljs">public enum Command</code></pre>
  84. </div>
  85. <h3 id="fields">Fields
  86. </h3>
  87. <table class="table table-bordered table-striped table-condensed">
  88. <thead>
  89. <tr>
  90. <th>Name</th>
  91. <th>Description</th>
  92. </tr>
  93. <thead>
  94. <tbody>
  95. <tr>
  96. <td id="Terminal_Gui_Command_Accept">Accept</td>
  97. <td>
  98. Accepts the current state (e.g. selection, button press etc)
  99. </td>
  100. </tr>
  101. <tr>
  102. <td id="Terminal_Gui_Command_BackTab">BackTab</td>
  103. <td>
  104. Inserts a shift tab.
  105. </td>
  106. </tr>
  107. <tr>
  108. <td id="Terminal_Gui_Command_BottomEnd">BottomEnd</td>
  109. <td>
  110. Moves to bottom end.
  111. </td>
  112. </tr>
  113. <tr>
  114. <td id="Terminal_Gui_Command_BottomEndExtend">BottomEndExtend</td>
  115. <td>
  116. Extends the selection to the bottom end.
  117. </td>
  118. </tr>
  119. <tr>
  120. <td id="Terminal_Gui_Command_Cancel">Cancel</td>
  121. <td>
  122. Cancels any current temporary states on the control e.g. expanding
  123. a combo list
  124. </td>
  125. </tr>
  126. <tr>
  127. <td id="Terminal_Gui_Command_Collapse">Collapse</td>
  128. <td>
  129. Collapses a list or item (with subitems)
  130. </td>
  131. </tr>
  132. <tr>
  133. <td id="Terminal_Gui_Command_CollapseAll">CollapseAll</td>
  134. <td>
  135. Recursively collapses a list items of their children (if any)
  136. </td>
  137. </tr>
  138. <tr>
  139. <td id="Terminal_Gui_Command_Copy">Copy</td>
  140. <td>
  141. Copies the current selection.
  142. </td>
  143. </tr>
  144. <tr>
  145. <td id="Terminal_Gui_Command_Cut">Cut</td>
  146. <td>
  147. Cuts the current selection.
  148. </td>
  149. </tr>
  150. <tr>
  151. <td id="Terminal_Gui_Command_CutToEndLine">CutToEndLine</td>
  152. <td>
  153. Deletes and copies to the clipboard the characters from the current position to the end of the line.
  154. </td>
  155. </tr>
  156. <tr>
  157. <td id="Terminal_Gui_Command_CutToStartLine">CutToStartLine</td>
  158. <td>
  159. Deletes and copies to the clipboard the characters from the current position to the start of the line.
  160. </td>
  161. </tr>
  162. <tr>
  163. <td id="Terminal_Gui_Command_DeleteAll">DeleteAll</td>
  164. <td>
  165. Deletes all objects in the control.
  166. </td>
  167. </tr>
  168. <tr>
  169. <td id="Terminal_Gui_Command_DeleteCharLeft">DeleteCharLeft</td>
  170. <td>
  171. Deletes the character on the left.
  172. </td>
  173. </tr>
  174. <tr>
  175. <td id="Terminal_Gui_Command_DeleteCharRight">DeleteCharRight</td>
  176. <td>
  177. Deletes the character on the right.
  178. </td>
  179. </tr>
  180. <tr>
  181. <td id="Terminal_Gui_Command_DisableOverwrite">DisableOverwrite</td>
  182. <td>
  183. Disables overwrite mode (<a class="xref" href="Terminal.Gui.Command.html#Terminal_Gui_Command_EnableOverwrite">EnableOverwrite</a>)
  184. </td>
  185. </tr>
  186. <tr>
  187. <td id="Terminal_Gui_Command_EnableOverwrite">EnableOverwrite</td>
  188. <td>
  189. Enables overwrite mode such that newly typed text overwrites the text that is
  190. already there (typically associated with the Insert key).
  191. </td>
  192. </tr>
  193. <tr>
  194. <td id="Terminal_Gui_Command_EndOfLine">EndOfLine</td>
  195. <td>
  196. Moves the cursor to the end of line.
  197. </td>
  198. </tr>
  199. <tr>
  200. <td id="Terminal_Gui_Command_EndOfLineExtend">EndOfLineExtend</td>
  201. <td>
  202. Extends the selection to the end of line.
  203. </td>
  204. </tr>
  205. <tr>
  206. <td id="Terminal_Gui_Command_EndOfPage">EndOfPage</td>
  207. <td>
  208. Moves the cursor to the bottom of page.
  209. </td>
  210. </tr>
  211. <tr>
  212. <td id="Terminal_Gui_Command_Expand">Expand</td>
  213. <td>
  214. Expands a list or item (with subitems)
  215. </td>
  216. </tr>
  217. <tr>
  218. <td id="Terminal_Gui_Command_ExpandAll">ExpandAll</td>
  219. <td>
  220. Recursively Expands all child items and their child items (if any)
  221. </td>
  222. </tr>
  223. <tr>
  224. <td id="Terminal_Gui_Command_KillWordBackwards">KillWordBackwards</td>
  225. <td>
  226. Deletes the characters backwards.
  227. </td>
  228. </tr>
  229. <tr>
  230. <td id="Terminal_Gui_Command_KillWordForwards">KillWordForwards</td>
  231. <td>
  232. Deletes the characters forwards.
  233. </td>
  234. </tr>
  235. <tr>
  236. <td id="Terminal_Gui_Command_Left">Left</td>
  237. <td>
  238. Moves the selection left one by the minimum increment supported by the view e.g. single character, cell, item etc.
  239. </td>
  240. </tr>
  241. <tr>
  242. <td id="Terminal_Gui_Command_LeftExtend">LeftExtend</td>
  243. <td>
  244. Extends the selection left one by the minimum increment supported by the view e.g. single character, cell, item etc.
  245. </td>
  246. </tr>
  247. <tr>
  248. <td id="Terminal_Gui_Command_LeftHome">LeftHome</td>
  249. <td>
  250. Moves to the left begin.
  251. </td>
  252. </tr>
  253. <tr>
  254. <td id="Terminal_Gui_Command_LeftHomeExtend">LeftHomeExtend</td>
  255. <td>
  256. Extends the selection to the left begin.
  257. </td>
  258. </tr>
  259. <tr>
  260. <td id="Terminal_Gui_Command_LineDown">LineDown</td>
  261. <td>
  262. Moves the caret down one line.
  263. </td>
  264. </tr>
  265. <tr>
  266. <td id="Terminal_Gui_Command_LineDownExtend">LineDownExtend</td>
  267. <td>
  268. Extends the selection down one line.
  269. </td>
  270. </tr>
  271. <tr>
  272. <td id="Terminal_Gui_Command_LineDownToLastBranch">LineDownToLastBranch</td>
  273. <td>
  274. Moves the caret down to the last child node of the branch that holds the current selection
  275. </td>
  276. </tr>
  277. <tr>
  278. <td id="Terminal_Gui_Command_LineUp">LineUp</td>
  279. <td>
  280. Moves the caret up one line.
  281. </td>
  282. </tr>
  283. <tr>
  284. <td id="Terminal_Gui_Command_LineUpExtend">LineUpExtend</td>
  285. <td>
  286. Extends the selection up one line.
  287. </td>
  288. </tr>
  289. <tr>
  290. <td id="Terminal_Gui_Command_LineUpToFirstBranch">LineUpToFirstBranch</td>
  291. <td>
  292. Moves the caret up to the first child node of the branch that holds the current selection
  293. </td>
  294. </tr>
  295. <tr>
  296. <td id="Terminal_Gui_Command_NewLine">NewLine</td>
  297. <td>
  298. Inserts a new line.
  299. </td>
  300. </tr>
  301. <tr>
  302. <td id="Terminal_Gui_Command_NextView">NextView</td>
  303. <td>
  304. Moves focus to the next view.
  305. </td>
  306. </tr>
  307. <tr>
  308. <td id="Terminal_Gui_Command_NextViewOrTop">NextViewOrTop</td>
  309. <td>
  310. Moves focus to the next view or toplevel (case of Mdi).
  311. </td>
  312. </tr>
  313. <tr>
  314. <td id="Terminal_Gui_Command_OpenSelectedItem">OpenSelectedItem</td>
  315. <td>
  316. Open selected item.
  317. </td>
  318. </tr>
  319. <tr>
  320. <td id="Terminal_Gui_Command_PageDown">PageDown</td>
  321. <td>
  322. Move the page down.
  323. </td>
  324. </tr>
  325. <tr>
  326. <td id="Terminal_Gui_Command_PageDownExtend">PageDownExtend</td>
  327. <td>
  328. Move the page down increase selection area to cover revealed objects/characters.
  329. </td>
  330. </tr>
  331. <tr>
  332. <td id="Terminal_Gui_Command_PageLeft">PageLeft</td>
  333. <td>
  334. Moves to the left page.
  335. </td>
  336. </tr>
  337. <tr>
  338. <td id="Terminal_Gui_Command_PageRight">PageRight</td>
  339. <td>
  340. Moves to the right page.
  341. </td>
  342. </tr>
  343. <tr>
  344. <td id="Terminal_Gui_Command_PageUp">PageUp</td>
  345. <td>
  346. Move the page up.
  347. </td>
  348. </tr>
  349. <tr>
  350. <td id="Terminal_Gui_Command_PageUpExtend">PageUpExtend</td>
  351. <td>
  352. Move the page up increase selection area to cover revealed objects/characters.
  353. </td>
  354. </tr>
  355. <tr>
  356. <td id="Terminal_Gui_Command_Paste">Paste</td>
  357. <td>
  358. Pastes the current selection.
  359. </td>
  360. </tr>
  361. <tr>
  362. <td id="Terminal_Gui_Command_PreviousView">PreviousView</td>
  363. <td>
  364. Moves focuss to the previous view.
  365. </td>
  366. </tr>
  367. <tr>
  368. <td id="Terminal_Gui_Command_PreviousViewOrTop">PreviousViewOrTop</td>
  369. <td>
  370. Moves focus to the next previous or toplevel (case of Mdi).
  371. </td>
  372. </tr>
  373. <tr>
  374. <td id="Terminal_Gui_Command_QuitToplevel">QuitToplevel</td>
  375. <td>
  376. Quit a toplevel.
  377. </td>
  378. </tr>
  379. <tr>
  380. <td id="Terminal_Gui_Command_Redo">Redo</td>
  381. <td>
  382. Redo changes.
  383. </td>
  384. </tr>
  385. <tr>
  386. <td id="Terminal_Gui_Command_Refresh">Refresh</td>
  387. <td>
  388. Refresh the application.
  389. </td>
  390. </tr>
  391. <tr>
  392. <td id="Terminal_Gui_Command_Right">Right</td>
  393. <td>
  394. Moves the selection right one by the minimum increment supported by the view e.g. single character, cell, item etc.
  395. </td>
  396. </tr>
  397. <tr>
  398. <td id="Terminal_Gui_Command_RightEnd">RightEnd</td>
  399. <td>
  400. Moves to the right end.
  401. </td>
  402. </tr>
  403. <tr>
  404. <td id="Terminal_Gui_Command_RightEndExtend">RightEndExtend</td>
  405. <td>
  406. Extends the selection to the right end.
  407. </td>
  408. </tr>
  409. <tr>
  410. <td id="Terminal_Gui_Command_RightExtend">RightExtend</td>
  411. <td>
  412. Extends the selection right one by the minimum increment supported by the view e.g. single character, cell, item etc.
  413. </td>
  414. </tr>
  415. <tr>
  416. <td id="Terminal_Gui_Command_ScrollDown">ScrollDown</td>
  417. <td>
  418. Scrolls down one line (without changing the selection).
  419. </td>
  420. </tr>
  421. <tr>
  422. <td id="Terminal_Gui_Command_ScrollLeft">ScrollLeft</td>
  423. <td>
  424. Scrolls one character to the left
  425. </td>
  426. </tr>
  427. <tr>
  428. <td id="Terminal_Gui_Command_ScrollRight">ScrollRight</td>
  429. <td>
  430. Scrolls one character to the right.
  431. </td>
  432. </tr>
  433. <tr>
  434. <td id="Terminal_Gui_Command_ScrollUp">ScrollUp</td>
  435. <td>
  436. Scrolls up one line (without changing the selection).
  437. </td>
  438. </tr>
  439. <tr>
  440. <td id="Terminal_Gui_Command_SelectAll">SelectAll</td>
  441. <td>
  442. Selects all objects in the control.
  443. </td>
  444. </tr>
  445. <tr>
  446. <td id="Terminal_Gui_Command_StartOfLine">StartOfLine</td>
  447. <td>
  448. Moves the cursor to the start of line.
  449. </td>
  450. </tr>
  451. <tr>
  452. <td id="Terminal_Gui_Command_StartOfLineExtend">StartOfLineExtend</td>
  453. <td>
  454. Extends the selection to the start of line.
  455. </td>
  456. </tr>
  457. <tr>
  458. <td id="Terminal_Gui_Command_StartOfPage">StartOfPage</td>
  459. <td>
  460. Moves the cursor to the top of page.
  461. </td>
  462. </tr>
  463. <tr>
  464. <td id="Terminal_Gui_Command_Suspend">Suspend</td>
  465. <td>
  466. Suspend a application (used on Linux).
  467. </td>
  468. </tr>
  469. <tr>
  470. <td id="Terminal_Gui_Command_Tab">Tab</td>
  471. <td>
  472. Inserts a tab.
  473. </td>
  474. </tr>
  475. <tr>
  476. <td id="Terminal_Gui_Command_ToggleChecked">ToggleChecked</td>
  477. <td>
  478. Toggle the checked state.
  479. </td>
  480. </tr>
  481. <tr>
  482. <td id="Terminal_Gui_Command_ToggleExpandCollapse">ToggleExpandCollapse</td>
  483. <td>
  484. Toggles the Expanded or collapsed state of a a list or item (with subitems)
  485. </td>
  486. </tr>
  487. <tr>
  488. <td id="Terminal_Gui_Command_ToggleExtend">ToggleExtend</td>
  489. <td>
  490. Toggles the extended selection.
  491. </td>
  492. </tr>
  493. <tr>
  494. <td id="Terminal_Gui_Command_ToggleOverwrite">ToggleOverwrite</td>
  495. <td>
  496. Toggles overwrite mode such that newly typed text overwrites the text that is
  497. already there (typically associated with the Insert key).
  498. </td>
  499. </tr>
  500. <tr>
  501. <td id="Terminal_Gui_Command_TopHome">TopHome</td>
  502. <td>
  503. Moves to top begin.
  504. </td>
  505. </tr>
  506. <tr>
  507. <td id="Terminal_Gui_Command_TopHomeExtend">TopHomeExtend</td>
  508. <td>
  509. Extends the selection to the top begin.
  510. </td>
  511. </tr>
  512. <tr>
  513. <td id="Terminal_Gui_Command_Undo">Undo</td>
  514. <td>
  515. Undo changes.
  516. </td>
  517. </tr>
  518. <tr>
  519. <td id="Terminal_Gui_Command_UnixEmulation">UnixEmulation</td>
  520. <td>
  521. Unix emulation
  522. </td>
  523. </tr>
  524. <tr>
  525. <td id="Terminal_Gui_Command_WordLeft">WordLeft</td>
  526. <td>
  527. Moves the caret to the start of the previous word.
  528. </td>
  529. </tr>
  530. <tr>
  531. <td id="Terminal_Gui_Command_WordLeftExtend">WordLeftExtend</td>
  532. <td>
  533. Extends the selection to the start of the previous word.
  534. </td>
  535. </tr>
  536. <tr>
  537. <td id="Terminal_Gui_Command_WordRight">WordRight</td>
  538. <td>
  539. Moves the caret to the start of the next word.
  540. </td>
  541. </tr>
  542. <tr>
  543. <td id="Terminal_Gui_Command_WordRightExtend">WordRightExtend</td>
  544. <td>
  545. Extends the selection to the start of the next word.
  546. </td>
  547. </tr>
  548. </tbody>
  549. </thead></thead></table>
  550. </article>
  551. </div>
  552. <div class="hidden-sm col-md-2" role="complementary">
  553. <div class="sideaffix">
  554. <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
  555. <h5>In This Article</h5>
  556. <div></div>
  557. </nav>
  558. </div>
  559. </div>
  560. </div>
  561. </div>
  562. <footer>
  563. <div class="grad-bottom"></div>
  564. <div class="footer">
  565. <div class="container">
  566. <span class="pull-right">
  567. <a href="#top">Back to top</a>
  568. </span>
  569. <span>Generated by <strong>DocFX</strong></span>
  570. </div>
  571. </div>
  572. </footer>
  573. </div>
  574. <script type="text/javascript" src="../../styles/docfx.vendor.js"></script>
  575. <script type="text/javascript" src="../../styles/docfx.js"></script>
  576. <script type="text/javascript" src="../../styles/main.js"></script>
  577. </body>
  578. </html>