Terminal.Gui.ConsoleKeyMapping.html 22 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448
  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>Class ConsoleKeyMapping
  8. </title>
  9. <meta name="viewport" content="width=device-width">
  10. <meta name="title" content="Class ConsoleKeyMapping
  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.ConsoleKeyMapping">
  72. <h1 id="Terminal_Gui_ConsoleKeyMapping" data-uid="Terminal.Gui.ConsoleKeyMapping" class="text-break">Class ConsoleKeyMapping
  73. </h1>
  74. <div class="markdown level0 summary">Helper class to handle the scan code and virtual key from a <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.consolekey">ConsoleKey</a>.</div>
  75. <div class="markdown level0 conceptual"></div>
  76. <div class="inheritance">
  77. <h5>Inheritance</h5>
  78. <div class="level0"><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a></div>
  79. <div class="level1"><span class="xref">ConsoleKeyMapping</span></div>
  80. </div>
  81. <div class="inheritedMembers">
  82. <h5>Inherited Members</h5>
  83. <div>
  84. <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)">object.Equals(object)</a>
  85. </div>
  86. <div>
  87. <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)">object.Equals(object, object)</a>
  88. </div>
  89. <div>
  90. <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.gethashcode">object.GetHashCode()</a>
  91. </div>
  92. <div>
  93. <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.gettype">object.GetType()</a>
  94. </div>
  95. <div>
  96. <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone">object.MemberwiseClone()</a>
  97. </div>
  98. <div>
  99. <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.referenceequals">object.ReferenceEquals(object, object)</a>
  100. </div>
  101. <div>
  102. <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.tostring">object.ToString()</a>
  103. </div>
  104. </div>
  105. <h6><strong>Namespace</strong>: <a class="xref" href="Terminal.html">Terminal</a>.<a class="xref" href="Terminal.Gui.html">Gui</a></h6>
  106. <h6><strong>Assembly</strong>: Terminal.Gui.dll</h6>
  107. <h5 id="Terminal_Gui_ConsoleKeyMapping_syntax">Syntax</h5>
  108. <div class="codewrapper">
  109. <pre><code class="lang-csharp hljs">public static class ConsoleKeyMapping</code></pre>
  110. </div>
  111. <h3 id="methods">Methods
  112. </h3>
  113. <span class="small pull-right mobile-hide">
  114. <span class="divider">|</span>
  115. <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/docfx/overrides/new?filename=Terminal_Gui_ConsoleKeyMapping_GetConsoleKeyFromKey_System_UInt32_System_ConsoleModifiers_System_UInt32__System_UInt32__.md&amp;value=---%0Auid%3A%20Terminal.Gui.ConsoleKeyMapping.GetConsoleKeyFromKey(System.UInt32%2CSystem.ConsoleModifiers%2CSystem.UInt32%40%2CSystem.UInt32%40)%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">Edit this page</a>
  116. </span>
  117. <span class="small pull-right mobile-hide">
  118. <a href="tig:tig/Terminal.Gui/blob/v2_develop/Terminal.Gui/Core/ConsoleKeyMapping.cs/#L80">View Source</a>
  119. </span>
  120. <a id="Terminal_Gui_ConsoleKeyMapping_GetConsoleKeyFromKey_" data-uid="Terminal.Gui.ConsoleKeyMapping.GetConsoleKeyFromKey*"></a>
  121. <h4 id="Terminal_Gui_ConsoleKeyMapping_GetConsoleKeyFromKey_System_UInt32_System_ConsoleModifiers_System_UInt32__System_UInt32__" data-uid="Terminal.Gui.ConsoleKeyMapping.GetConsoleKeyFromKey(System.UInt32,System.ConsoleModifiers,System.UInt32@,System.UInt32@)">GetConsoleKeyFromKey(uint, ConsoleModifiers, out uint, out uint)</h4>
  122. <div class="markdown level1 summary">Get the <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.consolekey">ConsoleKey</a> from a <a class="xref" href="Terminal.Gui.Key.html">Key</a>.</div>
  123. <div class="markdown level1 conceptual"></div>
  124. <h5 class="declaration">Declaration</h5>
  125. <div class="codewrapper">
  126. <pre><code class="lang-csharp hljs">public static uint GetConsoleKeyFromKey(uint keyValue, ConsoleModifiers modifiers, out uint scanCode, out uint outputChar)</code></pre>
  127. </div>
  128. <h5 class="parameters">Parameters</h5>
  129. <table class="table table-bordered table-condensed">
  130. <thead>
  131. <tr>
  132. <th>Type</th>
  133. <th>Name</th>
  134. <th>Description</th>
  135. </tr>
  136. </thead>
  137. <tbody>
  138. <tr>
  139. <td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.uint32">uint</a></td>
  140. <td><span class="parametername">keyValue</span></td>
  141. <td>The key value.</td>
  142. </tr>
  143. <tr>
  144. <td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.consolemodifiers">ConsoleModifiers</a></td>
  145. <td><span class="parametername">modifiers</span></td>
  146. <td>The modifiers keys.</td>
  147. </tr>
  148. <tr>
  149. <td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.uint32">uint</a></td>
  150. <td><span class="parametername">scanCode</span></td>
  151. <td>The resulting scan code.</td>
  152. </tr>
  153. <tr>
  154. <td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.uint32">uint</a></td>
  155. <td><span class="parametername">outputChar</span></td>
  156. <td>The resulting output character.</td>
  157. </tr>
  158. </tbody>
  159. </table>
  160. <h5 class="returns">Returns</h5>
  161. <table class="table table-bordered table-condensed">
  162. <thead>
  163. <tr>
  164. <th>Type</th>
  165. <th>Description</th>
  166. </tr>
  167. </thead>
  168. <tbody>
  169. <tr>
  170. <td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.uint32">uint</a></td>
  171. <td>The <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.consolekey">ConsoleKey</a> or the <code class="paramref">outputChar</code>.</td>
  172. </tr>
  173. </tbody>
  174. </table>
  175. <span class="small pull-right mobile-hide">
  176. <span class="divider">|</span>
  177. <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/docfx/overrides/new?filename=Terminal_Gui_ConsoleKeyMapping_GetKeyCharFromConsoleKey_System_UInt32_System_ConsoleModifiers_System_UInt32__System_UInt32__.md&amp;value=---%0Auid%3A%20Terminal.Gui.ConsoleKeyMapping.GetKeyCharFromConsoleKey(System.UInt32%2CSystem.ConsoleModifiers%2CSystem.UInt32%40%2CSystem.UInt32%40)%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">Edit this page</a>
  178. </span>
  179. <span class="small pull-right mobile-hide">
  180. <a href="tig:tig/Terminal.Gui/blob/v2_develop/Terminal.Gui/Core/ConsoleKeyMapping.cs/#L120">View Source</a>
  181. </span>
  182. <a id="Terminal_Gui_ConsoleKeyMapping_GetKeyCharFromConsoleKey_" data-uid="Terminal.Gui.ConsoleKeyMapping.GetKeyCharFromConsoleKey*"></a>
  183. <h4 id="Terminal_Gui_ConsoleKeyMapping_GetKeyCharFromConsoleKey_System_UInt32_System_ConsoleModifiers_System_UInt32__System_UInt32__" data-uid="Terminal.Gui.ConsoleKeyMapping.GetKeyCharFromConsoleKey(System.UInt32,System.ConsoleModifiers,System.UInt32@,System.UInt32@)">GetKeyCharFromConsoleKey(uint, ConsoleModifiers, out uint, out uint)</h4>
  184. <div class="markdown level1 summary">Get the output character from the <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.consolekey">ConsoleKey</a>.</div>
  185. <div class="markdown level1 conceptual"></div>
  186. <h5 class="declaration">Declaration</h5>
  187. <div class="codewrapper">
  188. <pre><code class="lang-csharp hljs">public static uint GetKeyCharFromConsoleKey(uint unicodeChar, ConsoleModifiers modifiers, out uint consoleKey, out uint scanCode)</code></pre>
  189. </div>
  190. <h5 class="parameters">Parameters</h5>
  191. <table class="table table-bordered table-condensed">
  192. <thead>
  193. <tr>
  194. <th>Type</th>
  195. <th>Name</th>
  196. <th>Description</th>
  197. </tr>
  198. </thead>
  199. <tbody>
  200. <tr>
  201. <td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.uint32">uint</a></td>
  202. <td><span class="parametername">unicodeChar</span></td>
  203. <td>The unicode character.</td>
  204. </tr>
  205. <tr>
  206. <td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.consolemodifiers">ConsoleModifiers</a></td>
  207. <td><span class="parametername">modifiers</span></td>
  208. <td>The modifiers keys.</td>
  209. </tr>
  210. <tr>
  211. <td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.uint32">uint</a></td>
  212. <td><span class="parametername">consoleKey</span></td>
  213. <td>The resulting console key.</td>
  214. </tr>
  215. <tr>
  216. <td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.uint32">uint</a></td>
  217. <td><span class="parametername">scanCode</span></td>
  218. <td>The resulting scan code.</td>
  219. </tr>
  220. </tbody>
  221. </table>
  222. <h5 class="returns">Returns</h5>
  223. <table class="table table-bordered table-condensed">
  224. <thead>
  225. <tr>
  226. <th>Type</th>
  227. <th>Description</th>
  228. </tr>
  229. </thead>
  230. <tbody>
  231. <tr>
  232. <td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.uint32">uint</a></td>
  233. <td>The output character or the <code class="paramref">consoleKey</code>.</td>
  234. </tr>
  235. </tbody>
  236. </table>
  237. <span class="small pull-right mobile-hide">
  238. <span class="divider">|</span>
  239. <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/docfx/overrides/new?filename=Terminal_Gui_ConsoleKeyMapping_MapConsoleKeyToKey_System_ConsoleKey_System_Boolean__.md&amp;value=---%0Auid%3A%20Terminal.Gui.ConsoleKeyMapping.MapConsoleKeyToKey(System.ConsoleKey%2CSystem.Boolean%40)%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">Edit this page</a>
  240. </span>
  241. <span class="small pull-right mobile-hide">
  242. <a href="tig:tig/Terminal.Gui/blob/v2_develop/Terminal.Gui/Core/ConsoleKeyMapping.cs/#L256">View Source</a>
  243. </span>
  244. <a id="Terminal_Gui_ConsoleKeyMapping_MapConsoleKeyToKey_" data-uid="Terminal.Gui.ConsoleKeyMapping.MapConsoleKeyToKey*"></a>
  245. <h4 id="Terminal_Gui_ConsoleKeyMapping_MapConsoleKeyToKey_System_ConsoleKey_System_Boolean__" data-uid="Terminal.Gui.ConsoleKeyMapping.MapConsoleKeyToKey(System.ConsoleKey,System.Boolean@)">MapConsoleKeyToKey(ConsoleKey, out bool)</h4>
  246. <div class="markdown level1 summary">Maps a <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.consolekey">ConsoleKey</a> to a <a class="xref" href="Terminal.Gui.Key.html">Key</a>.</div>
  247. <div class="markdown level1 conceptual"></div>
  248. <h5 class="declaration">Declaration</h5>
  249. <div class="codewrapper">
  250. <pre><code class="lang-csharp hljs">public static Key MapConsoleKeyToKey(ConsoleKey consoleKey, out bool isMappable)</code></pre>
  251. </div>
  252. <h5 class="parameters">Parameters</h5>
  253. <table class="table table-bordered table-condensed">
  254. <thead>
  255. <tr>
  256. <th>Type</th>
  257. <th>Name</th>
  258. <th>Description</th>
  259. </tr>
  260. </thead>
  261. <tbody>
  262. <tr>
  263. <td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.consolekey">ConsoleKey</a></td>
  264. <td><span class="parametername">consoleKey</span></td>
  265. <td>The console key.</td>
  266. </tr>
  267. <tr>
  268. <td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></td>
  269. <td><span class="parametername">isMappable</span></td>
  270. <td>If <a href="https://learn.microsoft.com/dotnet/csharp/language-reference/builtin-types/bool">true</a> is mapped to a valid character, otherwise <a href="https://learn.microsoft.com/dotnet/csharp/language-reference/builtin-types/bool">false</a>.</td>
  271. </tr>
  272. </tbody>
  273. </table>
  274. <h5 class="returns">Returns</h5>
  275. <table class="table table-bordered table-condensed">
  276. <thead>
  277. <tr>
  278. <th>Type</th>
  279. <th>Description</th>
  280. </tr>
  281. </thead>
  282. <tbody>
  283. <tr>
  284. <td><a class="xref" href="Terminal.Gui.Key.html">Key</a></td>
  285. <td>The <a class="xref" href="Terminal.Gui.Key.html">Key</a> or the <code class="paramref">consoleKey</code>.</td>
  286. </tr>
  287. </tbody>
  288. </table>
  289. <span class="small pull-right mobile-hide">
  290. <span class="divider">|</span>
  291. <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/docfx/overrides/new?filename=Terminal_Gui_ConsoleKeyMapping_MapKeyModifiers_System_ConsoleKeyInfo_Terminal_Gui_Key_.md&amp;value=---%0Auid%3A%20Terminal.Gui.ConsoleKeyMapping.MapKeyModifiers(System.ConsoleKeyInfo%2CTerminal.Gui.Key)%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">Edit this page</a>
  292. </span>
  293. <span class="small pull-right mobile-hide">
  294. <a href="tig:tig/Terminal.Gui/blob/v2_develop/Terminal.Gui/Core/ConsoleKeyMapping.cs/#L343">View Source</a>
  295. </span>
  296. <a id="Terminal_Gui_ConsoleKeyMapping_MapKeyModifiers_" data-uid="Terminal.Gui.ConsoleKeyMapping.MapKeyModifiers*"></a>
  297. <h4 id="Terminal_Gui_ConsoleKeyMapping_MapKeyModifiers_System_ConsoleKeyInfo_Terminal_Gui_Key_" data-uid="Terminal.Gui.ConsoleKeyMapping.MapKeyModifiers(System.ConsoleKeyInfo,Terminal.Gui.Key)">MapKeyModifiers(ConsoleKeyInfo, Key)</h4>
  298. <div class="markdown level1 summary">Maps a <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.consolekeyinfo">ConsoleKeyInfo</a> to a <a class="xref" href="Terminal.Gui.Key.html">Key</a>.</div>
  299. <div class="markdown level1 conceptual"></div>
  300. <h5 class="declaration">Declaration</h5>
  301. <div class="codewrapper">
  302. <pre><code class="lang-csharp hljs">public static Key MapKeyModifiers(ConsoleKeyInfo keyInfo, Key key)</code></pre>
  303. </div>
  304. <h5 class="parameters">Parameters</h5>
  305. <table class="table table-bordered table-condensed">
  306. <thead>
  307. <tr>
  308. <th>Type</th>
  309. <th>Name</th>
  310. <th>Description</th>
  311. </tr>
  312. </thead>
  313. <tbody>
  314. <tr>
  315. <td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.consolekeyinfo">ConsoleKeyInfo</a></td>
  316. <td><span class="parametername">keyInfo</span></td>
  317. <td>The console key info.</td>
  318. </tr>
  319. <tr>
  320. <td><a class="xref" href="Terminal.Gui.Key.html">Key</a></td>
  321. <td><span class="parametername">key</span></td>
  322. <td>The key.</td>
  323. </tr>
  324. </tbody>
  325. </table>
  326. <h5 class="returns">Returns</h5>
  327. <table class="table table-bordered table-condensed">
  328. <thead>
  329. <tr>
  330. <th>Type</th>
  331. <th>Description</th>
  332. </tr>
  333. </thead>
  334. <tbody>
  335. <tr>
  336. <td><a class="xref" href="Terminal.Gui.Key.html">Key</a></td>
  337. <td>The <a class="xref" href="Terminal.Gui.Key.html">Key</a> with <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.consolemodifiers">ConsoleModifiers</a> or the <code class="paramref">key</code></td>
  338. </tr>
  339. </tbody>
  340. </table>
  341. <span class="small pull-right mobile-hide">
  342. <span class="divider">|</span>
  343. <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/docfx/overrides/new?filename=Terminal_Gui_ConsoleKeyMapping_MapKeyToConsoleKey_System_UInt32_System_Boolean__.md&amp;value=---%0Auid%3A%20Terminal.Gui.ConsoleKeyMapping.MapKeyToConsoleKey(System.UInt32%2CSystem.Boolean%40)%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">Edit this page</a>
  344. </span>
  345. <span class="small pull-right mobile-hide">
  346. <a href="tig:tig/Terminal.Gui/blob/v2_develop/Terminal.Gui/Core/ConsoleKeyMapping.cs/#L164">View Source</a>
  347. </span>
  348. <a id="Terminal_Gui_ConsoleKeyMapping_MapKeyToConsoleKey_" data-uid="Terminal.Gui.ConsoleKeyMapping.MapKeyToConsoleKey*"></a>
  349. <h4 id="Terminal_Gui_ConsoleKeyMapping_MapKeyToConsoleKey_System_UInt32_System_Boolean__" data-uid="Terminal.Gui.ConsoleKeyMapping.MapKeyToConsoleKey(System.UInt32,System.Boolean@)">MapKeyToConsoleKey(uint, out bool)</h4>
  350. <div class="markdown level1 summary">Maps a <a class="xref" href="Terminal.Gui.Key.html">Key</a> to a <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.consolekey">ConsoleKey</a>.</div>
  351. <div class="markdown level1 conceptual"></div>
  352. <h5 class="declaration">Declaration</h5>
  353. <div class="codewrapper">
  354. <pre><code class="lang-csharp hljs">public static uint MapKeyToConsoleKey(uint keyValue, out bool isMappable)</code></pre>
  355. </div>
  356. <h5 class="parameters">Parameters</h5>
  357. <table class="table table-bordered table-condensed">
  358. <thead>
  359. <tr>
  360. <th>Type</th>
  361. <th>Name</th>
  362. <th>Description</th>
  363. </tr>
  364. </thead>
  365. <tbody>
  366. <tr>
  367. <td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.uint32">uint</a></td>
  368. <td><span class="parametername">keyValue</span></td>
  369. <td>The key value.</td>
  370. </tr>
  371. <tr>
  372. <td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></td>
  373. <td><span class="parametername">isMappable</span></td>
  374. <td>If <a href="https://learn.microsoft.com/dotnet/csharp/language-reference/builtin-types/bool">true</a> is mapped to a valid character, otherwise <a href="https://learn.microsoft.com/dotnet/csharp/language-reference/builtin-types/bool">false</a>.</td>
  375. </tr>
  376. </tbody>
  377. </table>
  378. <h5 class="returns">Returns</h5>
  379. <table class="table table-bordered table-condensed">
  380. <thead>
  381. <tr>
  382. <th>Type</th>
  383. <th>Description</th>
  384. </tr>
  385. </thead>
  386. <tbody>
  387. <tr>
  388. <td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.uint32">uint</a></td>
  389. <td>The <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.consolekey">ConsoleKey</a> or the <code class="paramref">keyValue</code>.</td>
  390. </tr>
  391. </tbody>
  392. </table>
  393. </article>
  394. </div>
  395. <div class="hidden-sm col-md-2" role="complementary">
  396. <div class="sideaffix">
  397. <div class="contribution">
  398. <ul class="nav">
  399. <li>
  400. <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/docfx/overrides/new?filename=Terminal_Gui_ConsoleKeyMapping.md&amp;value=---%0Auid%3A%20Terminal.Gui.ConsoleKeyMapping%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>
  401. </li>
  402. <li>
  403. <a href="tig:tig/Terminal.Gui/blob/v2_develop/Terminal.Gui/Core/ConsoleKeyMapping.cs/#L10" class="contribution-link">View Source</a>
  404. </li>
  405. </ul>
  406. </div>
  407. <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
  408. <h5>In this article</h5>
  409. <div></div>
  410. </nav>
  411. </div>
  412. </div>
  413. </div>
  414. </div>
  415. <footer>
  416. <div class="grad-bottom"></div>
  417. <div class="footer">
  418. <div class="container">
  419. <span class="pull-right">
  420. <a href="#top">Back to top</a>
  421. </span>
  422. <span>Generated by <strong>DocFX</strong></span>
  423. </div>
  424. </div>
  425. </footer>
  426. </div>
  427. <script type="text/javascript" src="../../styles/docfx.vendor.min.js"></script>
  428. <script type="text/javascript" src="../../styles/docfx.js"></script>
  429. <script type="text/javascript" src="../../styles/main.js"></script>
  430. </body>
  431. </html>