Terminal.Key.html 13 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429
  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.Key">
  63. <h1 id="Terminal_Key" data-uid="Terminal.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.html">Terminal</a></h6>
  70. <h6><strong>Assembly</strong>: Terminal.dll</h6>
  71. <h5 id="Terminal_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_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_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_Key_Backspace">Backspace</td>
  104. <td><p>Backspace key.</p>
  105. </td>
  106. </tr>
  107. <tr>
  108. <td id="Terminal_Key_BackTab">BackTab</td>
  109. <td><p>Shift-tab key (backwards tab key).</p>
  110. </td>
  111. </tr>
  112. <tr>
  113. <td id="Terminal_Key_CharMask">CharMask</td>
  114. <td></td>
  115. </tr>
  116. <tr>
  117. <td id="Terminal_Key_ControlA">ControlA</td>
  118. <td><p>The key code for the user pressing Control-A</p>
  119. </td>
  120. </tr>
  121. <tr>
  122. <td id="Terminal_Key_ControlB">ControlB</td>
  123. <td><p>The key code for the user pressing Control-B</p>
  124. </td>
  125. </tr>
  126. <tr>
  127. <td id="Terminal_Key_ControlC">ControlC</td>
  128. <td><p>The key code for the user pressing Control-C</p>
  129. </td>
  130. </tr>
  131. <tr>
  132. <td id="Terminal_Key_ControlD">ControlD</td>
  133. <td><p>The key code for the user pressing Control-D</p>
  134. </td>
  135. </tr>
  136. <tr>
  137. <td id="Terminal_Key_ControlE">ControlE</td>
  138. <td><p>The key code for the user pressing Control-E</p>
  139. </td>
  140. </tr>
  141. <tr>
  142. <td id="Terminal_Key_ControlF">ControlF</td>
  143. <td><p>The key code for the user pressing Control-F</p>
  144. </td>
  145. </tr>
  146. <tr>
  147. <td id="Terminal_Key_ControlG">ControlG</td>
  148. <td><p>The key code for the user pressing Control-G</p>
  149. </td>
  150. </tr>
  151. <tr>
  152. <td id="Terminal_Key_ControlH">ControlH</td>
  153. <td><p>The key code for the user pressing Control-H</p>
  154. </td>
  155. </tr>
  156. <tr>
  157. <td id="Terminal_Key_ControlI">ControlI</td>
  158. <td><p>The key code for the user pressing Control-I (same as the tab key).</p>
  159. </td>
  160. </tr>
  161. <tr>
  162. <td id="Terminal_Key_ControlJ">ControlJ</td>
  163. <td><p>The key code for the user pressing Control-J</p>
  164. </td>
  165. </tr>
  166. <tr>
  167. <td id="Terminal_Key_ControlK">ControlK</td>
  168. <td><p>The key code for the user pressing Control-K</p>
  169. </td>
  170. </tr>
  171. <tr>
  172. <td id="Terminal_Key_ControlL">ControlL</td>
  173. <td><p>The key code for the user pressing Control-L</p>
  174. </td>
  175. </tr>
  176. <tr>
  177. <td id="Terminal_Key_ControlM">ControlM</td>
  178. <td><p>The key code for the user pressing Control-M</p>
  179. </td>
  180. </tr>
  181. <tr>
  182. <td id="Terminal_Key_ControlN">ControlN</td>
  183. <td><p>The key code for the user pressing Control-N (same as the return key).</p>
  184. </td>
  185. </tr>
  186. <tr>
  187. <td id="Terminal_Key_ControlO">ControlO</td>
  188. <td><p>The key code for the user pressing Control-O</p>
  189. </td>
  190. </tr>
  191. <tr>
  192. <td id="Terminal_Key_ControlP">ControlP</td>
  193. <td><p>The key code for the user pressing Control-P</p>
  194. </td>
  195. </tr>
  196. <tr>
  197. <td id="Terminal_Key_ControlQ">ControlQ</td>
  198. <td><p>The key code for the user pressing Control-Q</p>
  199. </td>
  200. </tr>
  201. <tr>
  202. <td id="Terminal_Key_ControlR">ControlR</td>
  203. <td><p>The key code for the user pressing Control-R</p>
  204. </td>
  205. </tr>
  206. <tr>
  207. <td id="Terminal_Key_ControlS">ControlS</td>
  208. <td><p>The key code for the user pressing Control-S</p>
  209. </td>
  210. </tr>
  211. <tr>
  212. <td id="Terminal_Key_ControlT">ControlT</td>
  213. <td><p>The key code for the user pressing Control-T</p>
  214. </td>
  215. </tr>
  216. <tr>
  217. <td id="Terminal_Key_ControlU">ControlU</td>
  218. <td><p>The key code for the user pressing Control-U</p>
  219. </td>
  220. </tr>
  221. <tr>
  222. <td id="Terminal_Key_ControlV">ControlV</td>
  223. <td><p>The key code for the user pressing Control-V</p>
  224. </td>
  225. </tr>
  226. <tr>
  227. <td id="Terminal_Key_ControlW">ControlW</td>
  228. <td><p>The key code for the user pressing Control-W</p>
  229. </td>
  230. </tr>
  231. <tr>
  232. <td id="Terminal_Key_ControlX">ControlX</td>
  233. <td><p>The key code for the user pressing Control-X</p>
  234. </td>
  235. </tr>
  236. <tr>
  237. <td id="Terminal_Key_ControlY">ControlY</td>
  238. <td><p>The key code for the user pressing Control-Y</p>
  239. </td>
  240. </tr>
  241. <tr>
  242. <td id="Terminal_Key_ControlZ">ControlZ</td>
  243. <td><p>The key code for the user pressing Control-Z</p>
  244. </td>
  245. </tr>
  246. <tr>
  247. <td id="Terminal_Key_CursorDown">CursorDown</td>
  248. <td><p>Cursor down key.</p>
  249. </td>
  250. </tr>
  251. <tr>
  252. <td id="Terminal_Key_CursorLeft">CursorLeft</td>
  253. <td><p>Cursor left key.</p>
  254. </td>
  255. </tr>
  256. <tr>
  257. <td id="Terminal_Key_CursorRight">CursorRight</td>
  258. <td><p>Cursor right key.</p>
  259. </td>
  260. </tr>
  261. <tr>
  262. <td id="Terminal_Key_CursorUp">CursorUp</td>
  263. <td><p>Cursor up key</p>
  264. </td>
  265. </tr>
  266. <tr>
  267. <td id="Terminal_Key_Delete">Delete</td>
  268. <td><p>The key code for the user pressing the delete key.</p>
  269. </td>
  270. </tr>
  271. <tr>
  272. <td id="Terminal_Key_DeleteChar">DeleteChar</td>
  273. <td><p>Delete character key</p>
  274. </td>
  275. </tr>
  276. <tr>
  277. <td id="Terminal_Key_End">End</td>
  278. <td><p>End key</p>
  279. </td>
  280. </tr>
  281. <tr>
  282. <td id="Terminal_Key_Enter">Enter</td>
  283. <td><p>The key code for the user pressing the return key.</p>
  284. </td>
  285. </tr>
  286. <tr>
  287. <td id="Terminal_Key_Esc">Esc</td>
  288. <td><p>The key code for the user pressing the escape key</p>
  289. </td>
  290. </tr>
  291. <tr>
  292. <td id="Terminal_Key_F1">F1</td>
  293. <td><p>F1 key.</p>
  294. </td>
  295. </tr>
  296. <tr>
  297. <td id="Terminal_Key_F10">F10</td>
  298. <td><p>F10 key.</p>
  299. </td>
  300. </tr>
  301. <tr>
  302. <td id="Terminal_Key_F2">F2</td>
  303. <td><p>F2 key.</p>
  304. </td>
  305. </tr>
  306. <tr>
  307. <td id="Terminal_Key_F3">F3</td>
  308. <td><p>F3 key.</p>
  309. </td>
  310. </tr>
  311. <tr>
  312. <td id="Terminal_Key_F4">F4</td>
  313. <td><p>F4 key.</p>
  314. </td>
  315. </tr>
  316. <tr>
  317. <td id="Terminal_Key_F5">F5</td>
  318. <td><p>F5 key.</p>
  319. </td>
  320. </tr>
  321. <tr>
  322. <td id="Terminal_Key_F6">F6</td>
  323. <td><p>F6 key.</p>
  324. </td>
  325. </tr>
  326. <tr>
  327. <td id="Terminal_Key_F7">F7</td>
  328. <td><p>F7 key.</p>
  329. </td>
  330. </tr>
  331. <tr>
  332. <td id="Terminal_Key_F8">F8</td>
  333. <td><p>F8 key.</p>
  334. </td>
  335. </tr>
  336. <tr>
  337. <td id="Terminal_Key_F9">F9</td>
  338. <td><p>F9 key.</p>
  339. </td>
  340. </tr>
  341. <tr>
  342. <td id="Terminal_Key_Home">Home</td>
  343. <td><p>Home key</p>
  344. </td>
  345. </tr>
  346. <tr>
  347. <td id="Terminal_Key_InsertChar">InsertChar</td>
  348. <td><p>Insert character key</p>
  349. </td>
  350. </tr>
  351. <tr>
  352. <td id="Terminal_Key_PageDown">PageDown</td>
  353. <td><p>Page Down key.</p>
  354. </td>
  355. </tr>
  356. <tr>
  357. <td id="Terminal_Key_PageUp">PageUp</td>
  358. <td><p>Page Up key.</p>
  359. </td>
  360. </tr>
  361. <tr>
  362. <td id="Terminal_Key_Space">Space</td>
  363. <td><p>The key code for the user pressing the space bar</p>
  364. </td>
  365. </tr>
  366. <tr>
  367. <td id="Terminal_Key_SpecialMask">SpecialMask</td>
  368. <td><p>If the SpecialMask is set, then the value is that of the special mask,
  369. otherwise, the value is the one of the lower bits (as extracted by CharMask).</p>
  370. </td>
  371. </tr>
  372. <tr>
  373. <td id="Terminal_Key_Tab">Tab</td>
  374. <td><p>The key code for the user pressing the tab key (same as pressing Control-I).</p>
  375. </td>
  376. </tr>
  377. <tr>
  378. <td id="Terminal_Key_Unknown">Unknown</td>
  379. <td><p>A key with an unknown mapping was raised.</p>
  380. </td>
  381. </tr>
  382. </tbody>
  383. </thead></thead></table>
  384. </article>
  385. </div>
  386. <div class="hidden-sm col-md-2" role="complementary">
  387. <div class="sideaffix">
  388. <div class="contribution">
  389. <ul class="nav">
  390. </ul>
  391. </div>
  392. <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
  393. <!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
  394. </nav>
  395. </div>
  396. </div>
  397. </div>
  398. </div>
  399. <footer>
  400. <div class="grad-bottom"></div>
  401. <div class="footer">
  402. <div class="container">
  403. <span class="pull-right">
  404. <a href="#top">Back to top</a>
  405. </span>
  406. <span>Copyright © 2015-2017 Microsoft<br>Generated by <strong>DocFX</strong></span>
  407. </div>
  408. </div>
  409. </footer>
  410. </div>
  411. <script type="text/javascript" src="../../styles/docfx.vendor.js"></script>
  412. <script type="text/javascript" src="../../styles/docfx.js"></script>
  413. <script type="text/javascript" src="../../styles/main.js"></script>
  414. </body>
  415. </html>