Terminal.Gui.KeyEvent.html 24 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496
  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 KeyEvent
  8. </title>
  9. <meta name="viewport" content="width=device-width">
  10. <meta name="title" content="Class KeyEvent
  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.KeyEvent">
  72. <h1 id="Terminal_Gui_KeyEvent" data-uid="Terminal.Gui.KeyEvent" class="text-break">Class KeyEvent
  73. </h1>
  74. <div class="markdown level0 summary">Describes a keyboard event.</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">KeyEvent</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. <h6><strong>Namespace</strong>: <a class="xref" href="Terminal.html">Terminal</a>.<a class="xref" href="Terminal.Gui.html">Gui</a></h6>
  103. <h6><strong>Assembly</strong>: Terminal.Gui.dll</h6>
  104. <h5 id="Terminal_Gui_KeyEvent_syntax">Syntax</h5>
  105. <div class="codewrapper">
  106. <pre><code class="lang-csharp hljs">public class KeyEvent</code></pre>
  107. </div>
  108. <h3 id="constructors">Constructors
  109. </h3>
  110. <span class="small pull-right mobile-hide">
  111. <span class="divider">|</span>
  112. <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/docfx/overrides/new?filename=Terminal_Gui_KeyEvent__ctor.md&amp;value=---%0Auid%3A%20Terminal.Gui.KeyEvent.%23ctor%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>
  113. </span>
  114. <span class="small pull-right mobile-hide">
  115. <a href="tig:tig/Terminal.Gui/blob/v2_develop/Terminal.Gui/Core/Event.cs/#L595">View Source</a>
  116. </span>
  117. <a id="Terminal_Gui_KeyEvent__ctor_" data-uid="Terminal.Gui.KeyEvent.#ctor*"></a>
  118. <h4 id="Terminal_Gui_KeyEvent__ctor" data-uid="Terminal.Gui.KeyEvent.#ctor">KeyEvent()</h4>
  119. <div class="markdown level1 summary">Constructs a new <a class="xref" href="Terminal.Gui.KeyEvent.html">KeyEvent</a></div>
  120. <div class="markdown level1 conceptual"></div>
  121. <h5 class="declaration">Declaration</h5>
  122. <div class="codewrapper">
  123. <pre><code class="lang-csharp hljs">public KeyEvent()</code></pre>
  124. </div>
  125. <span class="small pull-right mobile-hide">
  126. <span class="divider">|</span>
  127. <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/docfx/overrides/new?filename=Terminal_Gui_KeyEvent__ctor_Terminal_Gui_Key_Terminal_Gui_KeyModifiers_.md&amp;value=---%0Auid%3A%20Terminal.Gui.KeyEvent.%23ctor(Terminal.Gui.Key%2CTerminal.Gui.KeyModifiers)%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>
  128. </span>
  129. <span class="small pull-right mobile-hide">
  130. <a href="tig:tig/Terminal.Gui/blob/v2_develop/Terminal.Gui/Core/Event.cs/#L604">View Source</a>
  131. </span>
  132. <a id="Terminal_Gui_KeyEvent__ctor_" data-uid="Terminal.Gui.KeyEvent.#ctor*"></a>
  133. <h4 id="Terminal_Gui_KeyEvent__ctor_Terminal_Gui_Key_Terminal_Gui_KeyModifiers_" data-uid="Terminal.Gui.KeyEvent.#ctor(Terminal.Gui.Key,Terminal.Gui.KeyModifiers)">KeyEvent(Key, KeyModifiers)</h4>
  134. <div class="markdown level1 summary">Constructs a new <a class="xref" href="Terminal.Gui.KeyEvent.html">KeyEvent</a> from the provided Key value - can be a rune cast into a Key value</div>
  135. <div class="markdown level1 conceptual"></div>
  136. <h5 class="declaration">Declaration</h5>
  137. <div class="codewrapper">
  138. <pre><code class="lang-csharp hljs">public KeyEvent(Key k, KeyModifiers km)</code></pre>
  139. </div>
  140. <h5 class="parameters">Parameters</h5>
  141. <table class="table table-bordered table-condensed">
  142. <thead>
  143. <tr>
  144. <th>Type</th>
  145. <th>Name</th>
  146. <th>Description</th>
  147. </tr>
  148. </thead>
  149. <tbody>
  150. <tr>
  151. <td><a class="xref" href="Terminal.Gui.Key.html">Key</a></td>
  152. <td><span class="parametername">k</span></td>
  153. <td></td>
  154. </tr>
  155. <tr>
  156. <td><a class="xref" href="Terminal.Gui.KeyModifiers.html">KeyModifiers</a></td>
  157. <td><span class="parametername">km</span></td>
  158. <td></td>
  159. </tr>
  160. </tbody>
  161. </table>
  162. <h3 id="fields">Fields
  163. </h3>
  164. <span class="small pull-right mobile-hide">
  165. <span class="divider">|</span>
  166. <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/docfx/overrides/new?filename=Terminal_Gui_KeyEvent_Key.md&amp;value=---%0Auid%3A%20Terminal.Gui.KeyEvent.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>
  167. </span>
  168. <span class="small pull-right mobile-hide">
  169. <a href="tig:tig/Terminal.Gui/blob/v2_develop/Terminal.Gui/Core/Event.cs/#L546">View Source</a>
  170. </span>
  171. <h4 id="Terminal_Gui_KeyEvent_Key" data-uid="Terminal.Gui.KeyEvent.Key">Key</h4>
  172. <div class="markdown level1 summary">Symbolic definition for the key.</div>
  173. <div class="markdown level1 conceptual"></div>
  174. <h5 class="declaration">Declaration</h5>
  175. <div class="codewrapper">
  176. <pre><code class="lang-csharp hljs">public Key Key</code></pre>
  177. </div>
  178. <h5 class="fieldValue">Field Value</h5>
  179. <table class="table table-bordered table-condensed">
  180. <thead>
  181. <tr>
  182. <th>Type</th>
  183. <th>Description</th>
  184. </tr>
  185. </thead>
  186. <tbody>
  187. <tr>
  188. <td><a class="xref" href="Terminal.Gui.Key.html">Key</a></td>
  189. <td></td>
  190. </tr>
  191. </tbody>
  192. </table>
  193. <h3 id="properties">Properties
  194. </h3>
  195. <span class="small pull-right mobile-hide">
  196. <span class="divider">|</span>
  197. <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/docfx/overrides/new?filename=Terminal_Gui_KeyEvent_IsAlt.md&amp;value=---%0Auid%3A%20Terminal.Gui.KeyEvent.IsAlt%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>
  198. </span>
  199. <span class="small pull-right mobile-hide">
  200. <a href="tig:tig/Terminal.Gui/blob/v2_develop/Terminal.Gui/Core/Event.cs/#L565">View Source</a>
  201. </span>
  202. <a id="Terminal_Gui_KeyEvent_IsAlt_" data-uid="Terminal.Gui.KeyEvent.IsAlt*"></a>
  203. <h4 id="Terminal_Gui_KeyEvent_IsAlt" data-uid="Terminal.Gui.KeyEvent.IsAlt">IsAlt</h4>
  204. <div class="markdown level1 summary">Gets a value indicating whether the Alt key was pressed (real or synthesized)</div>
  205. <div class="markdown level1 conceptual"></div>
  206. <h5 class="declaration">Declaration</h5>
  207. <div class="codewrapper">
  208. <pre><code class="lang-csharp hljs">public bool IsAlt { get; }</code></pre>
  209. </div>
  210. <h5 class="propertyValue">Property Value</h5>
  211. <table class="table table-bordered table-condensed">
  212. <thead>
  213. <tr>
  214. <th>Type</th>
  215. <th>Description</th>
  216. </tr>
  217. </thead>
  218. <tbody>
  219. <tr>
  220. <td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></td>
  221. <td><code>true</code> if is alternate; otherwise, <code>false</code>.</td>
  222. </tr>
  223. </tbody>
  224. </table>
  225. <span class="small pull-right mobile-hide">
  226. <span class="divider">|</span>
  227. <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/docfx/overrides/new?filename=Terminal_Gui_KeyEvent_IsCapslock.md&amp;value=---%0Auid%3A%20Terminal.Gui.KeyEvent.IsCapslock%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>
  228. </span>
  229. <span class="small pull-right mobile-hide">
  230. <a href="tig:tig/Terminal.Gui/blob/v2_develop/Terminal.Gui/Core/Event.cs/#L578">View Source</a>
  231. </span>
  232. <a id="Terminal_Gui_KeyEvent_IsCapslock_" data-uid="Terminal.Gui.KeyEvent.IsCapslock*"></a>
  233. <h4 id="Terminal_Gui_KeyEvent_IsCapslock" data-uid="Terminal.Gui.KeyEvent.IsCapslock">IsCapslock</h4>
  234. <div class="markdown level1 summary">Gets a value indicating whether the Caps lock key was pressed (real or synthesized)</div>
  235. <div class="markdown level1 conceptual"></div>
  236. <h5 class="declaration">Declaration</h5>
  237. <div class="codewrapper">
  238. <pre><code class="lang-csharp hljs">public bool IsCapslock { get; }</code></pre>
  239. </div>
  240. <h5 class="propertyValue">Property Value</h5>
  241. <table class="table table-bordered table-condensed">
  242. <thead>
  243. <tr>
  244. <th>Type</th>
  245. <th>Description</th>
  246. </tr>
  247. </thead>
  248. <tbody>
  249. <tr>
  250. <td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></td>
  251. <td><code>true</code> if is alternate; otherwise, <code>false</code>.</td>
  252. </tr>
  253. </tbody>
  254. </table>
  255. <span class="small pull-right mobile-hide">
  256. <span class="divider">|</span>
  257. <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/docfx/overrides/new?filename=Terminal_Gui_KeyEvent_IsCtrl.md&amp;value=---%0Auid%3A%20Terminal.Gui.KeyEvent.IsCtrl%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>
  258. </span>
  259. <span class="small pull-right mobile-hide">
  260. <a href="tig:tig/Terminal.Gui/blob/v2_develop/Terminal.Gui/Core/Event.cs/#L572">View Source</a>
  261. </span>
  262. <a id="Terminal_Gui_KeyEvent_IsCtrl_" data-uid="Terminal.Gui.KeyEvent.IsCtrl*"></a>
  263. <h4 id="Terminal_Gui_KeyEvent_IsCtrl" data-uid="Terminal.Gui.KeyEvent.IsCtrl">IsCtrl</h4>
  264. <div class="markdown level1 summary">Determines whether the value is a control key (and NOT just the ctrl key)</div>
  265. <div class="markdown level1 conceptual"></div>
  266. <h5 class="declaration">Declaration</h5>
  267. <div class="codewrapper">
  268. <pre><code class="lang-csharp hljs">public bool IsCtrl { get; }</code></pre>
  269. </div>
  270. <h5 class="propertyValue">Property Value</h5>
  271. <table class="table table-bordered table-condensed">
  272. <thead>
  273. <tr>
  274. <th>Type</th>
  275. <th>Description</th>
  276. </tr>
  277. </thead>
  278. <tbody>
  279. <tr>
  280. <td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></td>
  281. <td><code>true</code> if is ctrl; otherwise, <code>false</code>.</td>
  282. </tr>
  283. </tbody>
  284. </table>
  285. <span class="small pull-right mobile-hide">
  286. <span class="divider">|</span>
  287. <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/docfx/overrides/new?filename=Terminal_Gui_KeyEvent_IsNumlock.md&amp;value=---%0Auid%3A%20Terminal.Gui.KeyEvent.IsNumlock%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>
  288. </span>
  289. <span class="small pull-right mobile-hide">
  290. <a href="tig:tig/Terminal.Gui/blob/v2_develop/Terminal.Gui/Core/Event.cs/#L584">View Source</a>
  291. </span>
  292. <a id="Terminal_Gui_KeyEvent_IsNumlock_" data-uid="Terminal.Gui.KeyEvent.IsNumlock*"></a>
  293. <h4 id="Terminal_Gui_KeyEvent_IsNumlock" data-uid="Terminal.Gui.KeyEvent.IsNumlock">IsNumlock</h4>
  294. <div class="markdown level1 summary">Gets a value indicating whether the Num lock key was pressed (real or synthesized)</div>
  295. <div class="markdown level1 conceptual"></div>
  296. <h5 class="declaration">Declaration</h5>
  297. <div class="codewrapper">
  298. <pre><code class="lang-csharp hljs">public bool IsNumlock { get; }</code></pre>
  299. </div>
  300. <h5 class="propertyValue">Property Value</h5>
  301. <table class="table table-bordered table-condensed">
  302. <thead>
  303. <tr>
  304. <th>Type</th>
  305. <th>Description</th>
  306. </tr>
  307. </thead>
  308. <tbody>
  309. <tr>
  310. <td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></td>
  311. <td><code>true</code> if is alternate; otherwise, <code>false</code>.</td>
  312. </tr>
  313. </tbody>
  314. </table>
  315. <span class="small pull-right mobile-hide">
  316. <span class="divider">|</span>
  317. <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/docfx/overrides/new?filename=Terminal_Gui_KeyEvent_IsScrolllock.md&amp;value=---%0Auid%3A%20Terminal.Gui.KeyEvent.IsScrolllock%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>
  318. </span>
  319. <span class="small pull-right mobile-hide">
  320. <a href="tig:tig/Terminal.Gui/blob/v2_develop/Terminal.Gui/Core/Event.cs/#L590">View Source</a>
  321. </span>
  322. <a id="Terminal_Gui_KeyEvent_IsScrolllock_" data-uid="Terminal.Gui.KeyEvent.IsScrolllock*"></a>
  323. <h4 id="Terminal_Gui_KeyEvent_IsScrolllock" data-uid="Terminal.Gui.KeyEvent.IsScrolllock">IsScrolllock</h4>
  324. <div class="markdown level1 summary">Gets a value indicating whether the Scroll lock key was pressed (real or synthesized)</div>
  325. <div class="markdown level1 conceptual"></div>
  326. <h5 class="declaration">Declaration</h5>
  327. <div class="codewrapper">
  328. <pre><code class="lang-csharp hljs">public bool IsScrolllock { get; }</code></pre>
  329. </div>
  330. <h5 class="propertyValue">Property Value</h5>
  331. <table class="table table-bordered table-condensed">
  332. <thead>
  333. <tr>
  334. <th>Type</th>
  335. <th>Description</th>
  336. </tr>
  337. </thead>
  338. <tbody>
  339. <tr>
  340. <td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></td>
  341. <td><code>true</code> if is alternate; otherwise, <code>false</code>.</td>
  342. </tr>
  343. </tbody>
  344. </table>
  345. <span class="small pull-right mobile-hide">
  346. <span class="divider">|</span>
  347. <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/docfx/overrides/new?filename=Terminal_Gui_KeyEvent_IsShift.md&amp;value=---%0Auid%3A%20Terminal.Gui.KeyEvent.IsShift%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>
  348. </span>
  349. <span class="small pull-right mobile-hide">
  350. <a href="tig:tig/Terminal.Gui/blob/v2_develop/Terminal.Gui/Core/Event.cs/#L559">View Source</a>
  351. </span>
  352. <a id="Terminal_Gui_KeyEvent_IsShift_" data-uid="Terminal.Gui.KeyEvent.IsShift*"></a>
  353. <h4 id="Terminal_Gui_KeyEvent_IsShift" data-uid="Terminal.Gui.KeyEvent.IsShift">IsShift</h4>
  354. <div class="markdown level1 summary">Gets a value indicating whether the Shift key was pressed.</div>
  355. <div class="markdown level1 conceptual"></div>
  356. <h5 class="declaration">Declaration</h5>
  357. <div class="codewrapper">
  358. <pre><code class="lang-csharp hljs">public bool IsShift { get; }</code></pre>
  359. </div>
  360. <h5 class="propertyValue">Property Value</h5>
  361. <table class="table table-bordered table-condensed">
  362. <thead>
  363. <tr>
  364. <th>Type</th>
  365. <th>Description</th>
  366. </tr>
  367. </thead>
  368. <tbody>
  369. <tr>
  370. <td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></td>
  371. <td><code>true</code> if is shift; otherwise, <code>false</code>.</td>
  372. </tr>
  373. </tbody>
  374. </table>
  375. <span class="small pull-right mobile-hide">
  376. <span class="divider">|</span>
  377. <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/docfx/overrides/new?filename=Terminal_Gui_KeyEvent_KeyValue.md&amp;value=---%0Auid%3A%20Terminal.Gui.KeyEvent.KeyValue%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>
  378. </span>
  379. <span class="small pull-right mobile-hide">
  380. <a href="tig:tig/Terminal.Gui/blob/v2_develop/Terminal.Gui/Core/Event.cs/#L553">View Source</a>
  381. </span>
  382. <a id="Terminal_Gui_KeyEvent_KeyValue_" data-uid="Terminal.Gui.KeyEvent.KeyValue*"></a>
  383. <h4 id="Terminal_Gui_KeyEvent_KeyValue" data-uid="Terminal.Gui.KeyEvent.KeyValue">KeyValue</h4>
  384. <div class="markdown level1 summary">The key value cast to an integer, you will typical use this for
  385. extracting the Unicode rune value out of a key, when none of the
  386. symbolic options are in use.</div>
  387. <div class="markdown level1 conceptual"></div>
  388. <h5 class="declaration">Declaration</h5>
  389. <div class="codewrapper">
  390. <pre><code class="lang-csharp hljs">public int KeyValue { get; }</code></pre>
  391. </div>
  392. <h5 class="propertyValue">Property Value</h5>
  393. <table class="table table-bordered table-condensed">
  394. <thead>
  395. <tr>
  396. <th>Type</th>
  397. <th>Description</th>
  398. </tr>
  399. </thead>
  400. <tbody>
  401. <tr>
  402. <td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></td>
  403. <td></td>
  404. </tr>
  405. </tbody>
  406. </table>
  407. <h3 id="methods">Methods
  408. </h3>
  409. <span class="small pull-right mobile-hide">
  410. <span class="divider">|</span>
  411. <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/docfx/overrides/new?filename=Terminal_Gui_KeyEvent_ToString.md&amp;value=---%0Auid%3A%20Terminal.Gui.KeyEvent.ToString%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>
  412. </span>
  413. <span class="small pull-right mobile-hide">
  414. <a href="tig:tig/Terminal.Gui/blob/v2_develop/Terminal.Gui/Core/Event.cs/#L614">View Source</a>
  415. </span>
  416. <a id="Terminal_Gui_KeyEvent_ToString_" data-uid="Terminal.Gui.KeyEvent.ToString*"></a>
  417. <h4 id="Terminal_Gui_KeyEvent_ToString" data-uid="Terminal.Gui.KeyEvent.ToString">ToString()</h4>
  418. <div class="markdown level1 summary">Pretty prints the KeyEvent</div>
  419. <div class="markdown level1 conceptual"></div>
  420. <h5 class="declaration">Declaration</h5>
  421. <div class="codewrapper">
  422. <pre><code class="lang-csharp hljs">public override string ToString()</code></pre>
  423. </div>
  424. <h5 class="returns">Returns</h5>
  425. <table class="table table-bordered table-condensed">
  426. <thead>
  427. <tr>
  428. <th>Type</th>
  429. <th>Description</th>
  430. </tr>
  431. </thead>
  432. <tbody>
  433. <tr>
  434. <td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></td>
  435. <td></td>
  436. </tr>
  437. </tbody>
  438. </table>
  439. <h5 class="overrides">Overrides</h5>
  440. <div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.tostring">object.ToString()</a></div>
  441. </article>
  442. </div>
  443. <div class="hidden-sm col-md-2" role="complementary">
  444. <div class="sideaffix">
  445. <div class="contribution">
  446. <ul class="nav">
  447. <li>
  448. <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/docfx/overrides/new?filename=Terminal_Gui_KeyEvent.md&amp;value=---%0Auid%3A%20Terminal.Gui.KeyEvent%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>
  449. </li>
  450. <li>
  451. <a href="tig:tig/Terminal.Gui/blob/v2_develop/Terminal.Gui/Core/Event.cs/#L540" class="contribution-link">View Source</a>
  452. </li>
  453. </ul>
  454. </div>
  455. <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
  456. <h5>In this article</h5>
  457. <div></div>
  458. </nav>
  459. </div>
  460. </div>
  461. </div>
  462. </div>
  463. <footer>
  464. <div class="grad-bottom"></div>
  465. <div class="footer">
  466. <div class="container">
  467. <span class="pull-right">
  468. <a href="#top">Back to top</a>
  469. </span>
  470. <span>Generated by <strong>DocFX</strong></span>
  471. </div>
  472. </div>
  473. </footer>
  474. </div>
  475. <script type="text/javascript" src="../../styles/docfx.vendor.min.js"></script>
  476. <script type="text/javascript" src="../../styles/docfx.js"></script>
  477. <script type="text/javascript" src="../../styles/main.js"></script>
  478. </body>
  479. </html>