Terminal.Gui.IAutocomplete.html 22 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578
  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>Interface IAutocomplete
  8. </title>
  9. <meta name="viewport" content="width=device-width">
  10. <meta name="title" content="Interface IAutocomplete
  11. ">
  12. <meta name="generator" content="docfx 2.59.3.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.IAutocomplete">
  74. <h1 id="Terminal_Gui_IAutocomplete" data-uid="Terminal.Gui.IAutocomplete" class="text-break">Interface IAutocomplete
  75. </h1>
  76. <div class="markdown level0 summary">
  77. Renders an overlay on another view at a given point that allows selecting
  78. from a range of &apos;autocomplete&apos; options.
  79. </div>
  80. <div class="markdown level0 conceptual"></div>
  81. <h6><strong>Namespace</strong>: <a class="xref" href="Terminal.Gui.html">Terminal.Gui</a></h6>
  82. <h6><strong>Assembly</strong>: Terminal.Gui.dll</h6>
  83. <h5 id="Terminal_Gui_IAutocomplete_syntax">Syntax</h5>
  84. <div class="codewrapper">
  85. <pre><code class="lang-csharp hljs">public interface IAutocomplete</code></pre>
  86. </div>
  87. <h3 id="properties">Properties
  88. </h3>
  89. <a id="Terminal_Gui_IAutocomplete_AllSuggestions_" data-uid="Terminal.Gui.IAutocomplete.AllSuggestions*"></a>
  90. <h4 id="Terminal_Gui_IAutocomplete_AllSuggestions" data-uid="Terminal.Gui.IAutocomplete.AllSuggestions">AllSuggestions</h4>
  91. <div class="markdown level1 summary">
  92. The full set of all strings that can be suggested.
  93. </div>
  94. <div class="markdown level1 conceptual"></div>
  95. <h5 class="decalaration">Declaration</h5>
  96. <div class="codewrapper">
  97. <pre><code class="lang-csharp hljs">List&lt;string&gt; AllSuggestions { get; set; }</code></pre>
  98. </div>
  99. <h5 class="propertyValue">Property Value</h5>
  100. <table class="table table-bordered table-striped table-condensed">
  101. <thead>
  102. <tr>
  103. <th>Type</th>
  104. <th>Description</th>
  105. </tr>
  106. </thead>
  107. <tbody>
  108. <tr>
  109. <td><span class="xref">System.Collections.Generic.List</span>&lt;<span class="xref">System.String</span>&gt;</td>
  110. <td></td>
  111. </tr>
  112. </tbody>
  113. </table>
  114. <a id="Terminal_Gui_IAutocomplete_CloseKey_" data-uid="Terminal.Gui.IAutocomplete.CloseKey*"></a>
  115. <h4 id="Terminal_Gui_IAutocomplete_CloseKey" data-uid="Terminal.Gui.IAutocomplete.CloseKey">CloseKey</h4>
  116. <div class="markdown level1 summary">
  117. The key that the user can press to close the currently popped autocomplete menu
  118. </div>
  119. <div class="markdown level1 conceptual"></div>
  120. <h5 class="decalaration">Declaration</h5>
  121. <div class="codewrapper">
  122. <pre><code class="lang-csharp hljs">Key CloseKey { get; set; }</code></pre>
  123. </div>
  124. <h5 class="propertyValue">Property Value</h5>
  125. <table class="table table-bordered table-striped table-condensed">
  126. <thead>
  127. <tr>
  128. <th>Type</th>
  129. <th>Description</th>
  130. </tr>
  131. </thead>
  132. <tbody>
  133. <tr>
  134. <td><a class="xref" href="Terminal.Gui.Key.html">Key</a></td>
  135. <td></td>
  136. </tr>
  137. </tbody>
  138. </table>
  139. <a id="Terminal_Gui_IAutocomplete_ColorScheme_" data-uid="Terminal.Gui.IAutocomplete.ColorScheme*"></a>
  140. <h4 id="Terminal_Gui_IAutocomplete_ColorScheme" data-uid="Terminal.Gui.IAutocomplete.ColorScheme">ColorScheme</h4>
  141. <div class="markdown level1 summary">
  142. The colors to use to render the overlay. Accessing this property before
  143. the Application has been initialized will cause an error
  144. </div>
  145. <div class="markdown level1 conceptual"></div>
  146. <h5 class="decalaration">Declaration</h5>
  147. <div class="codewrapper">
  148. <pre><code class="lang-csharp hljs">ColorScheme ColorScheme { get; set; }</code></pre>
  149. </div>
  150. <h5 class="propertyValue">Property Value</h5>
  151. <table class="table table-bordered table-striped table-condensed">
  152. <thead>
  153. <tr>
  154. <th>Type</th>
  155. <th>Description</th>
  156. </tr>
  157. </thead>
  158. <tbody>
  159. <tr>
  160. <td><a class="xref" href="Terminal.Gui.ColorScheme.html">ColorScheme</a></td>
  161. <td></td>
  162. </tr>
  163. </tbody>
  164. </table>
  165. <a id="Terminal_Gui_IAutocomplete_HostControl_" data-uid="Terminal.Gui.IAutocomplete.HostControl*"></a>
  166. <h4 id="Terminal_Gui_IAutocomplete_HostControl" data-uid="Terminal.Gui.IAutocomplete.HostControl">HostControl</h4>
  167. <div class="markdown level1 summary">
  168. The host control that will use autocomplete.
  169. </div>
  170. <div class="markdown level1 conceptual"></div>
  171. <h5 class="decalaration">Declaration</h5>
  172. <div class="codewrapper">
  173. <pre><code class="lang-csharp hljs">View HostControl { get; set; }</code></pre>
  174. </div>
  175. <h5 class="propertyValue">Property Value</h5>
  176. <table class="table table-bordered table-striped table-condensed">
  177. <thead>
  178. <tr>
  179. <th>Type</th>
  180. <th>Description</th>
  181. </tr>
  182. </thead>
  183. <tbody>
  184. <tr>
  185. <td><a class="xref" href="Terminal.Gui.View.html">View</a></td>
  186. <td></td>
  187. </tr>
  188. </tbody>
  189. </table>
  190. <a id="Terminal_Gui_IAutocomplete_MaxHeight_" data-uid="Terminal.Gui.IAutocomplete.MaxHeight*"></a>
  191. <h4 id="Terminal_Gui_IAutocomplete_MaxHeight" data-uid="Terminal.Gui.IAutocomplete.MaxHeight">MaxHeight</h4>
  192. <div class="markdown level1 summary">
  193. The maximum number of visible rows in the autocomplete dropdown to render
  194. </div>
  195. <div class="markdown level1 conceptual"></div>
  196. <h5 class="decalaration">Declaration</h5>
  197. <div class="codewrapper">
  198. <pre><code class="lang-csharp hljs">int MaxHeight { get; set; }</code></pre>
  199. </div>
  200. <h5 class="propertyValue">Property Value</h5>
  201. <table class="table table-bordered table-striped table-condensed">
  202. <thead>
  203. <tr>
  204. <th>Type</th>
  205. <th>Description</th>
  206. </tr>
  207. </thead>
  208. <tbody>
  209. <tr>
  210. <td><span class="xref">System.Int32</span></td>
  211. <td></td>
  212. </tr>
  213. </tbody>
  214. </table>
  215. <a id="Terminal_Gui_IAutocomplete_MaxWidth_" data-uid="Terminal.Gui.IAutocomplete.MaxWidth*"></a>
  216. <h4 id="Terminal_Gui_IAutocomplete_MaxWidth" data-uid="Terminal.Gui.IAutocomplete.MaxWidth">MaxWidth</h4>
  217. <div class="markdown level1 summary">
  218. The maximum width of the autocomplete dropdown
  219. </div>
  220. <div class="markdown level1 conceptual"></div>
  221. <h5 class="decalaration">Declaration</h5>
  222. <div class="codewrapper">
  223. <pre><code class="lang-csharp hljs">int MaxWidth { get; set; }</code></pre>
  224. </div>
  225. <h5 class="propertyValue">Property Value</h5>
  226. <table class="table table-bordered table-striped table-condensed">
  227. <thead>
  228. <tr>
  229. <th>Type</th>
  230. <th>Description</th>
  231. </tr>
  232. </thead>
  233. <tbody>
  234. <tr>
  235. <td><span class="xref">System.Int32</span></td>
  236. <td></td>
  237. </tr>
  238. </tbody>
  239. </table>
  240. <a id="Terminal_Gui_IAutocomplete_PopupInsideContainer_" data-uid="Terminal.Gui.IAutocomplete.PopupInsideContainer*"></a>
  241. <h4 id="Terminal_Gui_IAutocomplete_PopupInsideContainer" data-uid="Terminal.Gui.IAutocomplete.PopupInsideContainer">PopupInsideContainer</h4>
  242. <div class="markdown level1 summary">
  243. Gets or sets where the popup will be displayed.
  244. </div>
  245. <div class="markdown level1 conceptual"></div>
  246. <h5 class="decalaration">Declaration</h5>
  247. <div class="codewrapper">
  248. <pre><code class="lang-csharp hljs">bool PopupInsideContainer { get; set; }</code></pre>
  249. </div>
  250. <h5 class="propertyValue">Property Value</h5>
  251. <table class="table table-bordered table-striped table-condensed">
  252. <thead>
  253. <tr>
  254. <th>Type</th>
  255. <th>Description</th>
  256. </tr>
  257. </thead>
  258. <tbody>
  259. <tr>
  260. <td><span class="xref">System.Boolean</span></td>
  261. <td></td>
  262. </tr>
  263. </tbody>
  264. </table>
  265. <a id="Terminal_Gui_IAutocomplete_Reopen_" data-uid="Terminal.Gui.IAutocomplete.Reopen*"></a>
  266. <h4 id="Terminal_Gui_IAutocomplete_Reopen" data-uid="Terminal.Gui.IAutocomplete.Reopen">Reopen</h4>
  267. <div class="markdown level1 summary">
  268. The key that the user can press to reopen the currently popped autocomplete menu
  269. </div>
  270. <div class="markdown level1 conceptual"></div>
  271. <h5 class="decalaration">Declaration</h5>
  272. <div class="codewrapper">
  273. <pre><code class="lang-csharp hljs">Key Reopen { get; set; }</code></pre>
  274. </div>
  275. <h5 class="propertyValue">Property Value</h5>
  276. <table class="table table-bordered table-striped table-condensed">
  277. <thead>
  278. <tr>
  279. <th>Type</th>
  280. <th>Description</th>
  281. </tr>
  282. </thead>
  283. <tbody>
  284. <tr>
  285. <td><a class="xref" href="Terminal.Gui.Key.html">Key</a></td>
  286. <td></td>
  287. </tr>
  288. </tbody>
  289. </table>
  290. <a id="Terminal_Gui_IAutocomplete_SelectedIdx_" data-uid="Terminal.Gui.IAutocomplete.SelectedIdx*"></a>
  291. <h4 id="Terminal_Gui_IAutocomplete_SelectedIdx" data-uid="Terminal.Gui.IAutocomplete.SelectedIdx">SelectedIdx</h4>
  292. <div class="markdown level1 summary">
  293. The currently selected index into <a class="xref" href="Terminal.Gui.IAutocomplete.html#Terminal_Gui_IAutocomplete_Suggestions">Suggestions</a> that the user has highlighted
  294. </div>
  295. <div class="markdown level1 conceptual"></div>
  296. <h5 class="decalaration">Declaration</h5>
  297. <div class="codewrapper">
  298. <pre><code class="lang-csharp hljs">int SelectedIdx { get; set; }</code></pre>
  299. </div>
  300. <h5 class="propertyValue">Property Value</h5>
  301. <table class="table table-bordered table-striped table-condensed">
  302. <thead>
  303. <tr>
  304. <th>Type</th>
  305. <th>Description</th>
  306. </tr>
  307. </thead>
  308. <tbody>
  309. <tr>
  310. <td><span class="xref">System.Int32</span></td>
  311. <td></td>
  312. </tr>
  313. </tbody>
  314. </table>
  315. <a id="Terminal_Gui_IAutocomplete_SelectionKey_" data-uid="Terminal.Gui.IAutocomplete.SelectionKey*"></a>
  316. <h4 id="Terminal_Gui_IAutocomplete_SelectionKey" data-uid="Terminal.Gui.IAutocomplete.SelectionKey">SelectionKey</h4>
  317. <div class="markdown level1 summary">
  318. The key that the user must press to accept the currently selected autocomplete suggestion
  319. </div>
  320. <div class="markdown level1 conceptual"></div>
  321. <h5 class="decalaration">Declaration</h5>
  322. <div class="codewrapper">
  323. <pre><code class="lang-csharp hljs">Key SelectionKey { get; set; }</code></pre>
  324. </div>
  325. <h5 class="propertyValue">Property Value</h5>
  326. <table class="table table-bordered table-striped table-condensed">
  327. <thead>
  328. <tr>
  329. <th>Type</th>
  330. <th>Description</th>
  331. </tr>
  332. </thead>
  333. <tbody>
  334. <tr>
  335. <td><a class="xref" href="Terminal.Gui.Key.html">Key</a></td>
  336. <td></td>
  337. </tr>
  338. </tbody>
  339. </table>
  340. <a id="Terminal_Gui_IAutocomplete_Suggestions_" data-uid="Terminal.Gui.IAutocomplete.Suggestions*"></a>
  341. <h4 id="Terminal_Gui_IAutocomplete_Suggestions" data-uid="Terminal.Gui.IAutocomplete.Suggestions">Suggestions</h4>
  342. <div class="markdown level1 summary">
  343. The strings that form the current list of suggestions to render
  344. based on what the user has typed so far.
  345. </div>
  346. <div class="markdown level1 conceptual"></div>
  347. <h5 class="decalaration">Declaration</h5>
  348. <div class="codewrapper">
  349. <pre><code class="lang-csharp hljs">ReadOnlyCollection&lt;string&gt; Suggestions { get; set; }</code></pre>
  350. </div>
  351. <h5 class="propertyValue">Property Value</h5>
  352. <table class="table table-bordered table-striped table-condensed">
  353. <thead>
  354. <tr>
  355. <th>Type</th>
  356. <th>Description</th>
  357. </tr>
  358. </thead>
  359. <tbody>
  360. <tr>
  361. <td><span class="xref">System.Collections.ObjectModel.ReadOnlyCollection</span>&lt;<span class="xref">System.String</span>&gt;</td>
  362. <td></td>
  363. </tr>
  364. </tbody>
  365. </table>
  366. <a id="Terminal_Gui_IAutocomplete_Visible_" data-uid="Terminal.Gui.IAutocomplete.Visible*"></a>
  367. <h4 id="Terminal_Gui_IAutocomplete_Visible" data-uid="Terminal.Gui.IAutocomplete.Visible">Visible</h4>
  368. <div class="markdown level1 summary">
  369. True if the autocomplete should be considered open and visible
  370. </div>
  371. <div class="markdown level1 conceptual"></div>
  372. <h5 class="decalaration">Declaration</h5>
  373. <div class="codewrapper">
  374. <pre><code class="lang-csharp hljs">bool Visible { get; set; }</code></pre>
  375. </div>
  376. <h5 class="propertyValue">Property Value</h5>
  377. <table class="table table-bordered table-striped table-condensed">
  378. <thead>
  379. <tr>
  380. <th>Type</th>
  381. <th>Description</th>
  382. </tr>
  383. </thead>
  384. <tbody>
  385. <tr>
  386. <td><span class="xref">System.Boolean</span></td>
  387. <td></td>
  388. </tr>
  389. </tbody>
  390. </table>
  391. <h3 id="methods">Methods
  392. </h3>
  393. <a id="Terminal_Gui_IAutocomplete_ClearSuggestions_" data-uid="Terminal.Gui.IAutocomplete.ClearSuggestions*"></a>
  394. <h4 id="Terminal_Gui_IAutocomplete_ClearSuggestions" data-uid="Terminal.Gui.IAutocomplete.ClearSuggestions">ClearSuggestions()</h4>
  395. <div class="markdown level1 summary">
  396. Clears <a class="xref" href="Terminal.Gui.IAutocomplete.html#Terminal_Gui_IAutocomplete_Suggestions">Suggestions</a>
  397. </div>
  398. <div class="markdown level1 conceptual"></div>
  399. <h5 class="decalaration">Declaration</h5>
  400. <div class="codewrapper">
  401. <pre><code class="lang-csharp hljs">void ClearSuggestions()</code></pre>
  402. </div>
  403. <a id="Terminal_Gui_IAutocomplete_GenerateSuggestions_" data-uid="Terminal.Gui.IAutocomplete.GenerateSuggestions*"></a>
  404. <h4 id="Terminal_Gui_IAutocomplete_GenerateSuggestions" data-uid="Terminal.Gui.IAutocomplete.GenerateSuggestions">GenerateSuggestions()</h4>
  405. <div class="markdown level1 summary">
  406. Populates <a class="xref" href="Terminal.Gui.IAutocomplete.html#Terminal_Gui_IAutocomplete_Suggestions">Suggestions</a> with all strings in <a class="xref" href="Terminal.Gui.IAutocomplete.html#Terminal_Gui_IAutocomplete_AllSuggestions">AllSuggestions</a> that
  407. match with the current cursor position/text in the <a class="xref" href="Terminal.Gui.IAutocomplete.html#Terminal_Gui_IAutocomplete_HostControl">HostControl</a>.
  408. </div>
  409. <div class="markdown level1 conceptual"></div>
  410. <h5 class="decalaration">Declaration</h5>
  411. <div class="codewrapper">
  412. <pre><code class="lang-csharp hljs">void GenerateSuggestions()</code></pre>
  413. </div>
  414. <a id="Terminal_Gui_IAutocomplete_MouseEvent_" data-uid="Terminal.Gui.IAutocomplete.MouseEvent*"></a>
  415. <h4 id="Terminal_Gui_IAutocomplete_MouseEvent_Terminal_Gui_MouseEvent_System_Boolean_" data-uid="Terminal.Gui.IAutocomplete.MouseEvent(Terminal.Gui.MouseEvent,System.Boolean)">MouseEvent(MouseEvent, Boolean)</h4>
  416. <div class="markdown level1 summary">
  417. Handle mouse events before <a class="xref" href="Terminal.Gui.IAutocomplete.html#Terminal_Gui_IAutocomplete_HostControl">HostControl</a> e.g. to make mouse events like
  418. report/click apply to the autocomplete control instead of changing the cursor position in
  419. the underlying text view.
  420. </div>
  421. <div class="markdown level1 conceptual"></div>
  422. <h5 class="decalaration">Declaration</h5>
  423. <div class="codewrapper">
  424. <pre><code class="lang-csharp hljs">bool MouseEvent(MouseEvent me, bool fromHost = false)</code></pre>
  425. </div>
  426. <h5 class="parameters">Parameters</h5>
  427. <table class="table table-bordered table-striped table-condensed">
  428. <thead>
  429. <tr>
  430. <th>Type</th>
  431. <th>Name</th>
  432. <th>Description</th>
  433. </tr>
  434. </thead>
  435. <tbody>
  436. <tr>
  437. <td><a class="xref" href="Terminal.Gui.MouseEvent.html">MouseEvent</a></td>
  438. <td><span class="parametername">me</span></td>
  439. <td>The mouse event.</td>
  440. </tr>
  441. <tr>
  442. <td><span class="xref">System.Boolean</span></td>
  443. <td><span class="parametername">fromHost</span></td>
  444. <td>If was called from the popup or from the host.</td>
  445. </tr>
  446. </tbody>
  447. </table>
  448. <h5 class="returns">Returns</h5>
  449. <table class="table table-bordered table-striped table-condensed">
  450. <thead>
  451. <tr>
  452. <th>Type</th>
  453. <th>Description</th>
  454. </tr>
  455. </thead>
  456. <tbody>
  457. <tr>
  458. <td><span class="xref">System.Boolean</span></td>
  459. <td><code>true</code>if the mouse can be handled <code>false</code>otherwise.</td>
  460. </tr>
  461. </tbody>
  462. </table>
  463. <a id="Terminal_Gui_IAutocomplete_ProcessKey_" data-uid="Terminal.Gui.IAutocomplete.ProcessKey*"></a>
  464. <h4 id="Terminal_Gui_IAutocomplete_ProcessKey_Terminal_Gui_KeyEvent_" data-uid="Terminal.Gui.IAutocomplete.ProcessKey(Terminal.Gui.KeyEvent)">ProcessKey(KeyEvent)</h4>
  465. <div class="markdown level1 summary">
  466. Handle key events before <a class="xref" href="Terminal.Gui.IAutocomplete.html#Terminal_Gui_IAutocomplete_HostControl">HostControl</a> e.g. to make key events like
  467. up/down apply to the autocomplete control instead of changing the cursor position in
  468. the underlying text view.
  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">bool ProcessKey(KeyEvent kb)</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.KeyEvent.html">KeyEvent</a></td>
  487. <td><span class="parametername">kb</span></td>
  488. <td>The key event.</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 the key can be handled <code>false</code>otherwise.</td>
  504. </tr>
  505. </tbody>
  506. </table>
  507. <a id="Terminal_Gui_IAutocomplete_RenderOverlay_" data-uid="Terminal.Gui.IAutocomplete.RenderOverlay*"></a>
  508. <h4 id="Terminal_Gui_IAutocomplete_RenderOverlay_Terminal_Gui_Point_" data-uid="Terminal.Gui.IAutocomplete.RenderOverlay(Terminal.Gui.Point)">RenderOverlay(Point)</h4>
  509. <div class="markdown level1 summary">
  510. Renders the autocomplete dialog inside the given <a class="xref" href="Terminal.Gui.IAutocomplete.html#Terminal_Gui_IAutocomplete_HostControl">HostControl</a> at the
  511. given point.
  512. </div>
  513. <div class="markdown level1 conceptual"></div>
  514. <h5 class="decalaration">Declaration</h5>
  515. <div class="codewrapper">
  516. <pre><code class="lang-csharp hljs">void RenderOverlay(Point renderAt)</code></pre>
  517. </div>
  518. <h5 class="parameters">Parameters</h5>
  519. <table class="table table-bordered table-striped table-condensed">
  520. <thead>
  521. <tr>
  522. <th>Type</th>
  523. <th>Name</th>
  524. <th>Description</th>
  525. </tr>
  526. </thead>
  527. <tbody>
  528. <tr>
  529. <td><a class="xref" href="Terminal.Gui.Point.html">Point</a></td>
  530. <td><span class="parametername">renderAt</span></td>
  531. <td></td>
  532. </tr>
  533. </tbody>
  534. </table>
  535. </article>
  536. </div>
  537. <div class="hidden-sm col-md-2" role="complementary">
  538. <div class="sideaffix">
  539. <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
  540. <h5>In This Article</h5>
  541. <div></div>
  542. </nav>
  543. </div>
  544. </div>
  545. </div>
  546. </div>
  547. <footer>
  548. <div class="grad-bottom"></div>
  549. <div class="footer">
  550. <div class="container">
  551. <span class="pull-right">
  552. <a href="#top">Back to top</a>
  553. </span>
  554. <span>Generated by <strong>DocFX</strong></span>
  555. </div>
  556. </div>
  557. </footer>
  558. </div>
  559. <script type="text/javascript" src="../../styles/docfx.vendor.js"></script>
  560. <script type="text/javascript" src="../../styles/docfx.js"></script>
  561. <script type="text/javascript" src="../../styles/main.js"></script>
  562. </body>
  563. </html>