Terminal.Gui.Key.html 14 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437
  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 Key
  8. </title>
  9. <meta name="viewport" content="width=device-width">
  10. <meta name="title" content="Enum Key
  11. ">
  12. <meta name="generator" content="docfx 2.18.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="">
  18. <meta property="docfx:tocrel" content="../toc.html">
  19. </head>
  20. <body data-spy="scroll" data-target="#affix">
  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="../../logo.svg" 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 role="main" class="container body-content hide-when-search">
  54. <div class="sidenav hide-when-search">
  55. <a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
  56. <div class="sidetoggle collapse" id="sidetoggle">
  57. <div id="sidetoc"></div>
  58. </div>
  59. </div>
  60. <div class="article row grid-right">
  61. <div class="col-md-10">
  62. <article class="content wrap" id="_content" data-uid="Terminal.Gui.Key">
  63. <h1 id="Terminal_Gui_Key" data-uid="Terminal.Gui.Key">Enum Key
  64. </h1>
  65. <div class="markdown level0 summary"><p>The Key enumeration contains special encoding for some keys, but can also
  66. encode all the unicode values that can be passed.</p>
  67. </div>
  68. <div class="markdown level0 conceptual"></div>
  69. <h6><strong>Namespace</strong>: <a class="xref" href="../Terminal.Gui.html">Terminal.Gui</a></h6>
  70. <h6><strong>Assembly</strong>: Terminal.Gui.dll</h6>
  71. <h5 id="Terminal_Gui_Key_syntax">Syntax</h5>
  72. <div class="codewrapper">
  73. <pre><code class="lang-csharp hljs">public enum Key</code></pre>
  74. </div>
  75. <h5 id="Terminal_Gui_Key_remarks"><strong>Remarks</strong></h5>
  76. <div class="markdown level0 remarks"><p>
  77. If the SpecialMask is set, then the value is that of the special mask,
  78. otherwise, the value is the one of the lower bits (as extracted by CharMask)
  79. </p>
  80. <p>
  81. Control keys are the values between 1 and 26 corresponding to Control-A to Control-Z
  82. </p>
  83. <p>
  84. Unicode runes are also stored here, the letter &#39;A&quot; for example is encoded as a value 65 (not surfaced in the enum).
  85. </p></div>
  86. <h3 id="fields">Fields
  87. </h3>
  88. <table class="table table-bordered table-striped table-condensed">
  89. <thead>
  90. <tr>
  91. <th>Name</th>
  92. <th>Description</th>
  93. </tr>
  94. <thead>
  95. <tbody>
  96. <tr>
  97. <td id="Terminal_Gui_Key_AltMask">AltMask</td>
  98. <td><p>When this value is set, the Key encodes the sequence Alt-KeyValue.
  99. And the actual value must be extracted by removing the AltMask.</p>
  100. </td>
  101. </tr>
  102. <tr>
  103. <td id="Terminal_Gui_Key_Backspace">Backspace</td>
  104. <td><p>Backspace key.</p>
  105. </td>
  106. </tr>
  107. <tr>
  108. <td id="Terminal_Gui_Key_BackTab">BackTab</td>
  109. <td><p>Shift-tab key (backwards tab key).</p>
  110. </td>
  111. </tr>
  112. <tr>
  113. <td id="Terminal_Gui_Key_CharMask">CharMask</td>
  114. <td><p>Mask that indictes that this is a character value, values outside this range
  115. indicate special characters like Alt-key combinations or special keys on the
  116. keyboard like function keys, arrows keys and so on.</p>
  117. </td>
  118. </tr>
  119. <tr>
  120. <td id="Terminal_Gui_Key_ControlA">ControlA</td>
  121. <td><p>The key code for the user pressing Control-A</p>
  122. </td>
  123. </tr>
  124. <tr>
  125. <td id="Terminal_Gui_Key_ControlB">ControlB</td>
  126. <td><p>The key code for the user pressing Control-B</p>
  127. </td>
  128. </tr>
  129. <tr>
  130. <td id="Terminal_Gui_Key_ControlC">ControlC</td>
  131. <td><p>The key code for the user pressing Control-C</p>
  132. </td>
  133. </tr>
  134. <tr>
  135. <td id="Terminal_Gui_Key_ControlD">ControlD</td>
  136. <td><p>The key code for the user pressing Control-D</p>
  137. </td>
  138. </tr>
  139. <tr>
  140. <td id="Terminal_Gui_Key_ControlE">ControlE</td>
  141. <td><p>The key code for the user pressing Control-E</p>
  142. </td>
  143. </tr>
  144. <tr>
  145. <td id="Terminal_Gui_Key_ControlF">ControlF</td>
  146. <td><p>The key code for the user pressing Control-F</p>
  147. </td>
  148. </tr>
  149. <tr>
  150. <td id="Terminal_Gui_Key_ControlG">ControlG</td>
  151. <td><p>The key code for the user pressing Control-G</p>
  152. </td>
  153. </tr>
  154. <tr>
  155. <td id="Terminal_Gui_Key_ControlH">ControlH</td>
  156. <td><p>The key code for the user pressing Control-H</p>
  157. </td>
  158. </tr>
  159. <tr>
  160. <td id="Terminal_Gui_Key_ControlI">ControlI</td>
  161. <td><p>The key code for the user pressing Control-I (same as the tab key).</p>
  162. </td>
  163. </tr>
  164. <tr>
  165. <td id="Terminal_Gui_Key_ControlJ">ControlJ</td>
  166. <td><p>The key code for the user pressing Control-J</p>
  167. </td>
  168. </tr>
  169. <tr>
  170. <td id="Terminal_Gui_Key_ControlK">ControlK</td>
  171. <td><p>The key code for the user pressing Control-K</p>
  172. </td>
  173. </tr>
  174. <tr>
  175. <td id="Terminal_Gui_Key_ControlL">ControlL</td>
  176. <td><p>The key code for the user pressing Control-L</p>
  177. </td>
  178. </tr>
  179. <tr>
  180. <td id="Terminal_Gui_Key_ControlM">ControlM</td>
  181. <td><p>The key code for the user pressing Control-M</p>
  182. </td>
  183. </tr>
  184. <tr>
  185. <td id="Terminal_Gui_Key_ControlN">ControlN</td>
  186. <td><p>The key code for the user pressing Control-N (same as the return key).</p>
  187. </td>
  188. </tr>
  189. <tr>
  190. <td id="Terminal_Gui_Key_ControlO">ControlO</td>
  191. <td><p>The key code for the user pressing Control-O</p>
  192. </td>
  193. </tr>
  194. <tr>
  195. <td id="Terminal_Gui_Key_ControlP">ControlP</td>
  196. <td><p>The key code for the user pressing Control-P</p>
  197. </td>
  198. </tr>
  199. <tr>
  200. <td id="Terminal_Gui_Key_ControlQ">ControlQ</td>
  201. <td><p>The key code for the user pressing Control-Q</p>
  202. </td>
  203. </tr>
  204. <tr>
  205. <td id="Terminal_Gui_Key_ControlR">ControlR</td>
  206. <td><p>The key code for the user pressing Control-R</p>
  207. </td>
  208. </tr>
  209. <tr>
  210. <td id="Terminal_Gui_Key_ControlS">ControlS</td>
  211. <td><p>The key code for the user pressing Control-S</p>
  212. </td>
  213. </tr>
  214. <tr>
  215. <td id="Terminal_Gui_Key_ControlSpace">ControlSpace</td>
  216. <td><p>The key code for the user pressing Control-spacebar</p>
  217. </td>
  218. </tr>
  219. <tr>
  220. <td id="Terminal_Gui_Key_ControlT">ControlT</td>
  221. <td><p>The key code for the user pressing Control-T</p>
  222. </td>
  223. </tr>
  224. <tr>
  225. <td id="Terminal_Gui_Key_ControlU">ControlU</td>
  226. <td><p>The key code for the user pressing Control-U</p>
  227. </td>
  228. </tr>
  229. <tr>
  230. <td id="Terminal_Gui_Key_ControlV">ControlV</td>
  231. <td><p>The key code for the user pressing Control-V</p>
  232. </td>
  233. </tr>
  234. <tr>
  235. <td id="Terminal_Gui_Key_ControlW">ControlW</td>
  236. <td><p>The key code for the user pressing Control-W</p>
  237. </td>
  238. </tr>
  239. <tr>
  240. <td id="Terminal_Gui_Key_ControlX">ControlX</td>
  241. <td><p>The key code for the user pressing Control-X</p>
  242. </td>
  243. </tr>
  244. <tr>
  245. <td id="Terminal_Gui_Key_ControlY">ControlY</td>
  246. <td><p>The key code for the user pressing Control-Y</p>
  247. </td>
  248. </tr>
  249. <tr>
  250. <td id="Terminal_Gui_Key_ControlZ">ControlZ</td>
  251. <td><p>The key code for the user pressing Control-Z</p>
  252. </td>
  253. </tr>
  254. <tr>
  255. <td id="Terminal_Gui_Key_CursorDown">CursorDown</td>
  256. <td><p>Cursor down key.</p>
  257. </td>
  258. </tr>
  259. <tr>
  260. <td id="Terminal_Gui_Key_CursorLeft">CursorLeft</td>
  261. <td><p>Cursor left key.</p>
  262. </td>
  263. </tr>
  264. <tr>
  265. <td id="Terminal_Gui_Key_CursorRight">CursorRight</td>
  266. <td><p>Cursor right key.</p>
  267. </td>
  268. </tr>
  269. <tr>
  270. <td id="Terminal_Gui_Key_CursorUp">CursorUp</td>
  271. <td><p>Cursor up key</p>
  272. </td>
  273. </tr>
  274. <tr>
  275. <td id="Terminal_Gui_Key_Delete">Delete</td>
  276. <td><p>The key code for the user pressing the delete key.</p>
  277. </td>
  278. </tr>
  279. <tr>
  280. <td id="Terminal_Gui_Key_DeleteChar">DeleteChar</td>
  281. <td><p>Delete character key</p>
  282. </td>
  283. </tr>
  284. <tr>
  285. <td id="Terminal_Gui_Key_End">End</td>
  286. <td><p>End key</p>
  287. </td>
  288. </tr>
  289. <tr>
  290. <td id="Terminal_Gui_Key_Enter">Enter</td>
  291. <td><p>The key code for the user pressing the return key.</p>
  292. </td>
  293. </tr>
  294. <tr>
  295. <td id="Terminal_Gui_Key_Esc">Esc</td>
  296. <td><p>The key code for the user pressing the escape key</p>
  297. </td>
  298. </tr>
  299. <tr>
  300. <td id="Terminal_Gui_Key_F1">F1</td>
  301. <td><p>F1 key.</p>
  302. </td>
  303. </tr>
  304. <tr>
  305. <td id="Terminal_Gui_Key_F10">F10</td>
  306. <td><p>F10 key.</p>
  307. </td>
  308. </tr>
  309. <tr>
  310. <td id="Terminal_Gui_Key_F2">F2</td>
  311. <td><p>F2 key.</p>
  312. </td>
  313. </tr>
  314. <tr>
  315. <td id="Terminal_Gui_Key_F3">F3</td>
  316. <td><p>F3 key.</p>
  317. </td>
  318. </tr>
  319. <tr>
  320. <td id="Terminal_Gui_Key_F4">F4</td>
  321. <td><p>F4 key.</p>
  322. </td>
  323. </tr>
  324. <tr>
  325. <td id="Terminal_Gui_Key_F5">F5</td>
  326. <td><p>F5 key.</p>
  327. </td>
  328. </tr>
  329. <tr>
  330. <td id="Terminal_Gui_Key_F6">F6</td>
  331. <td><p>F6 key.</p>
  332. </td>
  333. </tr>
  334. <tr>
  335. <td id="Terminal_Gui_Key_F7">F7</td>
  336. <td><p>F7 key.</p>
  337. </td>
  338. </tr>
  339. <tr>
  340. <td id="Terminal_Gui_Key_F8">F8</td>
  341. <td><p>F8 key.</p>
  342. </td>
  343. </tr>
  344. <tr>
  345. <td id="Terminal_Gui_Key_F9">F9</td>
  346. <td><p>F9 key.</p>
  347. </td>
  348. </tr>
  349. <tr>
  350. <td id="Terminal_Gui_Key_Home">Home</td>
  351. <td><p>Home key</p>
  352. </td>
  353. </tr>
  354. <tr>
  355. <td id="Terminal_Gui_Key_InsertChar">InsertChar</td>
  356. <td><p>Insert character key</p>
  357. </td>
  358. </tr>
  359. <tr>
  360. <td id="Terminal_Gui_Key_PageDown">PageDown</td>
  361. <td><p>Page Down key.</p>
  362. </td>
  363. </tr>
  364. <tr>
  365. <td id="Terminal_Gui_Key_PageUp">PageUp</td>
  366. <td><p>Page Up key.</p>
  367. </td>
  368. </tr>
  369. <tr>
  370. <td id="Terminal_Gui_Key_Space">Space</td>
  371. <td><p>The key code for the user pressing the space bar</p>
  372. </td>
  373. </tr>
  374. <tr>
  375. <td id="Terminal_Gui_Key_SpecialMask">SpecialMask</td>
  376. <td><p>If the SpecialMask is set, then the value is that of the special mask,
  377. otherwise, the value is the one of the lower bits (as extracted by CharMask).</p>
  378. </td>
  379. </tr>
  380. <tr>
  381. <td id="Terminal_Gui_Key_Tab">Tab</td>
  382. <td><p>The key code for the user pressing the tab key (same as pressing Control-I).</p>
  383. </td>
  384. </tr>
  385. <tr>
  386. <td id="Terminal_Gui_Key_Unknown">Unknown</td>
  387. <td><p>A key with an unknown mapping was raised.</p>
  388. </td>
  389. </tr>
  390. </tbody>
  391. </thead></thead></table>
  392. </article>
  393. </div>
  394. <div class="hidden-sm col-md-2" role="complementary">
  395. <div class="sideaffix">
  396. <div class="contribution">
  397. <ul class="nav">
  398. </ul>
  399. </div>
  400. <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
  401. <!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
  402. </nav>
  403. </div>
  404. </div>
  405. </div>
  406. </div>
  407. <footer>
  408. <div class="grad-bottom"></div>
  409. <div class="footer">
  410. <div class="container">
  411. <span class="pull-right">
  412. <a href="#top">Back to top</a>
  413. </span>
  414. <span>Copyright © 2015-2017 Microsoft<br>Generated by <strong>DocFX</strong></span>
  415. </div>
  416. </div>
  417. </footer>
  418. </div>
  419. <script type="text/javascript" src="../../styles/docfx.vendor.js"></script>
  420. <script type="text/javascript" src="../../styles/docfx.js"></script>
  421. <script type="text/javascript" src="../../styles/main.js"></script>
  422. </body>
  423. </html>