Terminal.Gui.ShortcutHelper.html 22 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617
  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 ShortcutHelper
  8. </title>
  9. <meta name="viewport" content="width=device-width">
  10. <meta name="title" content="Class ShortcutHelper
  11. ">
  12. <meta name="generator" content="docfx 2.56.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="../../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"></div>
  57. <div class="sr-items">
  58. <p><i class="glyphicon glyphicon-refresh index-loading"></i></p>
  59. </div>
  60. <ul id="pagination"></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.ShortcutHelper">
  73. <h1 id="Terminal_Gui_ShortcutHelper" data-uid="Terminal.Gui.ShortcutHelper" class="text-break">Class ShortcutHelper
  74. </h1>
  75. <div class="markdown level0 summary">
  76. Represents a helper to manipulate shortcut keys used on views.
  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">ShortcutHelper</span></div>
  83. </div>
  84. <div class="inheritedMembers">
  85. <h5>Inherited Members</h5>
  86. <div>
  87. <span class="xref">System.Object.Equals(System.Object)</span>
  88. </div>
  89. <div>
  90. <span class="xref">System.Object.Equals(System.Object, System.Object)</span>
  91. </div>
  92. <div>
  93. <span class="xref">System.Object.GetHashCode()</span>
  94. </div>
  95. <div>
  96. <span class="xref">System.Object.GetType()</span>
  97. </div>
  98. <div>
  99. <span class="xref">System.Object.MemberwiseClone()</span>
  100. </div>
  101. <div>
  102. <span class="xref">System.Object.ReferenceEquals(System.Object, System.Object)</span>
  103. </div>
  104. <div>
  105. <span class="xref">System.Object.ToString()</span>
  106. </div>
  107. </div>
  108. <h6><strong>Namespace</strong>: <a class="xref" href="Terminal.Gui.html">Terminal.Gui</a></h6>
  109. <h6><strong>Assembly</strong>: Terminal.Gui.dll</h6>
  110. <h5 id="Terminal_Gui_ShortcutHelper_syntax">Syntax</h5>
  111. <div class="codewrapper">
  112. <pre><code class="lang-csharp hljs">public class ShortcutHelper</code></pre>
  113. </div>
  114. <h3 id="properties">Properties
  115. </h3>
  116. <a id="Terminal_Gui_ShortcutHelper_Shortcut_" data-uid="Terminal.Gui.ShortcutHelper.Shortcut*"></a>
  117. <h4 id="Terminal_Gui_ShortcutHelper_Shortcut" data-uid="Terminal.Gui.ShortcutHelper.Shortcut">Shortcut</h4>
  118. <div class="markdown level1 summary">
  119. This is the global setting that can be used as a global shortcut to invoke the action on the view.
  120. </div>
  121. <div class="markdown level1 conceptual"></div>
  122. <h5 class="decalaration">Declaration</h5>
  123. <div class="codewrapper">
  124. <pre><code class="lang-csharp hljs">public virtual Key Shortcut { get; set; }</code></pre>
  125. </div>
  126. <h5 class="propertyValue">Property Value</h5>
  127. <table class="table table-bordered table-striped table-condensed">
  128. <thead>
  129. <tr>
  130. <th>Type</th>
  131. <th>Description</th>
  132. </tr>
  133. </thead>
  134. <tbody>
  135. <tr>
  136. <td><a class="xref" href="Terminal.Gui.Key.html">Key</a></td>
  137. <td></td>
  138. </tr>
  139. </tbody>
  140. </table>
  141. <a id="Terminal_Gui_ShortcutHelper_ShortcutAction_" data-uid="Terminal.Gui.ShortcutHelper.ShortcutAction*"></a>
  142. <h4 id="Terminal_Gui_ShortcutHelper_ShortcutAction" data-uid="Terminal.Gui.ShortcutHelper.ShortcutAction">ShortcutAction</h4>
  143. <div class="markdown level1 summary">
  144. The action to run if the <a class="xref" href="Terminal.Gui.ShortcutHelper.html#Terminal_Gui_ShortcutHelper_Shortcut">Shortcut</a> is defined.
  145. </div>
  146. <div class="markdown level1 conceptual"></div>
  147. <h5 class="decalaration">Declaration</h5>
  148. <div class="codewrapper">
  149. <pre><code class="lang-csharp hljs">public virtual Action ShortcutAction { get; set; }</code></pre>
  150. </div>
  151. <h5 class="propertyValue">Property Value</h5>
  152. <table class="table table-bordered table-striped table-condensed">
  153. <thead>
  154. <tr>
  155. <th>Type</th>
  156. <th>Description</th>
  157. </tr>
  158. </thead>
  159. <tbody>
  160. <tr>
  161. <td><span class="xref">System.Action</span></td>
  162. <td></td>
  163. </tr>
  164. </tbody>
  165. </table>
  166. <a id="Terminal_Gui_ShortcutHelper_ShortcutTag_" data-uid="Terminal.Gui.ShortcutHelper.ShortcutTag*"></a>
  167. <h4 id="Terminal_Gui_ShortcutHelper_ShortcutTag" data-uid="Terminal.Gui.ShortcutHelper.ShortcutTag">ShortcutTag</h4>
  168. <div class="markdown level1 summary">
  169. The keystroke combination used in the <a class="xref" href="Terminal.Gui.ShortcutHelper.html#Terminal_Gui_ShortcutHelper_Shortcut">Shortcut</a> as string.
  170. </div>
  171. <div class="markdown level1 conceptual"></div>
  172. <h5 class="decalaration">Declaration</h5>
  173. <div class="codewrapper">
  174. <pre><code class="lang-csharp hljs">public virtual ustring ShortcutTag { get; }</code></pre>
  175. </div>
  176. <h5 class="propertyValue">Property Value</h5>
  177. <table class="table table-bordered table-striped table-condensed">
  178. <thead>
  179. <tr>
  180. <th>Type</th>
  181. <th>Description</th>
  182. </tr>
  183. </thead>
  184. <tbody>
  185. <tr>
  186. <td><span class="xref">NStack.ustring</span></td>
  187. <td></td>
  188. </tr>
  189. </tbody>
  190. </table>
  191. <h3 id="methods">Methods
  192. </h3>
  193. <a id="Terminal_Gui_ShortcutHelper_CheckKeysFlagRange_" data-uid="Terminal.Gui.ShortcutHelper.CheckKeysFlagRange*"></a>
  194. <h4 id="Terminal_Gui_ShortcutHelper_CheckKeysFlagRange_Terminal_Gui_Key_Terminal_Gui_Key_Terminal_Gui_Key_" data-uid="Terminal.Gui.ShortcutHelper.CheckKeysFlagRange(Terminal.Gui.Key,Terminal.Gui.Key,Terminal.Gui.Key)">CheckKeysFlagRange(Key, Key, Key)</h4>
  195. <div class="markdown level1 summary">
  196. Lookup for a <a class="xref" href="Terminal.Gui.Key.html">Key</a> on range of keys.
  197. </div>
  198. <div class="markdown level1 conceptual"></div>
  199. <h5 class="decalaration">Declaration</h5>
  200. <div class="codewrapper">
  201. <pre><code class="lang-csharp hljs">public static bool CheckKeysFlagRange(Key key, Key first, Key last)</code></pre>
  202. </div>
  203. <h5 class="parameters">Parameters</h5>
  204. <table class="table table-bordered table-striped table-condensed">
  205. <thead>
  206. <tr>
  207. <th>Type</th>
  208. <th>Name</th>
  209. <th>Description</th>
  210. </tr>
  211. </thead>
  212. <tbody>
  213. <tr>
  214. <td><a class="xref" href="Terminal.Gui.Key.html">Key</a></td>
  215. <td><span class="parametername">key</span></td>
  216. <td>The source key.</td>
  217. </tr>
  218. <tr>
  219. <td><a class="xref" href="Terminal.Gui.Key.html">Key</a></td>
  220. <td><span class="parametername">first</span></td>
  221. <td>First key in range.</td>
  222. </tr>
  223. <tr>
  224. <td><a class="xref" href="Terminal.Gui.Key.html">Key</a></td>
  225. <td><span class="parametername">last</span></td>
  226. <td>Last key in range.</td>
  227. </tr>
  228. </tbody>
  229. </table>
  230. <h5 class="returns">Returns</h5>
  231. <table class="table table-bordered table-striped table-condensed">
  232. <thead>
  233. <tr>
  234. <th>Type</th>
  235. <th>Description</th>
  236. </tr>
  237. </thead>
  238. <tbody>
  239. <tr>
  240. <td><span class="xref">System.Boolean</span></td>
  241. <td></td>
  242. </tr>
  243. </tbody>
  244. </table>
  245. <a id="Terminal_Gui_ShortcutHelper_FindAndOpenByShortcut_" data-uid="Terminal.Gui.ShortcutHelper.FindAndOpenByShortcut*"></a>
  246. <h4 id="Terminal_Gui_ShortcutHelper_FindAndOpenByShortcut_Terminal_Gui_KeyEvent_Terminal_Gui_View_" data-uid="Terminal.Gui.ShortcutHelper.FindAndOpenByShortcut(Terminal.Gui.KeyEvent,Terminal.Gui.View)">FindAndOpenByShortcut(KeyEvent, View)</h4>
  247. <div class="markdown level1 summary">
  248. Allows a view to run a <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ShortcutAction">ShortcutAction</a> if defined.
  249. </div>
  250. <div class="markdown level1 conceptual"></div>
  251. <h5 class="decalaration">Declaration</h5>
  252. <div class="codewrapper">
  253. <pre><code class="lang-csharp hljs">public static bool FindAndOpenByShortcut(KeyEvent kb, View view = null)</code></pre>
  254. </div>
  255. <h5 class="parameters">Parameters</h5>
  256. <table class="table table-bordered table-striped table-condensed">
  257. <thead>
  258. <tr>
  259. <th>Type</th>
  260. <th>Name</th>
  261. <th>Description</th>
  262. </tr>
  263. </thead>
  264. <tbody>
  265. <tr>
  266. <td><a class="xref" href="Terminal.Gui.KeyEvent.html">KeyEvent</a></td>
  267. <td><span class="parametername">kb</span></td>
  268. <td>The <a class="xref" href="Terminal.Gui.KeyEvent.html">KeyEvent</a></td>
  269. </tr>
  270. <tr>
  271. <td><a class="xref" href="Terminal.Gui.View.html">View</a></td>
  272. <td><span class="parametername">view</span></td>
  273. <td>The <a class="xref" href="Terminal.Gui.View.html">View</a></td>
  274. </tr>
  275. </tbody>
  276. </table>
  277. <h5 class="returns">Returns</h5>
  278. <table class="table table-bordered table-striped table-condensed">
  279. <thead>
  280. <tr>
  281. <th>Type</th>
  282. <th>Description</th>
  283. </tr>
  284. </thead>
  285. <tbody>
  286. <tr>
  287. <td><span class="xref">System.Boolean</span></td>
  288. <td><code>true</code> if defined <code>false</code>otherwise.</td>
  289. </tr>
  290. </tbody>
  291. </table>
  292. <a id="Terminal_Gui_ShortcutHelper_GetKeyToString_" data-uid="Terminal.Gui.ShortcutHelper.GetKeyToString*"></a>
  293. <h4 id="Terminal_Gui_ShortcutHelper_GetKeyToString_Terminal_Gui_Key_Terminal_Gui_Key__" data-uid="Terminal.Gui.ShortcutHelper.GetKeyToString(Terminal.Gui.Key,Terminal.Gui.Key@)">GetKeyToString(Key, out Key)</h4>
  294. <div class="markdown level1 summary">
  295. Return key as string.
  296. </div>
  297. <div class="markdown level1 conceptual"></div>
  298. <h5 class="decalaration">Declaration</h5>
  299. <div class="codewrapper">
  300. <pre><code class="lang-csharp hljs">public static ustring GetKeyToString(Key key, out Key knm)</code></pre>
  301. </div>
  302. <h5 class="parameters">Parameters</h5>
  303. <table class="table table-bordered table-striped table-condensed">
  304. <thead>
  305. <tr>
  306. <th>Type</th>
  307. <th>Name</th>
  308. <th>Description</th>
  309. </tr>
  310. </thead>
  311. <tbody>
  312. <tr>
  313. <td><a class="xref" href="Terminal.Gui.Key.html">Key</a></td>
  314. <td><span class="parametername">key</span></td>
  315. <td>The key to extract.</td>
  316. </tr>
  317. <tr>
  318. <td><a class="xref" href="Terminal.Gui.Key.html">Key</a></td>
  319. <td><span class="parametername">knm</span></td>
  320. <td>Correspond to the non modifier key.</td>
  321. </tr>
  322. </tbody>
  323. </table>
  324. <h5 class="returns">Returns</h5>
  325. <table class="table table-bordered table-striped table-condensed">
  326. <thead>
  327. <tr>
  328. <th>Type</th>
  329. <th>Description</th>
  330. </tr>
  331. </thead>
  332. <tbody>
  333. <tr>
  334. <td><span class="xref">NStack.ustring</span></td>
  335. <td></td>
  336. </tr>
  337. </tbody>
  338. </table>
  339. <a id="Terminal_Gui_ShortcutHelper_GetModifiersKey_" data-uid="Terminal.Gui.ShortcutHelper.GetModifiersKey*"></a>
  340. <h4 id="Terminal_Gui_ShortcutHelper_GetModifiersKey_Terminal_Gui_KeyEvent_" data-uid="Terminal.Gui.ShortcutHelper.GetModifiersKey(Terminal.Gui.KeyEvent)">GetModifiersKey(KeyEvent)</h4>
  341. <div class="markdown level1 summary">
  342. Gets the key with all the keys modifiers, especially the shift key that sometimes have to be injected later.
  343. </div>
  344. <div class="markdown level1 conceptual"></div>
  345. <h5 class="decalaration">Declaration</h5>
  346. <div class="codewrapper">
  347. <pre><code class="lang-csharp hljs">public static Key GetModifiersKey(KeyEvent kb)</code></pre>
  348. </div>
  349. <h5 class="parameters">Parameters</h5>
  350. <table class="table table-bordered table-striped table-condensed">
  351. <thead>
  352. <tr>
  353. <th>Type</th>
  354. <th>Name</th>
  355. <th>Description</th>
  356. </tr>
  357. </thead>
  358. <tbody>
  359. <tr>
  360. <td><a class="xref" href="Terminal.Gui.KeyEvent.html">KeyEvent</a></td>
  361. <td><span class="parametername">kb</span></td>
  362. <td>The <a class="xref" href="Terminal.Gui.KeyEvent.html">KeyEvent</a> to check.</td>
  363. </tr>
  364. </tbody>
  365. </table>
  366. <h5 class="returns">Returns</h5>
  367. <table class="table table-bordered table-striped table-condensed">
  368. <thead>
  369. <tr>
  370. <th>Type</th>
  371. <th>Description</th>
  372. </tr>
  373. </thead>
  374. <tbody>
  375. <tr>
  376. <td><a class="xref" href="Terminal.Gui.Key.html">Key</a></td>
  377. <td>The <a class="xref" href="Terminal.Gui.KeyEvent.html#Terminal_Gui_KeyEvent_Key">Key</a> with all the keys modifiers.</td>
  378. </tr>
  379. </tbody>
  380. </table>
  381. <a id="Terminal_Gui_ShortcutHelper_GetShortcutFromTag_" data-uid="Terminal.Gui.ShortcutHelper.GetShortcutFromTag*"></a>
  382. <h4 id="Terminal_Gui_ShortcutHelper_GetShortcutFromTag_NStack_ustring_" data-uid="Terminal.Gui.ShortcutHelper.GetShortcutFromTag(NStack.ustring)">GetShortcutFromTag(ustring)</h4>
  383. <div class="markdown level1 summary">
  384. Allows to retrieve a <a class="xref" href="Terminal.Gui.Key.html">Key</a> from a <a class="xref" href="Terminal.Gui.ShortcutHelper.html#Terminal_Gui_ShortcutHelper_ShortcutTag">ShortcutTag</a>
  385. </div>
  386. <div class="markdown level1 conceptual"></div>
  387. <h5 class="decalaration">Declaration</h5>
  388. <div class="codewrapper">
  389. <pre><code class="lang-csharp hljs">public static Key GetShortcutFromTag(ustring tag)</code></pre>
  390. </div>
  391. <h5 class="parameters">Parameters</h5>
  392. <table class="table table-bordered table-striped table-condensed">
  393. <thead>
  394. <tr>
  395. <th>Type</th>
  396. <th>Name</th>
  397. <th>Description</th>
  398. </tr>
  399. </thead>
  400. <tbody>
  401. <tr>
  402. <td><span class="xref">NStack.ustring</span></td>
  403. <td><span class="parametername">tag</span></td>
  404. <td>The key as string.</td>
  405. </tr>
  406. </tbody>
  407. </table>
  408. <h5 class="returns">Returns</h5>
  409. <table class="table table-bordered table-striped table-condensed">
  410. <thead>
  411. <tr>
  412. <th>Type</th>
  413. <th>Description</th>
  414. </tr>
  415. </thead>
  416. <tbody>
  417. <tr>
  418. <td><a class="xref" href="Terminal.Gui.Key.html">Key</a></td>
  419. <td></td>
  420. </tr>
  421. </tbody>
  422. </table>
  423. <a id="Terminal_Gui_ShortcutHelper_GetShortcutTag_" data-uid="Terminal.Gui.ShortcutHelper.GetShortcutTag*"></a>
  424. <h4 id="Terminal_Gui_ShortcutHelper_GetShortcutTag_Terminal_Gui_Key_" data-uid="Terminal.Gui.ShortcutHelper.GetShortcutTag(Terminal.Gui.Key)">GetShortcutTag(Key)</h4>
  425. <div class="markdown level1 summary">
  426. Get the <a class="xref" href="Terminal.Gui.ShortcutHelper.html#Terminal_Gui_ShortcutHelper_Shortcut">Shortcut</a> key as string.
  427. </div>
  428. <div class="markdown level1 conceptual"></div>
  429. <h5 class="decalaration">Declaration</h5>
  430. <div class="codewrapper">
  431. <pre><code class="lang-csharp hljs">public static ustring GetShortcutTag(Key shortcut)</code></pre>
  432. </div>
  433. <h5 class="parameters">Parameters</h5>
  434. <table class="table table-bordered table-striped table-condensed">
  435. <thead>
  436. <tr>
  437. <th>Type</th>
  438. <th>Name</th>
  439. <th>Description</th>
  440. </tr>
  441. </thead>
  442. <tbody>
  443. <tr>
  444. <td><a class="xref" href="Terminal.Gui.Key.html">Key</a></td>
  445. <td><span class="parametername">shortcut</span></td>
  446. <td>The shortcut key.</td>
  447. </tr>
  448. </tbody>
  449. </table>
  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">NStack.ustring</span></td>
  461. <td></td>
  462. </tr>
  463. </tbody>
  464. </table>
  465. <a id="Terminal_Gui_ShortcutHelper_PostShortcutValidation_" data-uid="Terminal.Gui.ShortcutHelper.PostShortcutValidation*"></a>
  466. <h4 id="Terminal_Gui_ShortcutHelper_PostShortcutValidation_Terminal_Gui_Key_" data-uid="Terminal.Gui.ShortcutHelper.PostShortcutValidation(Terminal.Gui.Key)">PostShortcutValidation(Key)</h4>
  467. <div class="markdown level1 summary">
  468. Used at key up validation.
  469. </div>
  470. <div class="markdown level1 conceptual"></div>
  471. <h5 class="decalaration">Declaration</h5>
  472. <div class="codewrapper">
  473. <pre><code class="lang-csharp hljs">public static bool PostShortcutValidation(Key key)</code></pre>
  474. </div>
  475. <h5 class="parameters">Parameters</h5>
  476. <table class="table table-bordered table-striped table-condensed">
  477. <thead>
  478. <tr>
  479. <th>Type</th>
  480. <th>Name</th>
  481. <th>Description</th>
  482. </tr>
  483. </thead>
  484. <tbody>
  485. <tr>
  486. <td><a class="xref" href="Terminal.Gui.Key.html">Key</a></td>
  487. <td><span class="parametername">key</span></td>
  488. <td>The key to validate.</td>
  489. </tr>
  490. </tbody>
  491. </table>
  492. <h5 class="returns">Returns</h5>
  493. <table class="table table-bordered table-striped table-condensed">
  494. <thead>
  495. <tr>
  496. <th>Type</th>
  497. <th>Description</th>
  498. </tr>
  499. </thead>
  500. <tbody>
  501. <tr>
  502. <td><span class="xref">System.Boolean</span></td>
  503. <td><code>true</code> if is valid.<code>false</code>otherwise.</td>
  504. </tr>
  505. </tbody>
  506. </table>
  507. <a id="Terminal_Gui_ShortcutHelper_PreShortcutValidation_" data-uid="Terminal.Gui.ShortcutHelper.PreShortcutValidation*"></a>
  508. <h4 id="Terminal_Gui_ShortcutHelper_PreShortcutValidation_Terminal_Gui_Key_" data-uid="Terminal.Gui.ShortcutHelper.PreShortcutValidation(Terminal.Gui.Key)">PreShortcutValidation(Key)</h4>
  509. <div class="markdown level1 summary">
  510. Used at key down or key press validation.
  511. </div>
  512. <div class="markdown level1 conceptual"></div>
  513. <h5 class="decalaration">Declaration</h5>
  514. <div class="codewrapper">
  515. <pre><code class="lang-csharp hljs">public static bool PreShortcutValidation(Key key)</code></pre>
  516. </div>
  517. <h5 class="parameters">Parameters</h5>
  518. <table class="table table-bordered table-striped table-condensed">
  519. <thead>
  520. <tr>
  521. <th>Type</th>
  522. <th>Name</th>
  523. <th>Description</th>
  524. </tr>
  525. </thead>
  526. <tbody>
  527. <tr>
  528. <td><a class="xref" href="Terminal.Gui.Key.html">Key</a></td>
  529. <td><span class="parametername">key</span></td>
  530. <td>The key to validate.</td>
  531. </tr>
  532. </tbody>
  533. </table>
  534. <h5 class="returns">Returns</h5>
  535. <table class="table table-bordered table-striped table-condensed">
  536. <thead>
  537. <tr>
  538. <th>Type</th>
  539. <th>Description</th>
  540. </tr>
  541. </thead>
  542. <tbody>
  543. <tr>
  544. <td><span class="xref">System.Boolean</span></td>
  545. <td><code>true</code> if is valid.<code>false</code>otherwise.</td>
  546. </tr>
  547. </tbody>
  548. </table>
  549. </article>
  550. </div>
  551. <div class="hidden-sm col-md-2" role="complementary">
  552. <div class="sideaffix">
  553. <div class="contribution">
  554. <ul class="nav">
  555. </ul>
  556. </div>
  557. <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
  558. <!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
  559. </nav>
  560. </div>
  561. </div>
  562. </div>
  563. </div>
  564. <footer>
  565. <div class="grad-bottom"></div>
  566. <div class="footer">
  567. <div class="container">
  568. <span class="pull-right">
  569. <a href="#top">Back to top</a>
  570. </span>
  571. <span>Generated by <strong>DocFX</strong></span>
  572. </div>
  573. </div>
  574. </footer>
  575. </div>
  576. <script type="text/javascript" src="../../styles/docfx.vendor.js"></script>
  577. <script type="text/javascript" src="../../styles/docfx.js"></script>
  578. <script type="text/javascript" src="../../styles/main.js"></script>
  579. </body>
  580. </html>