Terminal.Gui.IAutocomplete.html 22 KB

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