Etusivu Tutki Apua
Kirjaudu sisään
csharp
/
gui-cs.Terminal.Gui
peilaus alkaen https://github.com/gui-cs/Terminal.Gui.git
2
0
Fork 0
Tiedostot Ongelmat 0 Wiki
Puu: af7901066a
Haarat Tagit
gui-cs.Terminal...
/
docs
/
api
/
Terminal.Gui
/
Terminal.Gui.ShortcutHelper.html

Terminal.Gui.ShortcutHelper.html 31 KB
Historia Raaka

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690 
  1. <!DOCTYPE html>
    2. 

  2. <!--[if IE]><![endif]-->
    3. 

  3. <html>
    4. 

  4.   
    5. 

  5.   <head>
    6. 

  6.     <meta charset="utf-8">
    7. 

  7.     <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
    8. 

  8.     <title>Class ShortcutHelper
    9. 

  9.    </title>
    10. 

  10.     <meta name="viewport" content="width=device-width">
    11. 

  11.     <meta name="title" content="Class ShortcutHelper
    12. 

  12.    ">
    13. 

  13.     <meta name="generator" content="docfx 2.59.4.0">
    14. 

  14.     
    15. 

  15.     <link rel="shortcut icon" href="../../favicon.ico">
    16. 

  16.     <link rel="stylesheet" href="../../styles/docfx.vendor.css">
    17. 

  17.     <link rel="stylesheet" href="../../styles/docfx.css">
    18. 

  18.     <link rel="stylesheet" href="../../styles/main.css">
    19. 

  19.     <link href="https://fonts.googleapis.com/css?family=Source Sans Pro" rel="stylesheet"> 
    20. 

  20.     <link href="https://fonts.googleapis.com/css?family=Source Code Pro" rel="stylesheet"> 
    21. 

  21.     <meta property="docfx:navrel" content="../../toc.html">
    22. 

  22.     <meta property="docfx:tocrel" content="toc.html">
    23. 

  23.     
    24. 

  24.     <meta property="docfx:rel" content="../../">
    25. 

  25.     
    26. 

  26.   </head>  <body data-spy="scroll" data-target="#affix" data-offset="120">
    27. 

  27.     <div id="wrapper">
    28. 

  28.       <header>
    29. 

  29.         
    30. 

  30.         <nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation">
    31. 

  31.           <div class="container">
    32. 

  32.             <div class="navbar-header">
    33. 

  33.               <button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
    34. 

  34.                 <span class="sr-only">Toggle navigation</span>
    35. 

  35.                 <span class="icon-bar"></span>
    36. 

  36.                 <span class="icon-bar"></span>
    37. 

  37.                 <span class="icon-bar"></span>
    38. 

  38.               </button>
    39. 

  39.               
    40. 

  40.               <a class="navbar-brand" href="../../index.html">
    41. 

  41.                 <img id="logo" class="svg" src="../../images/logo48.png" alt="">
    42. 

  42.               </a>
    43. 

  43.             </div>
    44. 

  44.             <div class="collapse navbar-collapse" id="navbar">
    45. 

  45.               <form class="navbar-form navbar-right" role="search" id="search">
    46. 

  46.                 <div class="form-group">
    47. 

  47.                   <input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">
    48. 

  48.                 </div>
    49. 

  49.               </form>
    50. 

  50.             </div>
    51. 

  51.           </div>
    52. 

  52.         </nav>
    53. 

  53.         
    54. 

  54.         <div class="subnav navbar navbar-default">
    55. 

  55.           <div class="container hide-when-search" id="breadcrumb">
    56. 

  56.             <ul class="breadcrumb">
    57. 

  57.               <li></li>
    58. 

  58.             </ul>
    59. 

  59.           </div>
    60. 

  60.         </div>
    61. 

  61.       </header>
    62. 

  62.       <div class="container body-content">
    63. 

  63.         
    64. 

  64.         <div id="search-results">
    65. 

  65.           <div class="search-list">Search Results for <span></span></div>
    66. 

  66.           <div class="sr-items">
    67. 

  67.             <p><i class="glyphicon glyphicon-refresh index-loading"></i></p>
    68. 

  68.           </div>
    69. 

  69.           <ul id="pagination" data-first="First" data-prev="Previous" data-next="Next" data-last="Last"></ul>
    70. 

  70.         </div>
    71. 

  71.       </div>
    72. 

  72.       <div role="main" class="container body-content hide-when-search">
    73. 

  73.         
    74. 

  74.         <div class="sidenav hide-when-search">
    75. 

  75.           <a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
    76. 

  76.           <div class="sidetoggle collapse" id="sidetoggle">
    77. 

  77.             <div id="sidetoc"></div>
    78. 

  78.           </div>
    79. 

  79.         </div>
    80. 

  80.         <div class="article row grid-right">
    81. 

  81.           <div class="col-md-10">
    82. 

  82.             <article class="content wrap" id="_content" data-uid="Terminal.Gui.ShortcutHelper">
    83. 

  83.   
    84. 

  84.   
    85. 

  85.   <h1 id="Terminal_Gui_ShortcutHelper" data-uid="Terminal.Gui.ShortcutHelper" class="text-break">Class ShortcutHelper
    86. 

  86.   </h1>
    87. 

  87.   <div class="markdown level0 summary">
    88. 

  88. Represents a helper to manipulate shortcut keys used on views.
    89. 

  89. </div>
    90. 

  90.   <div class="markdown level0 conceptual"></div>
    91. 

  91.   <div class="inheritance">
    92. 

  92.     <h5>Inheritance</h5>
    93. 

  93.     <div class="level0"><span class="xref">System.Object</span></div>
    94. 

  94.     <div class="level1"><span class="xref">ShortcutHelper</span></div>
    95. 

  95.   </div>
    96. 

  96.   <div class="inheritedMembers">
    97. 

  97.     <h5>Inherited Members</h5>
    98. 

  98.     <div>
    99. 

  99.       <span class="xref">System.Object.Equals(System.Object)</span>
    100. 

  100.     </div>
    101. 

  101.     <div>
    102. 

  102.       <span class="xref">System.Object.Equals(System.Object, System.Object)</span>
    103. 

  103.     </div>
    104. 

  104.     <div>
    105. 

  105.       <span class="xref">System.Object.GetHashCode()</span>
    106. 

  106.     </div>
    107. 

  107.     <div>
    108. 

  108.       <span class="xref">System.Object.GetType()</span>
    109. 

  109.     </div>
    110. 

  110.     <div>
    111. 

  111.       <span class="xref">System.Object.MemberwiseClone()</span>
    112. 

  112.     </div>
    113. 

  113.     <div>
    114. 

  114.       <span class="xref">System.Object.ReferenceEquals(System.Object, System.Object)</span>
    115. 

  115.     </div>
    116. 

  116.     <div>
    117. 

  117.       <span class="xref">System.Object.ToString()</span>
    118. 

  118.     </div>
    119. 

  119.   </div>
    120. 

  120.   <h6><strong>Namespace</strong>: <a class="xref" href="Terminal.Gui.html">Terminal.Gui</a></h6>
    121. 

  121.   <h6><strong>Assembly</strong>: Terminal.Gui.dll</h6>
    122. 

  122.   <h5 id="Terminal_Gui_ShortcutHelper_syntax">Syntax</h5>
    123. 

  123.   <div class="codewrapper">
    124. 

  124.     <pre><code class="lang-csharp hljs">public class ShortcutHelper</code></pre>
    125. 

  125.   </div>
    126. 

  126.   <h3 id="properties">Properties
    127. 

  127.   </h3>
    128. 

  128.   <span class="small pull-right mobile-hide">
    129. 

  129.     <span class="divider">|</span>
    130. 

  130.     <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/apidoc/new?filename=Terminal_Gui_ShortcutHelper_Shortcut.md&amp;value=---%0Auid%3A%20Terminal.Gui.ShortcutHelper.Shortcut%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>
    131. 

  131.   </span>
    132. 

  132.   <span class="small pull-right mobile-hide">
    133. 

  133.     <a href="tig:tig/gui.cs/blob/main/Terminal.Gui/Core/ShortcutHelper.cs/#L18">View Source</a>
    134. 

  134.   </span>
    135. 

  135.   <a id="Terminal_Gui_ShortcutHelper_Shortcut_" data-uid="Terminal.Gui.ShortcutHelper.Shortcut*"></a>
    136. 

  136.   <h4 id="Terminal_Gui_ShortcutHelper_Shortcut" data-uid="Terminal.Gui.ShortcutHelper.Shortcut">Shortcut</h4>
    137. 

  137.   <div class="markdown level1 summary">
    138. 

  138. This is the global setting that can be used as a global shortcut to invoke the action on the view.
    139. 

  139. </div>
    140. 

  140.   <div class="markdown level1 conceptual"></div>
    141. 

  141.   <h5 class="decalaration">Declaration</h5>
    142. 

  142.   <div class="codewrapper">
    143. 

  143.     <pre><code class="lang-csharp hljs">public virtual Key Shortcut { get; set; }</code></pre>
    144. 

  144.   </div>
    145. 

  145.   <h5 class="propertyValue">Property Value</h5>
    146. 

  146.   <table class="table table-bordered table-striped table-condensed">
    147. 

  147.     <thead>
    148. 

  148.       <tr>
    149. 

  149.         <th>Type</th>
    150. 

  150.         <th>Description</th>
    151. 

  151.       </tr>
    152. 

  152.     </thead>
    153. 

  153.     <tbody>
    154. 

  154.       <tr>
    155. 

  155.         <td><a class="xref" href="Terminal.Gui.Key.html">Key</a></td>
    156. 

  156.         <td></td>
    157. 

  157.       </tr>
    158. 

  158.     </tbody>
    159. 

  159.   </table>
    160. 

  160.   <span class="small pull-right mobile-hide">
    161. 

  161.     <span class="divider">|</span>
    162. 

  162.     <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/apidoc/new?filename=Terminal_Gui_ShortcutHelper_ShortcutAction.md&amp;value=---%0Auid%3A%20Terminal.Gui.ShortcutHelper.ShortcutAction%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>
    163. 

  163.   </span>
    164. 

  164.   <span class="small pull-right mobile-hide">
    165. 

  165.     <a href="tig:tig/gui.cs/blob/main/Terminal.Gui/Core/ShortcutHelper.cs/#L35">View Source</a>
    166. 

  166.   </span>
    167. 

  167.   <a id="Terminal_Gui_ShortcutHelper_ShortcutAction_" data-uid="Terminal.Gui.ShortcutHelper.ShortcutAction*"></a>
    168. 

  168.   <h4 id="Terminal_Gui_ShortcutHelper_ShortcutAction" data-uid="Terminal.Gui.ShortcutHelper.ShortcutAction">ShortcutAction</h4>
    169. 

  169.   <div class="markdown level1 summary">
    170. 

  170. The action to run if the <a class="xref" href="Terminal.Gui.ShortcutHelper.html#Terminal_Gui_ShortcutHelper_Shortcut">Shortcut</a> is defined.
    171. 

  171. </div>
    172. 

  172.   <div class="markdown level1 conceptual"></div>
    173. 

  173.   <h5 class="decalaration">Declaration</h5>
    174. 

  174.   <div class="codewrapper">
    175. 

  175.     <pre><code class="lang-csharp hljs">public virtual Action ShortcutAction { get; set; }</code></pre>
    176. 

  176.   </div>
    177. 

  177.   <h5 class="propertyValue">Property Value</h5>
    178. 

  178.   <table class="table table-bordered table-striped table-condensed">
    179. 

  179.     <thead>
    180. 

  180.       <tr>
    181. 

  181.         <th>Type</th>
    182. 

  182.         <th>Description</th>
    183. 

  183.       </tr>
    184. 

  184.     </thead>
    185. 

  185.     <tbody>
    186. 

  186.       <tr>
    187. 

  187.         <td><span class="xref">System.Action</span></td>
    188. 

  188.         <td></td>
    189. 

  189.       </tr>
    190. 

  190.     </tbody>
    191. 

  191.   </table>
    192. 

  192.   <span class="small pull-right mobile-hide">
    193. 

  193.     <span class="divider">|</span>
    194. 

  194.     <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/apidoc/new?filename=Terminal_Gui_ShortcutHelper_ShortcutTag.md&amp;value=---%0Auid%3A%20Terminal.Gui.ShortcutHelper.ShortcutTag%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>
    195. 

  195.   </span>
    196. 

  196.   <span class="small pull-right mobile-hide">
    197. 

  197.     <a href="tig:tig/gui.cs/blob/main/Terminal.Gui/Core/ShortcutHelper.cs/#L30">View Source</a>
    198. 

  198.   </span>
    199. 

  199.   <a id="Terminal_Gui_ShortcutHelper_ShortcutTag_" data-uid="Terminal.Gui.ShortcutHelper.ShortcutTag*"></a>
    200. 

  200.   <h4 id="Terminal_Gui_ShortcutHelper_ShortcutTag" data-uid="Terminal.Gui.ShortcutHelper.ShortcutTag">ShortcutTag</h4>
    201. 

  201.   <div class="markdown level1 summary">
    202. 

  202. The keystroke combination used in the <a class="xref" href="Terminal.Gui.ShortcutHelper.html#Terminal_Gui_ShortcutHelper_Shortcut">Shortcut</a> as string.
    203. 

  203. </div>
    204. 

  204.   <div class="markdown level1 conceptual"></div>
    205. 

  205.   <h5 class="decalaration">Declaration</h5>
    206. 

  206.   <div class="codewrapper">
    207. 

  207.     <pre><code class="lang-csharp hljs">public virtual ustring ShortcutTag { get; }</code></pre>
    208. 

  208.   </div>
    209. 

  209.   <h5 class="propertyValue">Property Value</h5>
    210. 

  210.   <table class="table table-bordered table-striped table-condensed">
    211. 

  211.     <thead>
    212. 

  212.       <tr>
    213. 

  213.         <th>Type</th>
    214. 

  214.         <th>Description</th>
    215. 

  215.       </tr>
    216. 

  216.     </thead>
    217. 

  217.     <tbody>
    218. 

  218.       <tr>
    219. 

  219.         <td><span class="xref">NStack.ustring</span></td>
    220. 

  220.         <td></td>
    221. 

  221.       </tr>
    222. 

  222.     </tbody>
    223. 

  223.   </table>
    224. 

  224.   <h3 id="methods">Methods
    225. 

  225.   </h3>
    226. 

  226.   <span class="small pull-right mobile-hide">
    227. 

  227.     <span class="divider">|</span>
    228. 

  228.     <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/apidoc/new?filename=Terminal_Gui_ShortcutHelper_CheckKeysFlagRange_Terminal_Gui_Key_Terminal_Gui_Key_Terminal_Gui_Key_.md&amp;value=---%0Auid%3A%20Terminal.Gui.ShortcutHelper.CheckKeysFlagRange(Terminal.Gui.Key%2CTerminal.Gui.Key%2CTerminal.Gui.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>
    229. 

  229.   </span>
    230. 

  230.   <span class="small pull-right mobile-hide">
    231. 

  231.     <a href="tig:tig/gui.cs/blob/main/Terminal.Gui/Core/ShortcutHelper.cs/#L198">View Source</a>
    232. 

  232.   </span>
    233. 

  233.   <a id="Terminal_Gui_ShortcutHelper_CheckKeysFlagRange_" data-uid="Terminal.Gui.ShortcutHelper.CheckKeysFlagRange*"></a>
    234. 

  234.   <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>
    235. 

  235.   <div class="markdown level1 summary">
    236. 

  236. Lookup for a <a class="xref" href="Terminal.Gui.Key.html">Key</a> on range of keys.
    237. 

  237. </div>
    238. 

  238.   <div class="markdown level1 conceptual"></div>
    239. 

  239.   <h5 class="decalaration">Declaration</h5>
    240. 

  240.   <div class="codewrapper">
    241. 

  241.     <pre><code class="lang-csharp hljs">public static bool CheckKeysFlagRange(Key key, Key first, Key last)</code></pre>
    242. 

  242.   </div>
    243. 

  243.   <h5 class="parameters">Parameters</h5>
    244. 

  244.   <table class="table table-bordered table-striped table-condensed">
    245. 

  245.     <thead>
    246. 

  246.       <tr>
    247. 

  247.         <th>Type</th>
    248. 

  248.         <th>Name</th>
    249. 

  249.         <th>Description</th>
    250. 

  250.       </tr>
    251. 

  251.     </thead>
    252. 

  252.     <tbody>
    253. 

  253.       <tr>
    254. 

  254.         <td><a class="xref" href="Terminal.Gui.Key.html">Key</a></td>
    255. 

  255.         <td><span class="parametername">key</span></td>
    256. 

  256.         <td>The source key.</td>
    257. 

  257.       </tr>
    258. 

  258.       <tr>
    259. 

  259.         <td><a class="xref" href="Terminal.Gui.Key.html">Key</a></td>
    260. 

  260.         <td><span class="parametername">first</span></td>
    261. 

  261.         <td>First key in range.</td>
    262. 

  262.       </tr>
    263. 

  263.       <tr>
    264. 

  264.         <td><a class="xref" href="Terminal.Gui.Key.html">Key</a></td>
    265. 

  265.         <td><span class="parametername">last</span></td>
    266. 

  266.         <td>Last key in range.</td>
    267. 

  267.       </tr>
    268. 

  268.     </tbody>
    269. 

  269.   </table>
    270. 

  270.   <h5 class="returns">Returns</h5>
    271. 

  271.   <table class="table table-bordered table-striped table-condensed">
    272. 

  272.     <thead>
    273. 

  273.       <tr>
    274. 

  274.         <th>Type</th>
    275. 

  275.         <th>Description</th>
    276. 

  276.       </tr>
    277. 

  277.     </thead>
    278. 

  278.     <tbody>
    279. 

  279.       <tr>
    280. 

  280.         <td><span class="xref">System.Boolean</span></td>
    281. 

  281.         <td></td>
    282. 

  282.       </tr>
    283. 

  283.     </tbody>
    284. 

  284.   </table>
    285. 

  285.   <span class="small pull-right mobile-hide">
    286. 

  286.     <span class="divider">|</span>
    287. 

  287.     <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/apidoc/new?filename=Terminal_Gui_ShortcutHelper_FindAndOpenByShortcut_Terminal_Gui_KeyEvent_Terminal_Gui_View_.md&amp;value=---%0Auid%3A%20Terminal.Gui.ShortcutHelper.FindAndOpenByShortcut(Terminal.Gui.KeyEvent%2CTerminal.Gui.View)%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>
    288. 

  288.   </span>
    289. 

  289.   <span class="small pull-right mobile-hide">
    290. 

  290.     <a href="tig:tig/gui.cs/blob/main/Terminal.Gui/Core/ShortcutHelper.cs/#L244">View Source</a>
    291. 

  291.   </span>
    292. 

  292.   <a id="Terminal_Gui_ShortcutHelper_FindAndOpenByShortcut_" data-uid="Terminal.Gui.ShortcutHelper.FindAndOpenByShortcut*"></a>
    293. 

  293.   <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>
    294. 

  294.   <div class="markdown level1 summary">
    295. 

  295. Allows a view to run a <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ShortcutAction">ShortcutAction</a> if defined.
    296. 

  296. </div>
    297. 

  297.   <div class="markdown level1 conceptual"></div>
    298. 

  298.   <h5 class="decalaration">Declaration</h5>
    299. 

  299.   <div class="codewrapper">
    300. 

  300.     <pre><code class="lang-csharp hljs">public static bool FindAndOpenByShortcut(KeyEvent kb, View view = null)</code></pre>
    301. 

  301.   </div>
    302. 

  302.   <h5 class="parameters">Parameters</h5>
    303. 

  303.   <table class="table table-bordered table-striped table-condensed">
    304. 

  304.     <thead>
    305. 

  305.       <tr>
    306. 

  306.         <th>Type</th>
    307. 

  307.         <th>Name</th>
    308. 

  308.         <th>Description</th>
    309. 

  309.       </tr>
    310. 

  310.     </thead>
    311. 

  311.     <tbody>
    312. 

  312.       <tr>
    313. 

  313.         <td><a class="xref" href="Terminal.Gui.KeyEvent.html">KeyEvent</a></td>
    314. 

  314.         <td><span class="parametername">kb</span></td>
    315. 

  315.         <td>The <a class="xref" href="Terminal.Gui.KeyEvent.html">KeyEvent</a></td>
    316. 

  316.       </tr>
    317. 

  317.       <tr>
    318. 

  318.         <td><a class="xref" href="Terminal.Gui.View.html">View</a></td>
    319. 

  319.         <td><span class="parametername">view</span></td>
    320. 

  320.         <td>The <a class="xref" href="Terminal.Gui.View.html">View</a></td>
    321. 

  321.       </tr>
    322. 

  322.     </tbody>
    323. 

  323.   </table>
    324. 

  324.   <h5 class="returns">Returns</h5>
    325. 

  325.   <table class="table table-bordered table-striped table-condensed">
    326. 

  326.     <thead>
    327. 

  327.       <tr>
    328. 

  328.         <th>Type</th>
    329. 

  329.         <th>Description</th>
    330. 

  330.       </tr>
    331. 

  331.     </thead>
    332. 

  332.     <tbody>
    333. 

  333.       <tr>
    334. 

  334.         <td><span class="xref">System.Boolean</span></td>
    335. 

  335.         <td><code>true</code> if defined <code>false</code>otherwise.</td>
    336. 

  336.       </tr>
    337. 

  337.     </tbody>
    338. 

  338.   </table>
    339. 

  339.   <span class="small pull-right mobile-hide">
    340. 

  340.     <span class="divider">|</span>
    341. 

  341.     <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/apidoc/new?filename=Terminal_Gui_ShortcutHelper_GetKeyToString_Terminal_Gui_Key_Terminal_Gui_Key__.md&amp;value=---%0Auid%3A%20Terminal.Gui.ShortcutHelper.GetKeyToString(Terminal.Gui.Key%2CTerminal.Gui.Key%40)%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>
    342. 

  342.   </span>
    343. 

  343.   <span class="small pull-right mobile-hide">
    344. 

  344.     <a href="tig:tig/gui.cs/blob/main/Terminal.Gui/Core/ShortcutHelper.cs/#L123">View Source</a>
    345. 

  345.   </span>
    346. 

  346.   <a id="Terminal_Gui_ShortcutHelper_GetKeyToString_" data-uid="Terminal.Gui.ShortcutHelper.GetKeyToString*"></a>
    347. 

  347.   <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>
    348. 

  348.   <div class="markdown level1 summary">
    349. 

  349. Return key as string.
    350. 

  350. </div>
    351. 

  351.   <div class="markdown level1 conceptual"></div>
    352. 

  352.   <h5 class="decalaration">Declaration</h5>
    353. 

  353.   <div class="codewrapper">
    354. 

  354.     <pre><code class="lang-csharp hljs">public static ustring GetKeyToString(Key key, out Key knm)</code></pre>
    355. 

  355.   </div>
    356. 

  356.   <h5 class="parameters">Parameters</h5>
    357. 

  357.   <table class="table table-bordered table-striped table-condensed">
    358. 

  358.     <thead>
    359. 

  359.       <tr>
    360. 

  360.         <th>Type</th>
    361. 

  361.         <th>Name</th>
    362. 

  362.         <th>Description</th>
    363. 

  363.       </tr>
    364. 

  364.     </thead>
    365. 

  365.     <tbody>
    366. 

  366.       <tr>
    367. 

  367.         <td><a class="xref" href="Terminal.Gui.Key.html">Key</a></td>
    368. 

  368.         <td><span class="parametername">key</span></td>
    369. 

  369.         <td>The key to extract.</td>
    370. 

  370.       </tr>
    371. 

  371.       <tr>
    372. 

  372.         <td><a class="xref" href="Terminal.Gui.Key.html">Key</a></td>
    373. 

  373.         <td><span class="parametername">knm</span></td>
    374. 

  374.         <td>Correspond to the non modifier key.</td>
    375. 

  375.       </tr>
    376. 

  376.     </tbody>
    377. 

  377.   </table>
    378. 

  378.   <h5 class="returns">Returns</h5>
    379. 

  379.   <table class="table table-bordered table-striped table-condensed">
    380. 

  380.     <thead>
    381. 

  381.       <tr>
    382. 

  382.         <th>Type</th>
    383. 

  383.         <th>Description</th>
    384. 

  384.       </tr>
    385. 

  385.     </thead>
    386. 

  386.     <tbody>
    387. 

  387.       <tr>
    388. 

  388.         <td><span class="xref">NStack.ustring</span></td>
    389. 

  389.         <td></td>
    390. 

  390.       </tr>
    391. 

  391.     </tbody>
    392. 

  392.   </table>
    393. 

  393.   <span class="small pull-right mobile-hide">
    394. 

  394.     <span class="divider">|</span>
    395. 

  395.     <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/apidoc/new?filename=Terminal_Gui_ShortcutHelper_GetModifiersKey_Terminal_Gui_KeyEvent_.md&amp;value=---%0Auid%3A%20Terminal.Gui.ShortcutHelper.GetModifiersKey(Terminal.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">Improve this Doc</a>
    396. 

  396.   </span>
    397. 

  397.   <span class="small pull-right mobile-hide">
    398. 

  398.     <a href="tig:tig/gui.cs/blob/main/Terminal.Gui/Core/ShortcutHelper.cs/#L42">View Source</a>
    399. 

  399.   </span>
    400. 

  400.   <a id="Terminal_Gui_ShortcutHelper_GetModifiersKey_" data-uid="Terminal.Gui.ShortcutHelper.GetModifiersKey*"></a>
    401. 

  401.   <h4 id="Terminal_Gui_ShortcutHelper_GetModifiersKey_Terminal_Gui_KeyEvent_" data-uid="Terminal.Gui.ShortcutHelper.GetModifiersKey(Terminal.Gui.KeyEvent)">GetModifiersKey(KeyEvent)</h4>
    402. 

  402.   <div class="markdown level1 summary">
    403. 

  403. Gets the key with all the keys modifiers, especially the shift key that sometimes have to be injected later.
    404. 

  404. </div>
    405. 

  405.   <div class="markdown level1 conceptual"></div>
    406. 

  406.   <h5 class="decalaration">Declaration</h5>
    407. 

  407.   <div class="codewrapper">
    408. 

  408.     <pre><code class="lang-csharp hljs">public static Key GetModifiersKey(KeyEvent kb)</code></pre>
    409. 

  409.   </div>
    410. 

  410.   <h5 class="parameters">Parameters</h5>
    411. 

  411.   <table class="table table-bordered table-striped table-condensed">
    412. 

  412.     <thead>
    413. 

  413.       <tr>
    414. 

  414.         <th>Type</th>
    415. 

  415.         <th>Name</th>
    416. 

  416.         <th>Description</th>
    417. 

  417.       </tr>
    418. 

  418.     </thead>
    419. 

  419.     <tbody>
    420. 

  420.       <tr>
    421. 

  421.         <td><a class="xref" href="Terminal.Gui.KeyEvent.html">KeyEvent</a></td>
    422. 

  422.         <td><span class="parametername">kb</span></td>
    423. 

  423.         <td>The <a class="xref" href="Terminal.Gui.KeyEvent.html">KeyEvent</a> to check.</td>
    424. 

  424.       </tr>
    425. 

  425.     </tbody>
    426. 

  426.   </table>
    427. 

  427.   <h5 class="returns">Returns</h5>
    428. 

  428.   <table class="table table-bordered table-striped table-condensed">
    429. 

  429.     <thead>
    430. 

  430.       <tr>
    431. 

  431.         <th>Type</th>
    432. 

  432.         <th>Description</th>
    433. 

  433.       </tr>
    434. 

  434.     </thead>
    435. 

  435.     <tbody>
    436. 

  436.       <tr>
    437. 

  437.         <td><a class="xref" href="Terminal.Gui.Key.html">Key</a></td>
    438. 

  438.         <td>The <a class="xref" href="Terminal.Gui.KeyEvent.html#Terminal_Gui_KeyEvent_Key">Key</a> with all the keys modifiers.</td>
    439. 

  439.       </tr>
    440. 

  440.     </tbody>
    441. 

  441.   </table>
    442. 

  442.   <span class="small pull-right mobile-hide">
    443. 

  443.     <span class="divider">|</span>
    444. 

  444.     <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/apidoc/new?filename=Terminal_Gui_ShortcutHelper_GetShortcutFromTag_NStack_ustring_NStack_ustring_.md&amp;value=---%0Auid%3A%20Terminal.Gui.ShortcutHelper.GetShortcutFromTag(NStack.ustring%2CNStack.ustring)%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>
    445. 

  445.   </span>
    446. 

  446.   <span class="small pull-right mobile-hide">
    447. 

  447.     <a href="tig:tig/gui.cs/blob/main/Terminal.Gui/Core/ShortcutHelper.cs/#L153">View Source</a>
    448. 

  448.   </span>
    449. 

  449.   <a id="Terminal_Gui_ShortcutHelper_GetShortcutFromTag_" data-uid="Terminal.Gui.ShortcutHelper.GetShortcutFromTag*"></a>
    450. 

  450.   <h4 id="Terminal_Gui_ShortcutHelper_GetShortcutFromTag_NStack_ustring_NStack_ustring_" data-uid="Terminal.Gui.ShortcutHelper.GetShortcutFromTag(NStack.ustring,NStack.ustring)">GetShortcutFromTag(ustring, ustring)</h4>
    451. 

  451.   <div class="markdown level1 summary">
    452. 

  452. 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>
    453. 

  453. </div>
    454. 

  454.   <div class="markdown level1 conceptual"></div>
    455. 

  455.   <h5 class="decalaration">Declaration</h5>
    456. 

  456.   <div class="codewrapper">
    457. 

  457.     <pre><code class="lang-csharp hljs">public static Key GetShortcutFromTag(ustring tag, ustring delimiter = null)</code></pre>
    458. 

  458.   </div>
    459. 

  459.   <h5 class="parameters">Parameters</h5>
    460. 

  460.   <table class="table table-bordered table-striped table-condensed">
    461. 

  461.     <thead>
    462. 

  462.       <tr>
    463. 

  463.         <th>Type</th>
    464. 

  464.         <th>Name</th>
    465. 

  465.         <th>Description</th>
    466. 

  466.       </tr>
    467. 

  467.     </thead>
    468. 

  468.     <tbody>
    469. 

  469.       <tr>
    470. 

  470.         <td><span class="xref">NStack.ustring</span></td>
    471. 

  471.         <td><span class="parametername">tag</span></td>
    472. 

  472.         <td>The key as string.</td>
    473. 

  473.       </tr>
    474. 

  474.       <tr>
    475. 

  475.         <td><span class="xref">NStack.ustring</span></td>
    476. 

  476.         <td><span class="parametername">delimiter</span></td>
    477. 

  477.         <td>The delimiter string.</td>
    478. 

  478.       </tr>
    479. 

  479.     </tbody>
    480. 

  480.   </table>
    481. 

  481.   <h5 class="returns">Returns</h5>
    482. 

  482.   <table class="table table-bordered table-striped table-condensed">
    483. 

  483.     <thead>
    484. 

  484.       <tr>
    485. 

  485.         <th>Type</th>
    486. 

  486.         <th>Description</th>
    487. 

  487.       </tr>
    488. 

  488.     </thead>
    489. 

  489.     <tbody>
    490. 

  490.       <tr>
    491. 

  491.         <td><a class="xref" href="Terminal.Gui.Key.html">Key</a></td>
    492. 

  492.         <td></td>
    493. 

  493.       </tr>
    494. 

  494.     </tbody>
    495. 

  495.   </table>
    496. 

  496.   <span class="small pull-right mobile-hide">
    497. 

  497.     <span class="divider">|</span>
    498. 

  498.     <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/apidoc/new?filename=Terminal_Gui_ShortcutHelper_GetShortcutTag_Terminal_Gui_Key_NStack_ustring_.md&amp;value=---%0Auid%3A%20Terminal.Gui.ShortcutHelper.GetShortcutTag(Terminal.Gui.Key%2CNStack.ustring)%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>
    499. 

  499.   </span>
    500. 

  500.   <span class="small pull-right mobile-hide">
    501. 

  501.     <a href="tig:tig/gui.cs/blob/main/Terminal.Gui/Core/ShortcutHelper.cs/#L64">View Source</a>
    502. 

  502.   </span>
    503. 

  503.   <a id="Terminal_Gui_ShortcutHelper_GetShortcutTag_" data-uid="Terminal.Gui.ShortcutHelper.GetShortcutTag*"></a>
    504. 

  504.   <h4 id="Terminal_Gui_ShortcutHelper_GetShortcutTag_Terminal_Gui_Key_NStack_ustring_" data-uid="Terminal.Gui.ShortcutHelper.GetShortcutTag(Terminal.Gui.Key,NStack.ustring)">GetShortcutTag(Key, ustring)</h4>
    505. 

  505.   <div class="markdown level1 summary">
    506. 

  506. Get the <a class="xref" href="Terminal.Gui.ShortcutHelper.html#Terminal_Gui_ShortcutHelper_Shortcut">Shortcut</a> key as string.
    507. 

  507. </div>
    508. 

  508.   <div class="markdown level1 conceptual"></div>
    509. 

  509.   <h5 class="decalaration">Declaration</h5>
    510. 

  510.   <div class="codewrapper">
    511. 

  511.     <pre><code class="lang-csharp hljs">public static ustring GetShortcutTag(Key shortcut, ustring delimiter = null)</code></pre>
    512. 

  512.   </div>
    513. 

  513.   <h5 class="parameters">Parameters</h5>
    514. 

  514.   <table class="table table-bordered table-striped table-condensed">
    515. 

  515.     <thead>
    516. 

  516.       <tr>
    517. 

  517.         <th>Type</th>
    518. 

  518.         <th>Name</th>
    519. 

  519.         <th>Description</th>
    520. 

  520.       </tr>
    521. 

  521.     </thead>
    522. 

  522.     <tbody>
    523. 

  523.       <tr>
    524. 

  524.         <td><a class="xref" href="Terminal.Gui.Key.html">Key</a></td>
    525. 

  525.         <td><span class="parametername">shortcut</span></td>
    526. 

  526.         <td>The shortcut key.</td>
    527. 

  527.       </tr>
    528. 

  528.       <tr>
    529. 

  529.         <td><span class="xref">NStack.ustring</span></td>
    530. 

  530.         <td><span class="parametername">delimiter</span></td>
    531. 

  531.         <td>The delimiter string.</td>
    532. 

  532.       </tr>
    533. 

  533.     </tbody>
    534. 

  534.   </table>
    535. 

  535.   <h5 class="returns">Returns</h5>
    536. 

  536.   <table class="table table-bordered table-striped table-condensed">
    537. 

  537.     <thead>
    538. 

  538.       <tr>
    539. 

  539.         <th>Type</th>
    540. 

  540.         <th>Description</th>
    541. 

  541.       </tr>
    542. 

  542.     </thead>
    543. 

  543.     <tbody>
    544. 

  544.       <tr>
    545. 

  545.         <td><span class="xref">NStack.ustring</span></td>
    546. 

  546.         <td></td>
    547. 

  547.       </tr>
    548. 

  548.     </tbody>
    549. 

  549.   </table>
    550. 

  550.   <span class="small pull-right mobile-hide">
    551. 

  551.     <span class="divider">|</span>
    552. 

  552.     <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/apidoc/new?filename=Terminal_Gui_ShortcutHelper_PostShortcutValidation_Terminal_Gui_Key_.md&amp;value=---%0Auid%3A%20Terminal.Gui.ShortcutHelper.PostShortcutValidation(Terminal.Gui.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>
    553. 

  553.   </span>
    554. 

  554.   <span class="small pull-right mobile-hide">
    555. 

  555.     <a href="tig:tig/gui.cs/blob/main/Terminal.Gui/Core/ShortcutHelper.cs/#L227">View Source</a>
    556. 

  556.   </span>
    557. 

  557.   <a id="Terminal_Gui_ShortcutHelper_PostShortcutValidation_" data-uid="Terminal.Gui.ShortcutHelper.PostShortcutValidation*"></a>
    558. 

  558.   <h4 id="Terminal_Gui_ShortcutHelper_PostShortcutValidation_Terminal_Gui_Key_" data-uid="Terminal.Gui.ShortcutHelper.PostShortcutValidation(Terminal.Gui.Key)">PostShortcutValidation(Key)</h4>
    559. 

  559.   <div class="markdown level1 summary">
    560. 

  560. Used at key up validation.
    561. 

  561. </div>
    562. 

  562.   <div class="markdown level1 conceptual"></div>
    563. 

  563.   <h5 class="decalaration">Declaration</h5>
    564. 

  564.   <div class="codewrapper">
    565. 

  565.     <pre><code class="lang-csharp hljs">public static bool PostShortcutValidation(Key key)</code></pre>
    566. 

  566.   </div>
    567. 

  567.   <h5 class="parameters">Parameters</h5>
    568. 

  568.   <table class="table table-bordered table-striped table-condensed">
    569. 

  569.     <thead>
    570. 

  570.       <tr>
    571. 

  571.         <th>Type</th>
    572. 

  572.         <th>Name</th>
    573. 

  573.         <th>Description</th>
    574. 

  574.       </tr>
    575. 

  575.     </thead>
    576. 

  576.     <tbody>
    577. 

  577.       <tr>
    578. 

  578.         <td><a class="xref" href="Terminal.Gui.Key.html">Key</a></td>
    579. 

  579.         <td><span class="parametername">key</span></td>
    580. 

  580.         <td>The key to validate.</td>
    581. 

  581.       </tr>
    582. 

  582.     </tbody>
    583. 

  583.   </table>
    584. 

  584.   <h5 class="returns">Returns</h5>
    585. 

  585.   <table class="table table-bordered table-striped table-condensed">
    586. 

  586.     <thead>
    587. 

  587.       <tr>
    588. 

  588.         <th>Type</th>
    589. 

  589.         <th>Description</th>
    590. 

  590.       </tr>
    591. 

  591.     </thead>
    592. 

  592.     <tbody>
    593. 

  593.       <tr>
    594. 

  594.         <td><span class="xref">System.Boolean</span></td>
    595. 

  595.         <td><code>true</code> if is valid.<code>false</code>otherwise.</td>
    596. 

  596.       </tr>
    597. 

  597.     </tbody>
    598. 

  598.   </table>
    599. 

  599.   <span class="small pull-right mobile-hide">
    600. 

  600.     <span class="divider">|</span>
    601. 

  601.     <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/apidoc/new?filename=Terminal_Gui_ShortcutHelper_PreShortcutValidation_Terminal_Gui_Key_.md&amp;value=---%0Auid%3A%20Terminal.Gui.ShortcutHelper.PreShortcutValidation(Terminal.Gui.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>
    602. 

  602.   </span>
    603. 

  603.   <span class="small pull-right mobile-hide">
    604. 

  604.     <a href="tig:tig/gui.cs/blob/main/Terminal.Gui/Core/ShortcutHelper.cs/#L213">View Source</a>
    605. 

  605.   </span>
    606. 

  606.   <a id="Terminal_Gui_ShortcutHelper_PreShortcutValidation_" data-uid="Terminal.Gui.ShortcutHelper.PreShortcutValidation*"></a>
    607. 

  607.   <h4 id="Terminal_Gui_ShortcutHelper_PreShortcutValidation_Terminal_Gui_Key_" data-uid="Terminal.Gui.ShortcutHelper.PreShortcutValidation(Terminal.Gui.Key)">PreShortcutValidation(Key)</h4>
    608. 

  608.   <div class="markdown level1 summary">
    609. 

  609. Used at key down or key press validation.
    610. 

  610. </div>
    611. 

  611.   <div class="markdown level1 conceptual"></div>
    612. 

  612.   <h5 class="decalaration">Declaration</h5>
    613. 

  613.   <div class="codewrapper">
    614. 

  614.     <pre><code class="lang-csharp hljs">public static bool PreShortcutValidation(Key key)</code></pre>
    615. 

  615.   </div>
    616. 

  616.   <h5 class="parameters">Parameters</h5>
    617. 

  617.   <table class="table table-bordered table-striped table-condensed">
    618. 

  618.     <thead>
    619. 

  619.       <tr>
    620. 

  620.         <th>Type</th>
    621. 

  621.         <th>Name</th>
    622. 

  622.         <th>Description</th>
    623. 

  623.       </tr>
    624. 

  624.     </thead>
    625. 

  625.     <tbody>
    626. 

  626.       <tr>
    627. 

  627.         <td><a class="xref" href="Terminal.Gui.Key.html">Key</a></td>
    628. 

  628.         <td><span class="parametername">key</span></td>
    629. 

  629.         <td>The key to validate.</td>
    630. 

  630.       </tr>
    631. 

  631.     </tbody>
    632. 

  632.   </table>
    633. 

  633.   <h5 class="returns">Returns</h5>
    634. 

  634.   <table class="table table-bordered table-striped table-condensed">
    635. 

  635.     <thead>
    636. 

  636.       <tr>
    637. 

  637.         <th>Type</th>
    638. 

  638.         <th>Description</th>
    639. 

  639.       </tr>
    640. 

  640.     </thead>
    641. 

  641.     <tbody>
    642. 

  642.       <tr>
    643. 

  643.         <td><span class="xref">System.Boolean</span></td>
    644. 

  644.         <td><code>true</code> if is valid.<code>false</code>otherwise.</td>
    645. 

  645.       </tr>
    646. 

  646.     </tbody>
    647. 

  647.   </table>
    648. 

  648. </article>
    649. 

  649.           </div>
    650. 

  650.           
    651. 

  651.           <div class="hidden-sm col-md-2" role="complementary">
    652. 

  652.             <div class="sideaffix">
    653. 

  653.               <div class="contribution">
    654. 

  654.                 <ul class="nav">
    655. 

  655.                   <li>
    656. 

  656.                     <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/apidoc/new?filename=Terminal_Gui_ShortcutHelper.md&amp;value=---%0Auid%3A%20Terminal.Gui.ShortcutHelper%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>
    657. 

  657.                   </li>
    658. 

  658.                   <li>
    659. 

  659.                     <a href="tig:tig/gui.cs/blob/main/Terminal.Gui/Core/ShortcutHelper.cs/#L12" class="contribution-link">View Source</a>
    660. 

  660.                   </li>
    661. 

  661.                 </ul>
    662. 

  662.               </div>
    663. 

  663.               <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
    664. 

  664.                 <h5>In This Article</h5>
    665. 

  665.                 <div></div>
    666. 

  666.               </nav>
    667. 

  667.             </div>
    668. 

  668.           </div>
    669. 

  669.         </div>
    670. 

  670.       </div>
    671. 

  671.       
    672. 

  672.       <footer>
    673. 

  673.         <div class="grad-bottom"></div>
    674. 

  674.         <div class="footer">
    675. 

  675.           <div class="container">
    676. 

  676.             <span class="pull-right">
    677. 

  677.               <a href="#top">Back to top</a>
    678. 

  678.             </span>
    679. 

  679.             
    680. 

  680.             <span>Generated by <strong>DocFX</strong></span>
    681. 

  681.           </div>
    682. 

  682.         </div>
    683. 

  683.       </footer>
    684. 

  684.     </div>
    685. 

  685.     
    686. 

  686.     <script type="text/javascript" src="../../styles/docfx.vendor.js"></script>
    687. 

  687.     <script type="text/javascript" src="../../styles/docfx.js"></script>
    688. 

  688.     <script type="text/javascript" src="../../styles/main.js"></script>
    689. 

  689.   </body>
    690. 

  690. </html>
    691.