Terminal.Gui.View.KeyEventEventArgs.html 9.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253
  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 View.KeyEventEventArgs
  8. </title>
  9. <meta name="viewport" content="width=device-width">
  10. <meta name="title" content="Class View.KeyEventEventArgs
  11. ">
  12. <meta name="generator" content="docfx 2.56.7.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="../../toc.html">
  18. <meta property="docfx:tocrel" content="toc.html">
  19. <meta property="docfx:rel" content="../../">
  20. </head>
  21. <body data-spy="scroll" data-target="#affix" data-offset="120">
  22. <div id="wrapper">
  23. <header>
  24. <nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation">
  25. <div class="container">
  26. <div class="navbar-header">
  27. <button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
  28. <span class="sr-only">Toggle navigation</span>
  29. <span class="icon-bar"></span>
  30. <span class="icon-bar"></span>
  31. <span class="icon-bar"></span>
  32. </button>
  33. <a class="navbar-brand" href="../../index.html">
  34. <img id="logo" class="svg" src="../../images/logo48.png" alt="">
  35. </a>
  36. </div>
  37. <div class="collapse navbar-collapse" id="navbar">
  38. <form class="navbar-form navbar-right" role="search" id="search">
  39. <div class="form-group">
  40. <input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">
  41. </div>
  42. </form>
  43. </div>
  44. </div>
  45. </nav>
  46. <div class="subnav navbar navbar-default">
  47. <div class="container hide-when-search" id="breadcrumb">
  48. <ul class="breadcrumb">
  49. <li></li>
  50. </ul>
  51. </div>
  52. </div>
  53. </header>
  54. <div class="container body-content">
  55. <div id="search-results">
  56. <div class="search-list">Search Results for <span></span></div>
  57. <div class="sr-items">
  58. <p><i class="glyphicon glyphicon-refresh index-loading"></i></p>
  59. </div>
  60. <ul id="pagination" data-first="First" data-prev="Previous" data-next="Next" data-last="Last"></ul>
  61. </div>
  62. </div>
  63. <div role="main" class="container body-content hide-when-search">
  64. <div class="sidenav hide-when-search">
  65. <a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
  66. <div class="sidetoggle collapse" id="sidetoggle">
  67. <div id="sidetoc"></div>
  68. </div>
  69. </div>
  70. <div class="article row grid-right">
  71. <div class="col-md-10">
  72. <article class="content wrap" id="_content" data-uid="Terminal.Gui.View.KeyEventEventArgs">
  73. <h1 id="Terminal_Gui_View_KeyEventEventArgs" data-uid="Terminal.Gui.View.KeyEventEventArgs" class="text-break">Class View.KeyEventEventArgs
  74. </h1>
  75. <div class="markdown level0 summary">
  76. Defines the event arguments for <a class="xref" href="Terminal.Gui.View.KeyEventEventArgs.html#Terminal_Gui_View_KeyEventEventArgs_KeyEvent">KeyEvent</a>
  77. </div>
  78. <div class="markdown level0 conceptual"></div>
  79. <div class="inheritance">
  80. <h5>Inheritance</h5>
  81. <div class="level0"><span class="xref">System.Object</span></div>
  82. <div class="level1"><span class="xref">System.EventArgs</span></div>
  83. <div class="level2"><span class="xref">View.KeyEventEventArgs</span></div>
  84. </div>
  85. <div class="inheritedMembers">
  86. <h5>Inherited Members</h5>
  87. <div>
  88. <span class="xref">System.EventArgs.Empty</span>
  89. </div>
  90. <div>
  91. <span class="xref">System.Object.Equals(System.Object)</span>
  92. </div>
  93. <div>
  94. <span class="xref">System.Object.Equals(System.Object, System.Object)</span>
  95. </div>
  96. <div>
  97. <span class="xref">System.Object.GetHashCode()</span>
  98. </div>
  99. <div>
  100. <span class="xref">System.Object.GetType()</span>
  101. </div>
  102. <div>
  103. <span class="xref">System.Object.MemberwiseClone()</span>
  104. </div>
  105. <div>
  106. <span class="xref">System.Object.ReferenceEquals(System.Object, System.Object)</span>
  107. </div>
  108. <div>
  109. <span class="xref">System.Object.ToString()</span>
  110. </div>
  111. </div>
  112. <h6><strong>Namespace</strong>: <a class="xref" href="Terminal.Gui.html">Terminal.Gui</a></h6>
  113. <h6><strong>Assembly</strong>: Terminal.Gui.dll</h6>
  114. <h5 id="Terminal_Gui_View_KeyEventEventArgs_syntax">Syntax</h5>
  115. <div class="codewrapper">
  116. <pre><code class="lang-csharp hljs">public class KeyEventEventArgs : EventArgs</code></pre>
  117. </div>
  118. <h3 id="constructors">Constructors
  119. </h3>
  120. <a id="Terminal_Gui_View_KeyEventEventArgs__ctor_" data-uid="Terminal.Gui.View.KeyEventEventArgs.#ctor*"></a>
  121. <h4 id="Terminal_Gui_View_KeyEventEventArgs__ctor_Terminal_Gui_KeyEvent_" data-uid="Terminal.Gui.View.KeyEventEventArgs.#ctor(Terminal.Gui.KeyEvent)">KeyEventEventArgs(KeyEvent)</h4>
  122. <div class="markdown level1 summary">
  123. Constructs.
  124. </div>
  125. <div class="markdown level1 conceptual"></div>
  126. <h5 class="decalaration">Declaration</h5>
  127. <div class="codewrapper">
  128. <pre><code class="lang-csharp hljs">public KeyEventEventArgs(KeyEvent ke)</code></pre>
  129. </div>
  130. <h5 class="parameters">Parameters</h5>
  131. <table class="table table-bordered table-striped table-condensed">
  132. <thead>
  133. <tr>
  134. <th>Type</th>
  135. <th>Name</th>
  136. <th>Description</th>
  137. </tr>
  138. </thead>
  139. <tbody>
  140. <tr>
  141. <td><a class="xref" href="Terminal.Gui.KeyEvent.html">KeyEvent</a></td>
  142. <td><span class="parametername">ke</span></td>
  143. <td></td>
  144. </tr>
  145. </tbody>
  146. </table>
  147. <h3 id="properties">Properties
  148. </h3>
  149. <a id="Terminal_Gui_View_KeyEventEventArgs_Handled_" data-uid="Terminal.Gui.View.KeyEventEventArgs.Handled*"></a>
  150. <h4 id="Terminal_Gui_View_KeyEventEventArgs_Handled" data-uid="Terminal.Gui.View.KeyEventEventArgs.Handled">Handled</h4>
  151. <div class="markdown level1 summary">
  152. Indicates if the current Key event has already been processed and the driver should stop notifying any other event subscriber.
  153. Its important to set this value to true specially when updating any View&apos;s layout from inside the subscriber method.
  154. </div>
  155. <div class="markdown level1 conceptual"></div>
  156. <h5 class="decalaration">Declaration</h5>
  157. <div class="codewrapper">
  158. <pre><code class="lang-csharp hljs">public bool Handled { get; set; }</code></pre>
  159. </div>
  160. <h5 class="propertyValue">Property Value</h5>
  161. <table class="table table-bordered table-striped table-condensed">
  162. <thead>
  163. <tr>
  164. <th>Type</th>
  165. <th>Description</th>
  166. </tr>
  167. </thead>
  168. <tbody>
  169. <tr>
  170. <td><span class="xref">System.Boolean</span></td>
  171. <td></td>
  172. </tr>
  173. </tbody>
  174. </table>
  175. <a id="Terminal_Gui_View_KeyEventEventArgs_KeyEvent_" data-uid="Terminal.Gui.View.KeyEventEventArgs.KeyEvent*"></a>
  176. <h4 id="Terminal_Gui_View_KeyEventEventArgs_KeyEvent" data-uid="Terminal.Gui.View.KeyEventEventArgs.KeyEvent">KeyEvent</h4>
  177. <div class="markdown level1 summary">
  178. The <a class="xref" href="Terminal.Gui.View.KeyEventEventArgs.html#Terminal_Gui_View_KeyEventEventArgs_KeyEvent">KeyEvent</a> for the event.
  179. </div>
  180. <div class="markdown level1 conceptual"></div>
  181. <h5 class="decalaration">Declaration</h5>
  182. <div class="codewrapper">
  183. <pre><code class="lang-csharp hljs">public KeyEvent KeyEvent { get; set; }</code></pre>
  184. </div>
  185. <h5 class="propertyValue">Property Value</h5>
  186. <table class="table table-bordered table-striped table-condensed">
  187. <thead>
  188. <tr>
  189. <th>Type</th>
  190. <th>Description</th>
  191. </tr>
  192. </thead>
  193. <tbody>
  194. <tr>
  195. <td><a class="xref" href="Terminal.Gui.KeyEvent.html">KeyEvent</a></td>
  196. <td></td>
  197. </tr>
  198. </tbody>
  199. </table>
  200. </article>
  201. </div>
  202. <div class="hidden-sm col-md-2" role="complementary">
  203. <div class="sideaffix">
  204. <div class="contribution">
  205. <ul class="nav">
  206. </ul>
  207. </div>
  208. <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
  209. <h5>In This Article</h5>
  210. <div></div>
  211. </nav>
  212. </div>
  213. </div>
  214. </div>
  215. </div>
  216. <footer>
  217. <div class="grad-bottom"></div>
  218. <div class="footer">
  219. <div class="container">
  220. <span class="pull-right">
  221. <a href="#top">Back to top</a>
  222. </span>
  223. <span>Generated by <strong>DocFX</strong></span>
  224. </div>
  225. </div>
  226. </footer>
  227. </div>
  228. <script type="text/javascript" src="../../styles/docfx.vendor.js"></script>
  229. <script type="text/javascript" src="../../styles/docfx.js"></script>
  230. <script type="text/javascript" src="../../styles/main.js"></script>
  231. </body>
  232. </html>