Terminal.Gui.KeyEvent.html 23 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520
  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. <meta name="generator" content="docfx 2.59.4.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. <link href="https://fonts.googleapis.com/css?family=Source Sans Pro" rel="stylesheet">
  18. <link href="https://fonts.googleapis.com/css?family=Source Code Pro" rel="stylesheet">
  19. <meta property="docfx:navrel" content="../../toc.html">
  20. <meta property="docfx:tocrel" content="toc.html">
  21. <meta property="docfx:rel" content="../../">
  22. </head> <body data-spy="scroll" data-target="#affix" data-offset="120">
  23. <div id="wrapper">
  24. <header>
  25. <nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation">
  26. <div class="container">
  27. <div class="navbar-header">
  28. <button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
  29. <span class="sr-only">Toggle navigation</span>
  30. <span class="icon-bar"></span>
  31. <span class="icon-bar"></span>
  32. <span class="icon-bar"></span>
  33. </button>
  34. <a class="navbar-brand" href="../../index.html">
  35. <img id="logo" class="svg" src="../../images/logo48.png" alt="">
  36. </a>
  37. </div>
  38. <div class="collapse navbar-collapse" id="navbar">
  39. <form class="navbar-form navbar-right" role="search" id="search">
  40. <div class="form-group">
  41. <input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">
  42. </div>
  43. </form>
  44. </div>
  45. </div>
  46. </nav>
  47. <div class="subnav navbar navbar-default">
  48. <div class="container hide-when-search" id="breadcrumb">
  49. <ul class="breadcrumb">
  50. <li></li>
  51. </ul>
  52. </div>
  53. </div>
  54. </header>
  55. <div class="container body-content">
  56. <div id="search-results">
  57. <div class="search-list">Search Results for <span></span></div>
  58. <div class="sr-items">
  59. <p><i class="glyphicon glyphicon-refresh index-loading"></i></p>
  60. </div>
  61. <ul id="pagination" data-first="First" data-prev="Previous" data-next="Next" data-last="Last"></ul>
  62. </div>
  63. </div>
  64. <div role="main" class="container body-content hide-when-search">
  65. <div class="sidenav hide-when-search">
  66. <a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
  67. <div class="sidetoggle collapse" id="sidetoggle">
  68. <div id="sidetoc"></div>
  69. </div>
  70. </div>
  71. <div class="article row grid-right">
  72. <div class="col-md-10">
  73. <article class="content wrap" id="_content" data-uid="Terminal.Gui.KeyEvent">
  74. <h1 id="Terminal_Gui_KeyEvent" data-uid="Terminal.Gui.KeyEvent" class="text-break">Class KeyEvent
  75. </h1>
  76. <div class="markdown level0 summary">
  77. Describes a keyboard event.
  78. </div>
  79. <div class="markdown level0 conceptual"></div>
  80. <div class="inheritance">
  81. <h5>Inheritance</h5>
  82. <div class="level0"><span class="xref">System.Object</span></div>
  83. <div class="level1"><span class="xref">KeyEvent</span></div>
  84. </div>
  85. <div class="inheritedMembers">
  86. <h5>Inherited Members</h5>
  87. <div>
  88. <span class="xref">System.Object.Equals(System.Object)</span>
  89. </div>
  90. <div>
  91. <span class="xref">System.Object.Equals(System.Object, System.Object)</span>
  92. </div>
  93. <div>
  94. <span class="xref">System.Object.GetHashCode()</span>
  95. </div>
  96. <div>
  97. <span class="xref">System.Object.GetType()</span>
  98. </div>
  99. <div>
  100. <span class="xref">System.Object.MemberwiseClone()</span>
  101. </div>
  102. <div>
  103. <span class="xref">System.Object.ReferenceEquals(System.Object, System.Object)</span>
  104. </div>
  105. </div>
  106. <h6><strong>Namespace</strong>: <a class="xref" href="Terminal.Gui.html">Terminal.Gui</a></h6>
  107. <h6><strong>Assembly</strong>: Terminal.Gui.dll</h6>
  108. <h5 id="Terminal_Gui_KeyEvent_syntax">Syntax</h5>
  109. <div class="codewrapper">
  110. <pre><code class="lang-csharp hljs">public class KeyEvent</code></pre>
  111. </div>
  112. <h3 id="constructors">Constructors
  113. </h3>
  114. <span class="small pull-right mobile-hide">
  115. <span class="divider">|</span>
  116. <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/apidoc/new?filename=Terminal_Gui_KeyEvent__ctor.md&amp;value=---%0Auid%3A%20Terminal.Gui.KeyEvent.%23ctor%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
  117. </span>
  118. <span class="small pull-right mobile-hide">
  119. <a href="tig:tig/gui.cs/blob/main/Terminal.Gui/Core/Event.cs/#L534">View Source</a>
  120. </span>
  121. <a id="Terminal_Gui_KeyEvent__ctor_" data-uid="Terminal.Gui.KeyEvent.#ctor*"></a>
  122. <h4 id="Terminal_Gui_KeyEvent__ctor" data-uid="Terminal.Gui.KeyEvent.#ctor">KeyEvent()</h4>
  123. <div class="markdown level1 summary">
  124. Constructs a new <a class="xref" href="Terminal.Gui.KeyEvent.html">KeyEvent</a>
  125. </div>
  126. <div class="markdown level1 conceptual"></div>
  127. <h5 class="decalaration">Declaration</h5>
  128. <div class="codewrapper">
  129. <pre><code class="lang-csharp hljs">public KeyEvent()</code></pre>
  130. </div>
  131. <span class="small pull-right mobile-hide">
  132. <span class="divider">|</span>
  133. <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/apidoc/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'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
  134. </span>
  135. <span class="small pull-right mobile-hide">
  136. <a href="tig:tig/gui.cs/blob/main/Terminal.Gui/Core/Event.cs/#L543">View Source</a>
  137. </span>
  138. <a id="Terminal_Gui_KeyEvent__ctor_" data-uid="Terminal.Gui.KeyEvent.#ctor*"></a>
  139. <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>
  140. <div class="markdown level1 summary">
  141. 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
  142. </div>
  143. <div class="markdown level1 conceptual"></div>
  144. <h5 class="decalaration">Declaration</h5>
  145. <div class="codewrapper">
  146. <pre><code class="lang-csharp hljs">public KeyEvent(Key k, KeyModifiers km)</code></pre>
  147. </div>
  148. <h5 class="parameters">Parameters</h5>
  149. <table class="table table-bordered table-striped table-condensed">
  150. <thead>
  151. <tr>
  152. <th>Type</th>
  153. <th>Name</th>
  154. <th>Description</th>
  155. </tr>
  156. </thead>
  157. <tbody>
  158. <tr>
  159. <td><a class="xref" href="Terminal.Gui.Key.html">Key</a></td>
  160. <td><span class="parametername">k</span></td>
  161. <td></td>
  162. </tr>
  163. <tr>
  164. <td><a class="xref" href="Terminal.Gui.KeyModifiers.html">KeyModifiers</a></td>
  165. <td><span class="parametername">km</span></td>
  166. <td></td>
  167. </tr>
  168. </tbody>
  169. </table>
  170. <h3 id="fields">Fields
  171. </h3>
  172. <span class="small pull-right mobile-hide">
  173. <span class="divider">|</span>
  174. <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/apidoc/new?filename=Terminal_Gui_KeyEvent_Key.md&amp;value=---%0Auid%3A%20Terminal.Gui.KeyEvent.Key%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
  175. </span>
  176. <span class="small pull-right mobile-hide">
  177. <a href="tig:tig/gui.cs/blob/main/Terminal.Gui/Core/Event.cs/#L485">View Source</a>
  178. </span>
  179. <h4 id="Terminal_Gui_KeyEvent_Key" data-uid="Terminal.Gui.KeyEvent.Key">Key</h4>
  180. <div class="markdown level1 summary">
  181. Symb olid definition for the key.
  182. </div>
  183. <div class="markdown level1 conceptual"></div>
  184. <h5 class="decalaration">Declaration</h5>
  185. <div class="codewrapper">
  186. <pre><code class="lang-csharp hljs">public Key Key</code></pre>
  187. </div>
  188. <h5 class="fieldValue">Field Value</h5>
  189. <table class="table table-bordered table-striped table-condensed">
  190. <thead>
  191. <tr>
  192. <th>Type</th>
  193. <th>Description</th>
  194. </tr>
  195. </thead>
  196. <tbody>
  197. <tr>
  198. <td><a class="xref" href="Terminal.Gui.Key.html">Key</a></td>
  199. <td></td>
  200. </tr>
  201. </tbody>
  202. </table>
  203. <h3 id="properties">Properties
  204. </h3>
  205. <span class="small pull-right mobile-hide">
  206. <span class="divider">|</span>
  207. <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/apidoc/new?filename=Terminal_Gui_KeyEvent_IsAlt.md&amp;value=---%0Auid%3A%20Terminal.Gui.KeyEvent.IsAlt%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
  208. </span>
  209. <span class="small pull-right mobile-hide">
  210. <a href="tig:tig/gui.cs/blob/main/Terminal.Gui/Core/Event.cs/#L504">View Source</a>
  211. </span>
  212. <a id="Terminal_Gui_KeyEvent_IsAlt_" data-uid="Terminal.Gui.KeyEvent.IsAlt*"></a>
  213. <h4 id="Terminal_Gui_KeyEvent_IsAlt" data-uid="Terminal.Gui.KeyEvent.IsAlt">IsAlt</h4>
  214. <div class="markdown level1 summary">
  215. Gets a value indicating whether the Alt key was pressed (real or synthesized)
  216. </div>
  217. <div class="markdown level1 conceptual"></div>
  218. <h5 class="decalaration">Declaration</h5>
  219. <div class="codewrapper">
  220. <pre><code class="lang-csharp hljs">public bool IsAlt { get; }</code></pre>
  221. </div>
  222. <h5 class="propertyValue">Property Value</h5>
  223. <table class="table table-bordered table-striped table-condensed">
  224. <thead>
  225. <tr>
  226. <th>Type</th>
  227. <th>Description</th>
  228. </tr>
  229. </thead>
  230. <tbody>
  231. <tr>
  232. <td><span class="xref">System.Boolean</span></td>
  233. <td><code>true</code> if is alternate; otherwise, <code>false</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/apidoc/new?filename=Terminal_Gui_KeyEvent_IsCapslock.md&amp;value=---%0Auid%3A%20Terminal.Gui.KeyEvent.IsCapslock%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
  240. </span>
  241. <span class="small pull-right mobile-hide">
  242. <a href="tig:tig/gui.cs/blob/main/Terminal.Gui/Core/Event.cs/#L517">View Source</a>
  243. </span>
  244. <a id="Terminal_Gui_KeyEvent_IsCapslock_" data-uid="Terminal.Gui.KeyEvent.IsCapslock*"></a>
  245. <h4 id="Terminal_Gui_KeyEvent_IsCapslock" data-uid="Terminal.Gui.KeyEvent.IsCapslock">IsCapslock</h4>
  246. <div class="markdown level1 summary">
  247. Gets a value indicating whether the Caps lock key was pressed (real or synthesized)
  248. </div>
  249. <div class="markdown level1 conceptual"></div>
  250. <h5 class="decalaration">Declaration</h5>
  251. <div class="codewrapper">
  252. <pre><code class="lang-csharp hljs">public bool IsCapslock { get; }</code></pre>
  253. </div>
  254. <h5 class="propertyValue">Property Value</h5>
  255. <table class="table table-bordered table-striped table-condensed">
  256. <thead>
  257. <tr>
  258. <th>Type</th>
  259. <th>Description</th>
  260. </tr>
  261. </thead>
  262. <tbody>
  263. <tr>
  264. <td><span class="xref">System.Boolean</span></td>
  265. <td><code>true</code> if is alternate; otherwise, <code>false</code>.</td>
  266. </tr>
  267. </tbody>
  268. </table>
  269. <span class="small pull-right mobile-hide">
  270. <span class="divider">|</span>
  271. <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/apidoc/new?filename=Terminal_Gui_KeyEvent_IsCtrl.md&amp;value=---%0Auid%3A%20Terminal.Gui.KeyEvent.IsCtrl%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
  272. </span>
  273. <span class="small pull-right mobile-hide">
  274. <a href="tig:tig/gui.cs/blob/main/Terminal.Gui/Core/Event.cs/#L511">View Source</a>
  275. </span>
  276. <a id="Terminal_Gui_KeyEvent_IsCtrl_" data-uid="Terminal.Gui.KeyEvent.IsCtrl*"></a>
  277. <h4 id="Terminal_Gui_KeyEvent_IsCtrl" data-uid="Terminal.Gui.KeyEvent.IsCtrl">IsCtrl</h4>
  278. <div class="markdown level1 summary">
  279. Determines whether the value is a control key (and NOT just the ctrl key)
  280. </div>
  281. <div class="markdown level1 conceptual"></div>
  282. <h5 class="decalaration">Declaration</h5>
  283. <div class="codewrapper">
  284. <pre><code class="lang-csharp hljs">public bool IsCtrl { get; }</code></pre>
  285. </div>
  286. <h5 class="propertyValue">Property Value</h5>
  287. <table class="table table-bordered table-striped table-condensed">
  288. <thead>
  289. <tr>
  290. <th>Type</th>
  291. <th>Description</th>
  292. </tr>
  293. </thead>
  294. <tbody>
  295. <tr>
  296. <td><span class="xref">System.Boolean</span></td>
  297. <td><code>true</code> if is ctrl; otherwise, <code>false</code>.</td>
  298. </tr>
  299. </tbody>
  300. </table>
  301. <span class="small pull-right mobile-hide">
  302. <span class="divider">|</span>
  303. <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/apidoc/new?filename=Terminal_Gui_KeyEvent_IsNumlock.md&amp;value=---%0Auid%3A%20Terminal.Gui.KeyEvent.IsNumlock%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
  304. </span>
  305. <span class="small pull-right mobile-hide">
  306. <a href="tig:tig/gui.cs/blob/main/Terminal.Gui/Core/Event.cs/#L523">View Source</a>
  307. </span>
  308. <a id="Terminal_Gui_KeyEvent_IsNumlock_" data-uid="Terminal.Gui.KeyEvent.IsNumlock*"></a>
  309. <h4 id="Terminal_Gui_KeyEvent_IsNumlock" data-uid="Terminal.Gui.KeyEvent.IsNumlock">IsNumlock</h4>
  310. <div class="markdown level1 summary">
  311. Gets a value indicating whether the Num lock key was pressed (real or synthesized)
  312. </div>
  313. <div class="markdown level1 conceptual"></div>
  314. <h5 class="decalaration">Declaration</h5>
  315. <div class="codewrapper">
  316. <pre><code class="lang-csharp hljs">public bool IsNumlock { get; }</code></pre>
  317. </div>
  318. <h5 class="propertyValue">Property Value</h5>
  319. <table class="table table-bordered table-striped table-condensed">
  320. <thead>
  321. <tr>
  322. <th>Type</th>
  323. <th>Description</th>
  324. </tr>
  325. </thead>
  326. <tbody>
  327. <tr>
  328. <td><span class="xref">System.Boolean</span></td>
  329. <td><code>true</code> if is alternate; otherwise, <code>false</code>.</td>
  330. </tr>
  331. </tbody>
  332. </table>
  333. <span class="small pull-right mobile-hide">
  334. <span class="divider">|</span>
  335. <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/apidoc/new?filename=Terminal_Gui_KeyEvent_IsScrolllock.md&amp;value=---%0Auid%3A%20Terminal.Gui.KeyEvent.IsScrolllock%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
  336. </span>
  337. <span class="small pull-right mobile-hide">
  338. <a href="tig:tig/gui.cs/blob/main/Terminal.Gui/Core/Event.cs/#L529">View Source</a>
  339. </span>
  340. <a id="Terminal_Gui_KeyEvent_IsScrolllock_" data-uid="Terminal.Gui.KeyEvent.IsScrolllock*"></a>
  341. <h4 id="Terminal_Gui_KeyEvent_IsScrolllock" data-uid="Terminal.Gui.KeyEvent.IsScrolllock">IsScrolllock</h4>
  342. <div class="markdown level1 summary">
  343. Gets a value indicating whether the Scroll lock key was pressed (real or synthesized)
  344. </div>
  345. <div class="markdown level1 conceptual"></div>
  346. <h5 class="decalaration">Declaration</h5>
  347. <div class="codewrapper">
  348. <pre><code class="lang-csharp hljs">public bool IsScrolllock { get; }</code></pre>
  349. </div>
  350. <h5 class="propertyValue">Property Value</h5>
  351. <table class="table table-bordered table-striped table-condensed">
  352. <thead>
  353. <tr>
  354. <th>Type</th>
  355. <th>Description</th>
  356. </tr>
  357. </thead>
  358. <tbody>
  359. <tr>
  360. <td><span class="xref">System.Boolean</span></td>
  361. <td><code>true</code> if is alternate; otherwise, <code>false</code>.</td>
  362. </tr>
  363. </tbody>
  364. </table>
  365. <span class="small pull-right mobile-hide">
  366. <span class="divider">|</span>
  367. <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/apidoc/new?filename=Terminal_Gui_KeyEvent_IsShift.md&amp;value=---%0Auid%3A%20Terminal.Gui.KeyEvent.IsShift%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
  368. </span>
  369. <span class="small pull-right mobile-hide">
  370. <a href="tig:tig/gui.cs/blob/main/Terminal.Gui/Core/Event.cs/#L498">View Source</a>
  371. </span>
  372. <a id="Terminal_Gui_KeyEvent_IsShift_" data-uid="Terminal.Gui.KeyEvent.IsShift*"></a>
  373. <h4 id="Terminal_Gui_KeyEvent_IsShift" data-uid="Terminal.Gui.KeyEvent.IsShift">IsShift</h4>
  374. <div class="markdown level1 summary">
  375. Gets a value indicating whether the Shift key was pressed.
  376. </div>
  377. <div class="markdown level1 conceptual"></div>
  378. <h5 class="decalaration">Declaration</h5>
  379. <div class="codewrapper">
  380. <pre><code class="lang-csharp hljs">public bool IsShift { get; }</code></pre>
  381. </div>
  382. <h5 class="propertyValue">Property Value</h5>
  383. <table class="table table-bordered table-striped table-condensed">
  384. <thead>
  385. <tr>
  386. <th>Type</th>
  387. <th>Description</th>
  388. </tr>
  389. </thead>
  390. <tbody>
  391. <tr>
  392. <td><span class="xref">System.Boolean</span></td>
  393. <td><code>true</code> if is shift; otherwise, <code>false</code>.</td>
  394. </tr>
  395. </tbody>
  396. </table>
  397. <span class="small pull-right mobile-hide">
  398. <span class="divider">|</span>
  399. <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/apidoc/new?filename=Terminal_Gui_KeyEvent_KeyValue.md&amp;value=---%0Auid%3A%20Terminal.Gui.KeyEvent.KeyValue%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
  400. </span>
  401. <span class="small pull-right mobile-hide">
  402. <a href="tig:tig/gui.cs/blob/main/Terminal.Gui/Core/Event.cs/#L492">View Source</a>
  403. </span>
  404. <a id="Terminal_Gui_KeyEvent_KeyValue_" data-uid="Terminal.Gui.KeyEvent.KeyValue*"></a>
  405. <h4 id="Terminal_Gui_KeyEvent_KeyValue" data-uid="Terminal.Gui.KeyEvent.KeyValue">KeyValue</h4>
  406. <div class="markdown level1 summary">
  407. The key value cast to an integer, you will typical use this for
  408. extracting the Unicode rune value out of a key, when none of the
  409. symbolic options are in use.
  410. </div>
  411. <div class="markdown level1 conceptual"></div>
  412. <h5 class="decalaration">Declaration</h5>
  413. <div class="codewrapper">
  414. <pre><code class="lang-csharp hljs">public int KeyValue { get; }</code></pre>
  415. </div>
  416. <h5 class="propertyValue">Property Value</h5>
  417. <table class="table table-bordered table-striped table-condensed">
  418. <thead>
  419. <tr>
  420. <th>Type</th>
  421. <th>Description</th>
  422. </tr>
  423. </thead>
  424. <tbody>
  425. <tr>
  426. <td><span class="xref">System.Int32</span></td>
  427. <td></td>
  428. </tr>
  429. </tbody>
  430. </table>
  431. <h3 id="methods">Methods
  432. </h3>
  433. <span class="small pull-right mobile-hide">
  434. <span class="divider">|</span>
  435. <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/apidoc/new?filename=Terminal_Gui_KeyEvent_ToString.md&amp;value=---%0Auid%3A%20Terminal.Gui.KeyEvent.ToString%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
  436. </span>
  437. <span class="small pull-right mobile-hide">
  438. <a href="tig:tig/gui.cs/blob/main/Terminal.Gui/Core/Event.cs/#L553">View Source</a>
  439. </span>
  440. <a id="Terminal_Gui_KeyEvent_ToString_" data-uid="Terminal.Gui.KeyEvent.ToString*"></a>
  441. <h4 id="Terminal_Gui_KeyEvent_ToString" data-uid="Terminal.Gui.KeyEvent.ToString">ToString()</h4>
  442. <div class="markdown level1 summary">
  443. Pretty prints the KeyEvent
  444. </div>
  445. <div class="markdown level1 conceptual"></div>
  446. <h5 class="decalaration">Declaration</h5>
  447. <div class="codewrapper">
  448. <pre><code class="lang-csharp hljs">public override string ToString()</code></pre>
  449. </div>
  450. <h5 class="returns">Returns</h5>
  451. <table class="table table-bordered table-striped table-condensed">
  452. <thead>
  453. <tr>
  454. <th>Type</th>
  455. <th>Description</th>
  456. </tr>
  457. </thead>
  458. <tbody>
  459. <tr>
  460. <td><span class="xref">System.String</span></td>
  461. <td></td>
  462. </tr>
  463. </tbody>
  464. </table>
  465. <h5 class="overrides">Overrides</h5>
  466. <div><span class="xref">System.Object.ToString()</span></div>
  467. </article>
  468. </div>
  469. <div class="hidden-sm col-md-2" role="complementary">
  470. <div class="sideaffix">
  471. <div class="contribution">
  472. <ul class="nav">
  473. <li>
  474. <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/apidoc/new?filename=Terminal_Gui_KeyEvent.md&amp;value=---%0Auid%3A%20Terminal.Gui.KeyEvent%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A" class="contribution-link">Improve this Doc</a>
  475. </li>
  476. <li>
  477. <a href="tig:tig/gui.cs/blob/main/Terminal.Gui/Core/Event.cs/#L479" class="contribution-link">View Source</a>
  478. </li>
  479. </ul>
  480. </div>
  481. <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
  482. <h5>In This Article</h5>
  483. <div></div>
  484. </nav>
  485. </div>
  486. </div>
  487. </div>
  488. </div>
  489. <footer>
  490. <div class="grad-bottom"></div>
  491. <div class="footer">
  492. <div class="container">
  493. <span class="pull-right">
  494. <a href="#top">Back to top</a>
  495. </span>
  496. <span>Generated by <strong>DocFX</strong></span>
  497. </div>
  498. </div>
  499. </footer>
  500. </div>
  501. <script type="text/javascript" src="../../styles/docfx.vendor.js"></script>
  502. <script type="text/javascript" src="../../styles/docfx.js"></script>
  503. <script type="text/javascript" src="../../styles/main.js"></script>
  504. </body>
  505. </html>