Terminal.Gui.Autocomplete.html 60 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195
  1. <!DOCTYPE html>
  2. <!--[if IE]><![endif]-->
  3. <html>
  4. <head>
  5. <meta charset="utf-8">
  6. <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
  7. <title>Class Autocomplete
  8. </title>
  9. <meta name="viewport" content="width=device-width">
  10. <meta name="title" content="Class Autocomplete
  11. ">
  12. <meta name="generator" content="docfx 2.59.4.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.Autocomplete">
  74. <h1 id="Terminal_Gui_Autocomplete" data-uid="Terminal.Gui.Autocomplete" class="text-break">Class Autocomplete
  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. <div class="inheritance">
  82. <h5>Inheritance</h5>
  83. <div class="level0"><span class="xref">System.Object</span></div>
  84. <div class="level1"><span class="xref">Autocomplete</span></div>
  85. <div class="level2"><a class="xref" href="Terminal.Gui.TextFieldAutocomplete.html">TextFieldAutocomplete</a></div>
  86. <div class="level2"><a class="xref" href="Terminal.Gui.TextViewAutocomplete.html">TextViewAutocomplete</a></div>
  87. </div>
  88. <div class="implements">
  89. <h5>Implements</h5>
  90. <div><a class="xref" href="Terminal.Gui.IAutocomplete.html">IAutocomplete</a></div>
  91. </div>
  92. <div class="inheritedMembers">
  93. <h5>Inherited Members</h5>
  94. <div>
  95. <span class="xref">System.Object.Equals(System.Object)</span>
  96. </div>
  97. <div>
  98. <span class="xref">System.Object.Equals(System.Object, System.Object)</span>
  99. </div>
  100. <div>
  101. <span class="xref">System.Object.GetHashCode()</span>
  102. </div>
  103. <div>
  104. <span class="xref">System.Object.GetType()</span>
  105. </div>
  106. <div>
  107. <span class="xref">System.Object.MemberwiseClone()</span>
  108. </div>
  109. <div>
  110. <span class="xref">System.Object.ReferenceEquals(System.Object, System.Object)</span>
  111. </div>
  112. <div>
  113. <span class="xref">System.Object.ToString()</span>
  114. </div>
  115. </div>
  116. <h6><strong>Namespace</strong>: <a class="xref" href="Terminal.Gui.html">Terminal.Gui</a></h6>
  117. <h6><strong>Assembly</strong>: Terminal.Gui.dll</h6>
  118. <h5 id="Terminal_Gui_Autocomplete_syntax">Syntax</h5>
  119. <div class="codewrapper">
  120. <pre><code class="lang-csharp hljs">public abstract class Autocomplete : IAutocomplete</code></pre>
  121. </div>
  122. <h3 id="properties">Properties
  123. </h3>
  124. <span class="small pull-right mobile-hide">
  125. <span class="divider">|</span>
  126. <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/apidoc/new?filename=Terminal_Gui_Autocomplete_AllSuggestions.md&amp;value=---%0Auid%3A%20Terminal.Gui.Autocomplete.AllSuggestions%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>
  127. </span>
  128. <span class="small pull-right mobile-hide">
  129. <a href="tig:tig/gui.cs/blob/main/Terminal.Gui/Core/Autocomplete/Autocomplete.cs/#L145">View Source</a>
  130. </span>
  131. <a id="Terminal_Gui_Autocomplete_AllSuggestions_" data-uid="Terminal.Gui.Autocomplete.AllSuggestions*"></a>
  132. <h4 id="Terminal_Gui_Autocomplete_AllSuggestions" data-uid="Terminal.Gui.Autocomplete.AllSuggestions">AllSuggestions</h4>
  133. <div class="markdown level1 summary">
  134. The full set of all strings that can be suggested.
  135. </div>
  136. <div class="markdown level1 conceptual"></div>
  137. <h5 class="decalaration">Declaration</h5>
  138. <div class="codewrapper">
  139. <pre><code class="lang-csharp hljs">public virtual List&lt;string&gt; AllSuggestions { get; set; }</code></pre>
  140. </div>
  141. <h5 class="propertyValue">Property Value</h5>
  142. <table class="table table-bordered table-striped table-condensed">
  143. <thead>
  144. <tr>
  145. <th>Type</th>
  146. <th>Description</th>
  147. </tr>
  148. </thead>
  149. <tbody>
  150. <tr>
  151. <td><span class="xref">System.Collections.Generic.List</span>&lt;<span class="xref">System.String</span>&gt;</td>
  152. <td></td>
  153. </tr>
  154. </tbody>
  155. </table>
  156. <span class="small pull-right mobile-hide">
  157. <span class="divider">|</span>
  158. <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/apidoc/new?filename=Terminal_Gui_Autocomplete_CloseKey.md&amp;value=---%0Auid%3A%20Terminal.Gui.Autocomplete.CloseKey%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>
  159. </span>
  160. <span class="small pull-right mobile-hide">
  161. <a href="tig:tig/gui.cs/blob/main/Terminal.Gui/Core/Autocomplete/Autocomplete.cs/#L183">View Source</a>
  162. </span>
  163. <a id="Terminal_Gui_Autocomplete_CloseKey_" data-uid="Terminal.Gui.Autocomplete.CloseKey*"></a>
  164. <h4 id="Terminal_Gui_Autocomplete_CloseKey" data-uid="Terminal.Gui.Autocomplete.CloseKey">CloseKey</h4>
  165. <div class="markdown level1 summary">
  166. The key that the user can press to close the currently popped autocomplete menu
  167. </div>
  168. <div class="markdown level1 conceptual"></div>
  169. <h5 class="decalaration">Declaration</h5>
  170. <div class="codewrapper">
  171. <pre><code class="lang-csharp hljs">public virtual Key CloseKey { get; set; }</code></pre>
  172. </div>
  173. <h5 class="propertyValue">Property Value</h5>
  174. <table class="table table-bordered table-striped table-condensed">
  175. <thead>
  176. <tr>
  177. <th>Type</th>
  178. <th>Description</th>
  179. </tr>
  180. </thead>
  181. <tbody>
  182. <tr>
  183. <td><a class="xref" href="Terminal.Gui.Key.html">Key</a></td>
  184. <td></td>
  185. </tr>
  186. </tbody>
  187. </table>
  188. <span class="small pull-right mobile-hide">
  189. <span class="divider">|</span>
  190. <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/apidoc/new?filename=Terminal_Gui_Autocomplete_ColorScheme.md&amp;value=---%0Auid%3A%20Terminal.Gui.Autocomplete.ColorScheme%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>
  191. </span>
  192. <span class="small pull-right mobile-hide">
  193. <a href="tig:tig/gui.cs/blob/main/Terminal.Gui/Core/Autocomplete/Autocomplete.cs/#L163">View Source</a>
  194. </span>
  195. <a id="Terminal_Gui_Autocomplete_ColorScheme_" data-uid="Terminal.Gui.Autocomplete.ColorScheme*"></a>
  196. <h4 id="Terminal_Gui_Autocomplete_ColorScheme" data-uid="Terminal.Gui.Autocomplete.ColorScheme">ColorScheme</h4>
  197. <div class="markdown level1 summary">
  198. The colors to use to render the overlay. Accessing this property before
  199. the Application has been initialized will cause an error
  200. </div>
  201. <div class="markdown level1 conceptual"></div>
  202. <h5 class="decalaration">Declaration</h5>
  203. <div class="codewrapper">
  204. <pre><code class="lang-csharp hljs">public virtual ColorScheme ColorScheme { get; set; }</code></pre>
  205. </div>
  206. <h5 class="propertyValue">Property Value</h5>
  207. <table class="table table-bordered table-striped table-condensed">
  208. <thead>
  209. <tr>
  210. <th>Type</th>
  211. <th>Description</th>
  212. </tr>
  213. </thead>
  214. <tbody>
  215. <tr>
  216. <td><a class="xref" href="Terminal.Gui.ColorScheme.html">ColorScheme</a></td>
  217. <td></td>
  218. </tr>
  219. </tbody>
  220. </table>
  221. <span class="small pull-right mobile-hide">
  222. <span class="divider">|</span>
  223. <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/apidoc/new?filename=Terminal_Gui_Autocomplete_HostControl.md&amp;value=---%0Auid%3A%20Terminal.Gui.Autocomplete.HostControl%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>
  224. </span>
  225. <span class="small pull-right mobile-hide">
  226. <a href="tig:tig/gui.cs/blob/main/Terminal.Gui/Core/Autocomplete/Autocomplete.cs/#L64">View Source</a>
  227. </span>
  228. <a id="Terminal_Gui_Autocomplete_HostControl_" data-uid="Terminal.Gui.Autocomplete.HostControl*"></a>
  229. <h4 id="Terminal_Gui_Autocomplete_HostControl" data-uid="Terminal.Gui.Autocomplete.HostControl">HostControl</h4>
  230. <div class="markdown level1 summary">
  231. The host control to handle.
  232. </div>
  233. <div class="markdown level1 conceptual"></div>
  234. <h5 class="decalaration">Declaration</h5>
  235. <div class="codewrapper">
  236. <pre><code class="lang-csharp hljs">public virtual View HostControl { get; set; }</code></pre>
  237. </div>
  238. <h5 class="propertyValue">Property Value</h5>
  239. <table class="table table-bordered table-striped table-condensed">
  240. <thead>
  241. <tr>
  242. <th>Type</th>
  243. <th>Description</th>
  244. </tr>
  245. </thead>
  246. <tbody>
  247. <tr>
  248. <td><a class="xref" href="Terminal.Gui.View.html">View</a></td>
  249. <td></td>
  250. </tr>
  251. </tbody>
  252. </table>
  253. <span class="small pull-right mobile-hide">
  254. <span class="divider">|</span>
  255. <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/apidoc/new?filename=Terminal_Gui_Autocomplete_MaxHeight.md&amp;value=---%0Auid%3A%20Terminal.Gui.Autocomplete.MaxHeight%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>
  256. </span>
  257. <span class="small pull-right mobile-hide">
  258. <a href="tig:tig/gui.cs/blob/main/Terminal.Gui/Core/Autocomplete/Autocomplete.cs/#L128">View Source</a>
  259. </span>
  260. <a id="Terminal_Gui_Autocomplete_MaxHeight_" data-uid="Terminal.Gui.Autocomplete.MaxHeight*"></a>
  261. <h4 id="Terminal_Gui_Autocomplete_MaxHeight" data-uid="Terminal.Gui.Autocomplete.MaxHeight">MaxHeight</h4>
  262. <div class="markdown level1 summary">
  263. The maximum number of visible rows in the autocomplete dropdown to render
  264. </div>
  265. <div class="markdown level1 conceptual"></div>
  266. <h5 class="decalaration">Declaration</h5>
  267. <div class="codewrapper">
  268. <pre><code class="lang-csharp hljs">public virtual int MaxHeight { get; set; }</code></pre>
  269. </div>
  270. <h5 class="propertyValue">Property Value</h5>
  271. <table class="table table-bordered table-striped table-condensed">
  272. <thead>
  273. <tr>
  274. <th>Type</th>
  275. <th>Description</th>
  276. </tr>
  277. </thead>
  278. <tbody>
  279. <tr>
  280. <td><span class="xref">System.Int32</span></td>
  281. <td></td>
  282. </tr>
  283. </tbody>
  284. </table>
  285. <span class="small pull-right mobile-hide">
  286. <span class="divider">|</span>
  287. <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/apidoc/new?filename=Terminal_Gui_Autocomplete_MaxWidth.md&amp;value=---%0Auid%3A%20Terminal.Gui.Autocomplete.MaxWidth%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. </span>
  289. <span class="small pull-right mobile-hide">
  290. <a href="tig:tig/gui.cs/blob/main/Terminal.Gui/Core/Autocomplete/Autocomplete.cs/#L123">View Source</a>
  291. </span>
  292. <a id="Terminal_Gui_Autocomplete_MaxWidth_" data-uid="Terminal.Gui.Autocomplete.MaxWidth*"></a>
  293. <h4 id="Terminal_Gui_Autocomplete_MaxWidth" data-uid="Terminal.Gui.Autocomplete.MaxWidth">MaxWidth</h4>
  294. <div class="markdown level1 summary">
  295. The maximum width of the autocomplete dropdown
  296. </div>
  297. <div class="markdown level1 conceptual"></div>
  298. <h5 class="decalaration">Declaration</h5>
  299. <div class="codewrapper">
  300. <pre><code class="lang-csharp hljs">public virtual int MaxWidth { get; set; }</code></pre>
  301. </div>
  302. <h5 class="propertyValue">Property Value</h5>
  303. <table class="table table-bordered table-striped table-condensed">
  304. <thead>
  305. <tr>
  306. <th>Type</th>
  307. <th>Description</th>
  308. </tr>
  309. </thead>
  310. <tbody>
  311. <tr>
  312. <td><span class="xref">System.Int32</span></td>
  313. <td></td>
  314. </tr>
  315. </tbody>
  316. </table>
  317. <span class="small pull-right mobile-hide">
  318. <span class="divider">|</span>
  319. <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/apidoc/new?filename=Terminal_Gui_Autocomplete_PopupInsideContainer.md&amp;value=---%0Auid%3A%20Terminal.Gui.Autocomplete.PopupInsideContainer%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>
  320. </span>
  321. <span class="small pull-right mobile-hide">
  322. <a href="tig:tig/gui.cs/blob/main/Terminal.Gui/Core/Autocomplete/Autocomplete.cs/#L118">View Source</a>
  323. </span>
  324. <a id="Terminal_Gui_Autocomplete_PopupInsideContainer_" data-uid="Terminal.Gui.Autocomplete.PopupInsideContainer*"></a>
  325. <h4 id="Terminal_Gui_Autocomplete_PopupInsideContainer" data-uid="Terminal.Gui.Autocomplete.PopupInsideContainer">PopupInsideContainer</h4>
  326. <div class="markdown level1 summary">
  327. Gets or sets If the popup is displayed inside or outside the host limits.
  328. </div>
  329. <div class="markdown level1 conceptual"></div>
  330. <h5 class="decalaration">Declaration</h5>
  331. <div class="codewrapper">
  332. <pre><code class="lang-csharp hljs">public bool PopupInsideContainer { get; set; }</code></pre>
  333. </div>
  334. <h5 class="propertyValue">Property Value</h5>
  335. <table class="table table-bordered table-striped table-condensed">
  336. <thead>
  337. <tr>
  338. <th>Type</th>
  339. <th>Description</th>
  340. </tr>
  341. </thead>
  342. <tbody>
  343. <tr>
  344. <td><span class="xref">System.Boolean</span></td>
  345. <td></td>
  346. </tr>
  347. </tbody>
  348. </table>
  349. <span class="small pull-right mobile-hide">
  350. <span class="divider">|</span>
  351. <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/apidoc/new?filename=Terminal_Gui_Autocomplete_Reopen.md&amp;value=---%0Auid%3A%20Terminal.Gui.Autocomplete.Reopen%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>
  352. </span>
  353. <span class="small pull-right mobile-hide">
  354. <a href="tig:tig/gui.cs/blob/main/Terminal.Gui/Core/Autocomplete/Autocomplete.cs/#L188">View Source</a>
  355. </span>
  356. <a id="Terminal_Gui_Autocomplete_Reopen_" data-uid="Terminal.Gui.Autocomplete.Reopen*"></a>
  357. <h4 id="Terminal_Gui_Autocomplete_Reopen" data-uid="Terminal.Gui.Autocomplete.Reopen">Reopen</h4>
  358. <div class="markdown level1 summary">
  359. The key that the user can press to reopen the currently popped autocomplete menu
  360. </div>
  361. <div class="markdown level1 conceptual"></div>
  362. <h5 class="decalaration">Declaration</h5>
  363. <div class="codewrapper">
  364. <pre><code class="lang-csharp hljs">public virtual Key Reopen { get; set; }</code></pre>
  365. </div>
  366. <h5 class="propertyValue">Property Value</h5>
  367. <table class="table table-bordered table-striped table-condensed">
  368. <thead>
  369. <tr>
  370. <th>Type</th>
  371. <th>Description</th>
  372. </tr>
  373. </thead>
  374. <tbody>
  375. <tr>
  376. <td><a class="xref" href="Terminal.Gui.Key.html">Key</a></td>
  377. <td></td>
  378. </tr>
  379. </tbody>
  380. </table>
  381. <span class="small pull-right mobile-hide">
  382. <span class="divider">|</span>
  383. <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/apidoc/new?filename=Terminal_Gui_Autocomplete_ScrollOffset.md&amp;value=---%0Auid%3A%20Terminal.Gui.Autocomplete.ScrollOffset%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>
  384. </span>
  385. <span class="small pull-right mobile-hide">
  386. <a href="tig:tig/gui.cs/blob/main/Terminal.Gui/Core/Autocomplete/Autocomplete.cs/#L157">View Source</a>
  387. </span>
  388. <a id="Terminal_Gui_Autocomplete_ScrollOffset_" data-uid="Terminal.Gui.Autocomplete.ScrollOffset*"></a>
  389. <h4 id="Terminal_Gui_Autocomplete_ScrollOffset" data-uid="Terminal.Gui.Autocomplete.ScrollOffset">ScrollOffset</h4>
  390. <div class="markdown level1 summary">
  391. When more suggestions are available than can be rendered the user
  392. can scroll down the dropdown list. This indicates how far down they
  393. have gone
  394. </div>
  395. <div class="markdown level1 conceptual"></div>
  396. <h5 class="decalaration">Declaration</h5>
  397. <div class="codewrapper">
  398. <pre><code class="lang-csharp hljs">public virtual int ScrollOffset { get; set; }</code></pre>
  399. </div>
  400. <h5 class="propertyValue">Property Value</h5>
  401. <table class="table table-bordered table-striped table-condensed">
  402. <thead>
  403. <tr>
  404. <th>Type</th>
  405. <th>Description</th>
  406. </tr>
  407. </thead>
  408. <tbody>
  409. <tr>
  410. <td><span class="xref">System.Int32</span></td>
  411. <td></td>
  412. </tr>
  413. </tbody>
  414. </table>
  415. <span class="small pull-right mobile-hide">
  416. <span class="divider">|</span>
  417. <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/apidoc/new?filename=Terminal_Gui_Autocomplete_SelectedIdx.md&amp;value=---%0Auid%3A%20Terminal.Gui.Autocomplete.SelectedIdx%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>
  418. </span>
  419. <span class="small pull-right mobile-hide">
  420. <a href="tig:tig/gui.cs/blob/main/Terminal.Gui/Core/Autocomplete/Autocomplete.cs/#L150">View Source</a>
  421. </span>
  422. <a id="Terminal_Gui_Autocomplete_SelectedIdx_" data-uid="Terminal.Gui.Autocomplete.SelectedIdx*"></a>
  423. <h4 id="Terminal_Gui_Autocomplete_SelectedIdx" data-uid="Terminal.Gui.Autocomplete.SelectedIdx">SelectedIdx</h4>
  424. <div class="markdown level1 summary">
  425. The currently selected index into <a class="xref" href="Terminal.Gui.Autocomplete.html#Terminal_Gui_Autocomplete_Suggestions">Suggestions</a> that the user has highlighted
  426. </div>
  427. <div class="markdown level1 conceptual"></div>
  428. <h5 class="decalaration">Declaration</h5>
  429. <div class="codewrapper">
  430. <pre><code class="lang-csharp hljs">public virtual int SelectedIdx { get; set; }</code></pre>
  431. </div>
  432. <h5 class="propertyValue">Property Value</h5>
  433. <table class="table table-bordered table-striped table-condensed">
  434. <thead>
  435. <tr>
  436. <th>Type</th>
  437. <th>Description</th>
  438. </tr>
  439. </thead>
  440. <tbody>
  441. <tr>
  442. <td><span class="xref">System.Int32</span></td>
  443. <td></td>
  444. </tr>
  445. </tbody>
  446. </table>
  447. <span class="small pull-right mobile-hide">
  448. <span class="divider">|</span>
  449. <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/apidoc/new?filename=Terminal_Gui_Autocomplete_SelectionKey.md&amp;value=---%0Auid%3A%20Terminal.Gui.Autocomplete.SelectionKey%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>
  450. </span>
  451. <span class="small pull-right mobile-hide">
  452. <a href="tig:tig/gui.cs/blob/main/Terminal.Gui/Core/Autocomplete/Autocomplete.cs/#L178">View Source</a>
  453. </span>
  454. <a id="Terminal_Gui_Autocomplete_SelectionKey_" data-uid="Terminal.Gui.Autocomplete.SelectionKey*"></a>
  455. <h4 id="Terminal_Gui_Autocomplete_SelectionKey" data-uid="Terminal.Gui.Autocomplete.SelectionKey">SelectionKey</h4>
  456. <div class="markdown level1 summary">
  457. The key that the user must press to accept the currently selected autocomplete suggestion
  458. </div>
  459. <div class="markdown level1 conceptual"></div>
  460. <h5 class="decalaration">Declaration</h5>
  461. <div class="codewrapper">
  462. <pre><code class="lang-csharp hljs">public virtual Key SelectionKey { get; set; }</code></pre>
  463. </div>
  464. <h5 class="propertyValue">Property Value</h5>
  465. <table class="table table-bordered table-striped table-condensed">
  466. <thead>
  467. <tr>
  468. <th>Type</th>
  469. <th>Description</th>
  470. </tr>
  471. </thead>
  472. <tbody>
  473. <tr>
  474. <td><a class="xref" href="Terminal.Gui.Key.html">Key</a></td>
  475. <td></td>
  476. </tr>
  477. </tbody>
  478. </table>
  479. <span class="small pull-right mobile-hide">
  480. <span class="divider">|</span>
  481. <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/apidoc/new?filename=Terminal_Gui_Autocomplete_Suggestions.md&amp;value=---%0Auid%3A%20Terminal.Gui.Autocomplete.Suggestions%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>
  482. </span>
  483. <span class="small pull-right mobile-hide">
  484. <a href="tig:tig/gui.cs/blob/main/Terminal.Gui/Core/Autocomplete/Autocomplete.cs/#L139">View Source</a>
  485. </span>
  486. <a id="Terminal_Gui_Autocomplete_Suggestions_" data-uid="Terminal.Gui.Autocomplete.Suggestions*"></a>
  487. <h4 id="Terminal_Gui_Autocomplete_Suggestions" data-uid="Terminal.Gui.Autocomplete.Suggestions">Suggestions</h4>
  488. <div class="markdown level1 summary">
  489. The strings that form the current list of suggestions to render
  490. based on what the user has typed so far.
  491. </div>
  492. <div class="markdown level1 conceptual"></div>
  493. <h5 class="decalaration">Declaration</h5>
  494. <div class="codewrapper">
  495. <pre><code class="lang-csharp hljs">public virtual ReadOnlyCollection&lt;string&gt; Suggestions { get; set; }</code></pre>
  496. </div>
  497. <h5 class="propertyValue">Property Value</h5>
  498. <table class="table table-bordered table-striped table-condensed">
  499. <thead>
  500. <tr>
  501. <th>Type</th>
  502. <th>Description</th>
  503. </tr>
  504. </thead>
  505. <tbody>
  506. <tr>
  507. <td><span class="xref">System.Collections.ObjectModel.ReadOnlyCollection</span>&lt;<span class="xref">System.String</span>&gt;</td>
  508. <td></td>
  509. </tr>
  510. </tbody>
  511. </table>
  512. <span class="small pull-right mobile-hide">
  513. <span class="divider">|</span>
  514. <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/apidoc/new?filename=Terminal_Gui_Autocomplete_Visible.md&amp;value=---%0Auid%3A%20Terminal.Gui.Autocomplete.Visible%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>
  515. </span>
  516. <span class="small pull-right mobile-hide">
  517. <a href="tig:tig/gui.cs/blob/main/Terminal.Gui/Core/Autocomplete/Autocomplete.cs/#L133">View Source</a>
  518. </span>
  519. <a id="Terminal_Gui_Autocomplete_Visible_" data-uid="Terminal.Gui.Autocomplete.Visible*"></a>
  520. <h4 id="Terminal_Gui_Autocomplete_Visible" data-uid="Terminal.Gui.Autocomplete.Visible">Visible</h4>
  521. <div class="markdown level1 summary">
  522. True if the autocomplete should be considered open and visible
  523. </div>
  524. <div class="markdown level1 conceptual"></div>
  525. <h5 class="decalaration">Declaration</h5>
  526. <div class="codewrapper">
  527. <pre><code class="lang-csharp hljs">public virtual bool Visible { get; set; }</code></pre>
  528. </div>
  529. <h5 class="propertyValue">Property Value</h5>
  530. <table class="table table-bordered table-striped table-condensed">
  531. <thead>
  532. <tr>
  533. <th>Type</th>
  534. <th>Description</th>
  535. </tr>
  536. </thead>
  537. <tbody>
  538. <tr>
  539. <td><span class="xref">System.Boolean</span></td>
  540. <td></td>
  541. </tr>
  542. </tbody>
  543. </table>
  544. <h3 id="methods">Methods
  545. </h3>
  546. <span class="small pull-right mobile-hide">
  547. <span class="divider">|</span>
  548. <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/apidoc/new?filename=Terminal_Gui_Autocomplete_ClearSuggestions.md&amp;value=---%0Auid%3A%20Terminal.Gui.Autocomplete.ClearSuggestions%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>
  549. </span>
  550. <span class="small pull-right mobile-hide">
  551. <a href="tig:tig/gui.cs/blob/main/Terminal.Gui/Core/Autocomplete/Autocomplete.cs/#L437">View Source</a>
  552. </span>
  553. <a id="Terminal_Gui_Autocomplete_ClearSuggestions_" data-uid="Terminal.Gui.Autocomplete.ClearSuggestions*"></a>
  554. <h4 id="Terminal_Gui_Autocomplete_ClearSuggestions" data-uid="Terminal.Gui.Autocomplete.ClearSuggestions">ClearSuggestions()</h4>
  555. <div class="markdown level1 summary">
  556. Clears <a class="xref" href="Terminal.Gui.Autocomplete.html#Terminal_Gui_Autocomplete_Suggestions">Suggestions</a>
  557. </div>
  558. <div class="markdown level1 conceptual"></div>
  559. <h5 class="decalaration">Declaration</h5>
  560. <div class="codewrapper">
  561. <pre><code class="lang-csharp hljs">public virtual void ClearSuggestions()</code></pre>
  562. </div>
  563. <span class="small pull-right mobile-hide">
  564. <span class="divider">|</span>
  565. <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/apidoc/new?filename=Terminal_Gui_Autocomplete_Close.md&amp;value=---%0Auid%3A%20Terminal.Gui.Autocomplete.Close%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>
  566. </span>
  567. <span class="small pull-right mobile-hide">
  568. <a href="tig:tig/gui.cs/blob/main/Terminal.Gui/Core/Autocomplete/Autocomplete.cs/#L591">View Source</a>
  569. </span>
  570. <a id="Terminal_Gui_Autocomplete_Close_" data-uid="Terminal.Gui.Autocomplete.Close*"></a>
  571. <h4 id="Terminal_Gui_Autocomplete_Close" data-uid="Terminal.Gui.Autocomplete.Close">Close()</h4>
  572. <div class="markdown level1 summary">
  573. Closes the Autocomplete context menu if it is showing and <a class="xref" href="Terminal.Gui.Autocomplete.html#Terminal_Gui_Autocomplete_ClearSuggestions">ClearSuggestions()</a>
  574. </div>
  575. <div class="markdown level1 conceptual"></div>
  576. <h5 class="decalaration">Declaration</h5>
  577. <div class="codewrapper">
  578. <pre><code class="lang-csharp hljs">protected void Close()</code></pre>
  579. </div>
  580. <span class="small pull-right mobile-hide">
  581. <span class="divider">|</span>
  582. <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/apidoc/new?filename=Terminal_Gui_Autocomplete_DeleteTextBackwards.md&amp;value=---%0Auid%3A%20Terminal.Gui.Autocomplete.DeleteTextBackwards%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>
  583. </span>
  584. <span class="small pull-right mobile-hide">
  585. <a href="tig:tig/gui.cs/blob/main/Terminal.Gui/Core/Autocomplete/Autocomplete.cs/#L580">View Source</a>
  586. </span>
  587. <a id="Terminal_Gui_Autocomplete_DeleteTextBackwards_" data-uid="Terminal.Gui.Autocomplete.DeleteTextBackwards*"></a>
  588. <h4 id="Terminal_Gui_Autocomplete_DeleteTextBackwards" data-uid="Terminal.Gui.Autocomplete.DeleteTextBackwards">DeleteTextBackwards()</h4>
  589. <div class="markdown level1 summary">
  590. Deletes the text backwards before insert the selected text in the <a class="xref" href="Terminal.Gui.Autocomplete.html#Terminal_Gui_Autocomplete_HostControl">HostControl</a>.
  591. </div>
  592. <div class="markdown level1 conceptual"></div>
  593. <h5 class="decalaration">Declaration</h5>
  594. <div class="codewrapper">
  595. <pre><code class="lang-csharp hljs">protected abstract void DeleteTextBackwards()</code></pre>
  596. </div>
  597. <span class="small pull-right mobile-hide">
  598. <span class="divider">|</span>
  599. <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/apidoc/new?filename=Terminal_Gui_Autocomplete_EnsureSelectedIdxIsValid.md&amp;value=---%0Auid%3A%20Terminal.Gui.Autocomplete.EnsureSelectedIdxIsValid%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>
  600. </span>
  601. <span class="small pull-right mobile-hide">
  602. <a href="tig:tig/gui.cs/blob/main/Terminal.Gui/Core/Autocomplete/Autocomplete.cs/#L300">View Source</a>
  603. </span>
  604. <a id="Terminal_Gui_Autocomplete_EnsureSelectedIdxIsValid_" data-uid="Terminal.Gui.Autocomplete.EnsureSelectedIdxIsValid*"></a>
  605. <h4 id="Terminal_Gui_Autocomplete_EnsureSelectedIdxIsValid" data-uid="Terminal.Gui.Autocomplete.EnsureSelectedIdxIsValid">EnsureSelectedIdxIsValid()</h4>
  606. <div class="markdown level1 summary">
  607. Updates <a class="xref" href="Terminal.Gui.Autocomplete.html#Terminal_Gui_Autocomplete_SelectedIdx">SelectedIdx</a> to be a valid index within <a class="xref" href="Terminal.Gui.Autocomplete.html#Terminal_Gui_Autocomplete_Suggestions">Suggestions</a>
  608. </div>
  609. <div class="markdown level1 conceptual"></div>
  610. <h5 class="decalaration">Declaration</h5>
  611. <div class="codewrapper">
  612. <pre><code class="lang-csharp hljs">public virtual void EnsureSelectedIdxIsValid()</code></pre>
  613. </div>
  614. <span class="small pull-right mobile-hide">
  615. <span class="divider">|</span>
  616. <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/apidoc/new?filename=Terminal_Gui_Autocomplete_GenerateSuggestions.md&amp;value=---%0Auid%3A%20Terminal.Gui.Autocomplete.GenerateSuggestions%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>
  617. </span>
  618. <span class="small pull-right mobile-hide">
  619. <a href="tig:tig/gui.cs/blob/main/Terminal.Gui/Core/Autocomplete/Autocomplete.cs/#L447">View Source</a>
  620. </span>
  621. <a id="Terminal_Gui_Autocomplete_GenerateSuggestions_" data-uid="Terminal.Gui.Autocomplete.GenerateSuggestions*"></a>
  622. <h4 id="Terminal_Gui_Autocomplete_GenerateSuggestions" data-uid="Terminal.Gui.Autocomplete.GenerateSuggestions">GenerateSuggestions()</h4>
  623. <div class="markdown level1 summary">
  624. Populates <a class="xref" href="Terminal.Gui.Autocomplete.html#Terminal_Gui_Autocomplete_Suggestions">Suggestions</a> with all strings in <a class="xref" href="Terminal.Gui.Autocomplete.html#Terminal_Gui_Autocomplete_AllSuggestions">AllSuggestions</a> that
  625. match with the current cursor position/text in the <a class="xref" href="Terminal.Gui.Autocomplete.html#Terminal_Gui_Autocomplete_HostControl">HostControl</a>
  626. </div>
  627. <div class="markdown level1 conceptual"></div>
  628. <h5 class="decalaration">Declaration</h5>
  629. <div class="codewrapper">
  630. <pre><code class="lang-csharp hljs">public virtual void GenerateSuggestions()</code></pre>
  631. </div>
  632. <span class="small pull-right mobile-hide">
  633. <span class="divider">|</span>
  634. <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/apidoc/new?filename=Terminal_Gui_Autocomplete_GetCurrentWord.md&amp;value=---%0Auid%3A%20Terminal.Gui.Autocomplete.GetCurrentWord%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>
  635. </span>
  636. <span class="small pull-right mobile-hide">
  637. <a href="tig:tig/gui.cs/blob/main/Terminal.Gui/Core/Autocomplete/Autocomplete.cs/#L531">View Source</a>
  638. </span>
  639. <a id="Terminal_Gui_Autocomplete_GetCurrentWord_" data-uid="Terminal.Gui.Autocomplete.GetCurrentWord*"></a>
  640. <h4 id="Terminal_Gui_Autocomplete_GetCurrentWord" data-uid="Terminal.Gui.Autocomplete.GetCurrentWord">GetCurrentWord()</h4>
  641. <div class="markdown level1 summary">
  642. Returns the currently selected word from the <a class="xref" href="Terminal.Gui.Autocomplete.html#Terminal_Gui_Autocomplete_HostControl">HostControl</a>.
  643. <p>
  644. When overriding this method views can make use of <a class="xref" href="Terminal.Gui.Autocomplete.html#Terminal_Gui_Autocomplete_IdxToWord_System_Collections_Generic_List_System_Rune__System_Int32_">IdxToWord(List&lt;Rune&gt;, Int32)</a>
  645. </p>
  646. </div>
  647. <div class="markdown level1 conceptual"></div>
  648. <h5 class="decalaration">Declaration</h5>
  649. <div class="codewrapper">
  650. <pre><code class="lang-csharp hljs">protected abstract string GetCurrentWord()</code></pre>
  651. </div>
  652. <h5 class="returns">Returns</h5>
  653. <table class="table table-bordered table-striped table-condensed">
  654. <thead>
  655. <tr>
  656. <th>Type</th>
  657. <th>Description</th>
  658. </tr>
  659. </thead>
  660. <tbody>
  661. <tr>
  662. <td><span class="xref">System.String</span></td>
  663. <td></td>
  664. </tr>
  665. </tbody>
  666. </table>
  667. <span class="small pull-right mobile-hide">
  668. <span class="divider">|</span>
  669. <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/apidoc/new?filename=Terminal_Gui_Autocomplete_IdxToWord_System_Collections_Generic_List_System_Rune__System_Int32_.md&amp;value=---%0Auid%3A%20Terminal.Gui.Autocomplete.IdxToWord(System.Collections.Generic.List%7BSystem.Rune%7D%2CSystem.Int32)%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>
  670. </span>
  671. <span class="small pull-right mobile-hide">
  672. <a href="tig:tig/gui.cs/blob/main/Terminal.Gui/Core/Autocomplete/Autocomplete.cs/#L545">View Source</a>
  673. </span>
  674. <a id="Terminal_Gui_Autocomplete_IdxToWord_" data-uid="Terminal.Gui.Autocomplete.IdxToWord*"></a>
  675. <h4 id="Terminal_Gui_Autocomplete_IdxToWord_System_Collections_Generic_List_System_Rune__System_Int32_" data-uid="Terminal.Gui.Autocomplete.IdxToWord(System.Collections.Generic.List{System.Rune},System.Int32)">IdxToWord(List&lt;Rune&gt;, Int32)</h4>
  676. <div class="markdown level1 summary">
  677. <p>
  678. Given a <code data-dev-comment-type="paramref" class="paramref">line</code> of characters, returns the word which ends at <code data-dev-comment-type="paramref" class="paramref">idx</code>
  679. or null. Also returns null if the <code data-dev-comment-type="paramref" class="paramref">idx</code> is positioned in the middle of a word.
  680. </p>
  681. <p>Use this method to determine whether autocomplete should be shown when the cursor is at
  682. a given point in a line and to get the word from which suggestions should be generated.</p>
  683. </div>
  684. <div class="markdown level1 conceptual"></div>
  685. <h5 class="decalaration">Declaration</h5>
  686. <div class="codewrapper">
  687. <pre><code class="lang-csharp hljs">protected virtual string IdxToWord(List&lt;Rune&gt; line, int idx)</code></pre>
  688. </div>
  689. <h5 class="parameters">Parameters</h5>
  690. <table class="table table-bordered table-striped table-condensed">
  691. <thead>
  692. <tr>
  693. <th>Type</th>
  694. <th>Name</th>
  695. <th>Description</th>
  696. </tr>
  697. </thead>
  698. <tbody>
  699. <tr>
  700. <td><span class="xref">System.Collections.Generic.List</span>&lt;<span class="xref">System.Rune</span>&gt;</td>
  701. <td><span class="parametername">line</span></td>
  702. <td></td>
  703. </tr>
  704. <tr>
  705. <td><span class="xref">System.Int32</span></td>
  706. <td><span class="parametername">idx</span></td>
  707. <td></td>
  708. </tr>
  709. </tbody>
  710. </table>
  711. <h5 class="returns">Returns</h5>
  712. <table class="table table-bordered table-striped table-condensed">
  713. <thead>
  714. <tr>
  715. <th>Type</th>
  716. <th>Description</th>
  717. </tr>
  718. </thead>
  719. <tbody>
  720. <tr>
  721. <td><span class="xref">System.String</span></td>
  722. <td></td>
  723. </tr>
  724. </tbody>
  725. </table>
  726. <span class="small pull-right mobile-hide">
  727. <span class="divider">|</span>
  728. <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/apidoc/new?filename=Terminal_Gui_Autocomplete_InsertSelection_System_String_.md&amp;value=---%0Auid%3A%20Terminal.Gui.Autocomplete.InsertSelection(System.String)%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>
  729. </span>
  730. <span class="small pull-right mobile-hide">
  731. <a href="tig:tig/gui.cs/blob/main/Terminal.Gui/Core/Autocomplete/Autocomplete.cs/#L506">View Source</a>
  732. </span>
  733. <a id="Terminal_Gui_Autocomplete_InsertSelection_" data-uid="Terminal.Gui.Autocomplete.InsertSelection*"></a>
  734. <h4 id="Terminal_Gui_Autocomplete_InsertSelection_System_String_" data-uid="Terminal.Gui.Autocomplete.InsertSelection(System.String)">InsertSelection(String)</h4>
  735. <div class="markdown level1 summary">
  736. Called when the user confirms a selection at the current cursor location in
  737. the <a class="xref" href="Terminal.Gui.Autocomplete.html#Terminal_Gui_Autocomplete_HostControl">HostControl</a>. The <code data-dev-comment-type="paramref" class="paramref">accepted</code> string
  738. is the full autocomplete word to be inserted. Typically a host will have to
  739. remove some characters such that the <code data-dev-comment-type="paramref" class="paramref">accepted</code> string
  740. completes the word instead of simply being appended.
  741. </div>
  742. <div class="markdown level1 conceptual"></div>
  743. <h5 class="decalaration">Declaration</h5>
  744. <div class="codewrapper">
  745. <pre><code class="lang-csharp hljs">protected virtual bool InsertSelection(string accepted)</code></pre>
  746. </div>
  747. <h5 class="parameters">Parameters</h5>
  748. <table class="table table-bordered table-striped table-condensed">
  749. <thead>
  750. <tr>
  751. <th>Type</th>
  752. <th>Name</th>
  753. <th>Description</th>
  754. </tr>
  755. </thead>
  756. <tbody>
  757. <tr>
  758. <td><span class="xref">System.String</span></td>
  759. <td><span class="parametername">accepted</span></td>
  760. <td></td>
  761. </tr>
  762. </tbody>
  763. </table>
  764. <h5 class="returns">Returns</h5>
  765. <table class="table table-bordered table-striped table-condensed">
  766. <thead>
  767. <tr>
  768. <th>Type</th>
  769. <th>Description</th>
  770. </tr>
  771. </thead>
  772. <tbody>
  773. <tr>
  774. <td><span class="xref">System.Boolean</span></td>
  775. <td>True if the insertion was possible otherwise false</td>
  776. </tr>
  777. </tbody>
  778. </table>
  779. <span class="small pull-right mobile-hide">
  780. <span class="divider">|</span>
  781. <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/apidoc/new?filename=Terminal_Gui_Autocomplete_InsertText_System_String_.md&amp;value=---%0Auid%3A%20Terminal.Gui.Autocomplete.InsertText(System.String)%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>
  782. </span>
  783. <span class="small pull-right mobile-hide">
  784. <a href="tig:tig/gui.cs/blob/main/Terminal.Gui/Core/Autocomplete/Autocomplete.cs/#L586">View Source</a>
  785. </span>
  786. <a id="Terminal_Gui_Autocomplete_InsertText_" data-uid="Terminal.Gui.Autocomplete.InsertText*"></a>
  787. <h4 id="Terminal_Gui_Autocomplete_InsertText_System_String_" data-uid="Terminal.Gui.Autocomplete.InsertText(System.String)">InsertText(String)</h4>
  788. <div class="markdown level1 summary">
  789. Inser the selected text in the <a class="xref" href="Terminal.Gui.Autocomplete.html#Terminal_Gui_Autocomplete_HostControl">HostControl</a>.
  790. </div>
  791. <div class="markdown level1 conceptual"></div>
  792. <h5 class="decalaration">Declaration</h5>
  793. <div class="codewrapper">
  794. <pre><code class="lang-csharp hljs">protected abstract void InsertText(string accepted)</code></pre>
  795. </div>
  796. <h5 class="parameters">Parameters</h5>
  797. <table class="table table-bordered table-striped table-condensed">
  798. <thead>
  799. <tr>
  800. <th>Type</th>
  801. <th>Name</th>
  802. <th>Description</th>
  803. </tr>
  804. </thead>
  805. <tbody>
  806. <tr>
  807. <td><span class="xref">System.String</span></td>
  808. <td><span class="parametername">accepted</span></td>
  809. <td></td>
  810. </tr>
  811. </tbody>
  812. </table>
  813. <span class="small pull-right mobile-hide">
  814. <span class="divider">|</span>
  815. <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/apidoc/new?filename=Terminal_Gui_Autocomplete_IsWordChar_System_Rune_.md&amp;value=---%0Auid%3A%20Terminal.Gui.Autocomplete.IsWordChar(System.Rune)%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>
  816. </span>
  817. <span class="small pull-right mobile-hide">
  818. <a href="tig:tig/gui.cs/blob/main/Terminal.Gui/Core/Autocomplete/Autocomplete.cs/#L476">View Source</a>
  819. </span>
  820. <a id="Terminal_Gui_Autocomplete_IsWordChar_" data-uid="Terminal.Gui.Autocomplete.IsWordChar*"></a>
  821. <h4 id="Terminal_Gui_Autocomplete_IsWordChar_System_Rune_" data-uid="Terminal.Gui.Autocomplete.IsWordChar(System.Rune)">IsWordChar(Rune)</h4>
  822. <div class="markdown level1 summary">
  823. Return true if the given symbol should be considered part of a word
  824. and can be contained in matches. Base behavior is to use <span class="xref">System.Char.IsLetterOrDigit(System.Char)</span>
  825. </div>
  826. <div class="markdown level1 conceptual"></div>
  827. <h5 class="decalaration">Declaration</h5>
  828. <div class="codewrapper">
  829. <pre><code class="lang-csharp hljs">public virtual bool IsWordChar(Rune rune)</code></pre>
  830. </div>
  831. <h5 class="parameters">Parameters</h5>
  832. <table class="table table-bordered table-striped table-condensed">
  833. <thead>
  834. <tr>
  835. <th>Type</th>
  836. <th>Name</th>
  837. <th>Description</th>
  838. </tr>
  839. </thead>
  840. <tbody>
  841. <tr>
  842. <td><span class="xref">System.Rune</span></td>
  843. <td><span class="parametername">rune</span></td>
  844. <td></td>
  845. </tr>
  846. </tbody>
  847. </table>
  848. <h5 class="returns">Returns</h5>
  849. <table class="table table-bordered table-striped table-condensed">
  850. <thead>
  851. <tr>
  852. <th>Type</th>
  853. <th>Description</th>
  854. </tr>
  855. </thead>
  856. <tbody>
  857. <tr>
  858. <td><span class="xref">System.Boolean</span></td>
  859. <td></td>
  860. </tr>
  861. </tbody>
  862. </table>
  863. <span class="small pull-right mobile-hide">
  864. <span class="divider">|</span>
  865. <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/apidoc/new?filename=Terminal_Gui_Autocomplete_MouseEvent_Terminal_Gui_MouseEvent_System_Boolean_.md&amp;value=---%0Auid%3A%20Terminal.Gui.Autocomplete.MouseEvent(Terminal.Gui.MouseEvent%2CSystem.Boolean)%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>
  866. </span>
  867. <span class="small pull-right mobile-hide">
  868. <a href="tig:tig/gui.cs/blob/main/Terminal.Gui/Core/Autocomplete/Autocomplete.cs/#L368">View Source</a>
  869. </span>
  870. <a id="Terminal_Gui_Autocomplete_MouseEvent_" data-uid="Terminal.Gui.Autocomplete.MouseEvent*"></a>
  871. <h4 id="Terminal_Gui_Autocomplete_MouseEvent_Terminal_Gui_MouseEvent_System_Boolean_" data-uid="Terminal.Gui.Autocomplete.MouseEvent(Terminal.Gui.MouseEvent,System.Boolean)">MouseEvent(MouseEvent, Boolean)</h4>
  872. <div class="markdown level1 summary">
  873. Handle mouse events before <a class="xref" href="Terminal.Gui.Autocomplete.html#Terminal_Gui_Autocomplete_HostControl">HostControl</a> e.g. to make mouse events like
  874. report/click apply to the autocomplete control instead of changing the cursor position in
  875. the underlying text view.
  876. </div>
  877. <div class="markdown level1 conceptual"></div>
  878. <h5 class="decalaration">Declaration</h5>
  879. <div class="codewrapper">
  880. <pre><code class="lang-csharp hljs">public virtual bool MouseEvent(MouseEvent me, bool fromHost = false)</code></pre>
  881. </div>
  882. <h5 class="parameters">Parameters</h5>
  883. <table class="table table-bordered table-striped table-condensed">
  884. <thead>
  885. <tr>
  886. <th>Type</th>
  887. <th>Name</th>
  888. <th>Description</th>
  889. </tr>
  890. </thead>
  891. <tbody>
  892. <tr>
  893. <td><a class="xref" href="Terminal.Gui.MouseEvent.html">MouseEvent</a></td>
  894. <td><span class="parametername">me</span></td>
  895. <td>The mouse event.</td>
  896. </tr>
  897. <tr>
  898. <td><span class="xref">System.Boolean</span></td>
  899. <td><span class="parametername">fromHost</span></td>
  900. <td>If was called from the popup or from the host.</td>
  901. </tr>
  902. </tbody>
  903. </table>
  904. <h5 class="returns">Returns</h5>
  905. <table class="table table-bordered table-striped table-condensed">
  906. <thead>
  907. <tr>
  908. <th>Type</th>
  909. <th>Description</th>
  910. </tr>
  911. </thead>
  912. <tbody>
  913. <tr>
  914. <td><span class="xref">System.Boolean</span></td>
  915. <td><code>true</code>if the mouse can be handled <code>false</code>otherwise.</td>
  916. </tr>
  917. </tbody>
  918. </table>
  919. <span class="small pull-right mobile-hide">
  920. <span class="divider">|</span>
  921. <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/apidoc/new?filename=Terminal_Gui_Autocomplete_MoveDown.md&amp;value=---%0Auid%3A%20Terminal.Gui.Autocomplete.MoveDown%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>
  922. </span>
  923. <span class="small pull-right mobile-hide">
  924. <a href="tig:tig/gui.cs/blob/main/Terminal.Gui/Core/Autocomplete/Autocomplete.cs/#L616">View Source</a>
  925. </span>
  926. <a id="Terminal_Gui_Autocomplete_MoveDown_" data-uid="Terminal.Gui.Autocomplete.MoveDown*"></a>
  927. <h4 id="Terminal_Gui_Autocomplete_MoveDown" data-uid="Terminal.Gui.Autocomplete.MoveDown">MoveDown()</h4>
  928. <div class="markdown level1 summary">
  929. Moves the selection in the Autocomplete context menu down one
  930. </div>
  931. <div class="markdown level1 conceptual"></div>
  932. <h5 class="decalaration">Declaration</h5>
  933. <div class="codewrapper">
  934. <pre><code class="lang-csharp hljs">protected void MoveDown()</code></pre>
  935. </div>
  936. <span class="small pull-right mobile-hide">
  937. <span class="divider">|</span>
  938. <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/apidoc/new?filename=Terminal_Gui_Autocomplete_MoveUp.md&amp;value=---%0Auid%3A%20Terminal.Gui.Autocomplete.MoveUp%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>
  939. </span>
  940. <span class="small pull-right mobile-hide">
  941. <a href="tig:tig/gui.cs/blob/main/Terminal.Gui/Core/Autocomplete/Autocomplete.cs/#L603">View Source</a>
  942. </span>
  943. <a id="Terminal_Gui_Autocomplete_MoveUp_" data-uid="Terminal.Gui.Autocomplete.MoveUp*"></a>
  944. <h4 id="Terminal_Gui_Autocomplete_MoveUp" data-uid="Terminal.Gui.Autocomplete.MoveUp">MoveUp()</h4>
  945. <div class="markdown level1 summary">
  946. Moves the selection in the Autocomplete context menu up one
  947. </div>
  948. <div class="markdown level1 conceptual"></div>
  949. <h5 class="decalaration">Declaration</h5>
  950. <div class="codewrapper">
  951. <pre><code class="lang-csharp hljs">protected void MoveUp()</code></pre>
  952. </div>
  953. <span class="small pull-right mobile-hide">
  954. <span class="divider">|</span>
  955. <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/apidoc/new?filename=Terminal_Gui_Autocomplete_ProcessKey_Terminal_Gui_KeyEvent_.md&amp;value=---%0Auid%3A%20Terminal.Gui.Autocomplete.ProcessKey(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>
  956. </span>
  957. <span class="small pull-right mobile-hide">
  958. <a href="tig:tig/gui.cs/blob/main/Terminal.Gui/Core/Autocomplete/Autocomplete.cs/#L322">View Source</a>
  959. </span>
  960. <a id="Terminal_Gui_Autocomplete_ProcessKey_" data-uid="Terminal.Gui.Autocomplete.ProcessKey*"></a>
  961. <h4 id="Terminal_Gui_Autocomplete_ProcessKey_Terminal_Gui_KeyEvent_" data-uid="Terminal.Gui.Autocomplete.ProcessKey(Terminal.Gui.KeyEvent)">ProcessKey(KeyEvent)</h4>
  962. <div class="markdown level1 summary">
  963. Handle key events before <a class="xref" href="Terminal.Gui.Autocomplete.html#Terminal_Gui_Autocomplete_HostControl">HostControl</a> e.g. to make key events like
  964. up/down apply to the autocomplete control instead of changing the cursor position in
  965. the underlying text view.
  966. </div>
  967. <div class="markdown level1 conceptual"></div>
  968. <h5 class="decalaration">Declaration</h5>
  969. <div class="codewrapper">
  970. <pre><code class="lang-csharp hljs">public virtual bool ProcessKey(KeyEvent kb)</code></pre>
  971. </div>
  972. <h5 class="parameters">Parameters</h5>
  973. <table class="table table-bordered table-striped table-condensed">
  974. <thead>
  975. <tr>
  976. <th>Type</th>
  977. <th>Name</th>
  978. <th>Description</th>
  979. </tr>
  980. </thead>
  981. <tbody>
  982. <tr>
  983. <td><a class="xref" href="Terminal.Gui.KeyEvent.html">KeyEvent</a></td>
  984. <td><span class="parametername">kb</span></td>
  985. <td>The key event.</td>
  986. </tr>
  987. </tbody>
  988. </table>
  989. <h5 class="returns">Returns</h5>
  990. <table class="table table-bordered table-striped table-condensed">
  991. <thead>
  992. <tr>
  993. <th>Type</th>
  994. <th>Description</th>
  995. </tr>
  996. </thead>
  997. <tbody>
  998. <tr>
  999. <td><span class="xref">System.Boolean</span></td>
  1000. <td><code>true</code>if the key can be handled <code>false</code>otherwise.</td>
  1001. </tr>
  1002. </tbody>
  1003. </table>
  1004. <span class="small pull-right mobile-hide">
  1005. <span class="divider">|</span>
  1006. <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/apidoc/new?filename=Terminal_Gui_Autocomplete_RenderOverlay_Terminal_Gui_Point_.md&amp;value=---%0Auid%3A%20Terminal.Gui.Autocomplete.RenderOverlay(Terminal.Gui.Point)%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>
  1007. </span>
  1008. <span class="small pull-right mobile-hide">
  1009. <a href="tig:tig/gui.cs/blob/main/Terminal.Gui/Core/Autocomplete/Autocomplete.cs/#L195">View Source</a>
  1010. </span>
  1011. <a id="Terminal_Gui_Autocomplete_RenderOverlay_" data-uid="Terminal.Gui.Autocomplete.RenderOverlay*"></a>
  1012. <h4 id="Terminal_Gui_Autocomplete_RenderOverlay_Terminal_Gui_Point_" data-uid="Terminal.Gui.Autocomplete.RenderOverlay(Terminal.Gui.Point)">RenderOverlay(Point)</h4>
  1013. <div class="markdown level1 summary">
  1014. Renders the autocomplete dialog inside or outside the given <a class="xref" href="Terminal.Gui.Autocomplete.html#Terminal_Gui_Autocomplete_HostControl">HostControl</a> at the
  1015. given point.
  1016. </div>
  1017. <div class="markdown level1 conceptual"></div>
  1018. <h5 class="decalaration">Declaration</h5>
  1019. <div class="codewrapper">
  1020. <pre><code class="lang-csharp hljs">public virtual void RenderOverlay(Point renderAt)</code></pre>
  1021. </div>
  1022. <h5 class="parameters">Parameters</h5>
  1023. <table class="table table-bordered table-striped table-condensed">
  1024. <thead>
  1025. <tr>
  1026. <th>Type</th>
  1027. <th>Name</th>
  1028. <th>Description</th>
  1029. </tr>
  1030. </thead>
  1031. <tbody>
  1032. <tr>
  1033. <td><a class="xref" href="Terminal.Gui.Point.html">Point</a></td>
  1034. <td><span class="parametername">renderAt</span></td>
  1035. <td></td>
  1036. </tr>
  1037. </tbody>
  1038. </table>
  1039. <span class="small pull-right mobile-hide">
  1040. <span class="divider">|</span>
  1041. <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/apidoc/new?filename=Terminal_Gui_Autocomplete_RenderSelectedIdxByMouse_Terminal_Gui_MouseEvent_.md&amp;value=---%0Auid%3A%20Terminal.Gui.Autocomplete.RenderSelectedIdxByMouse(Terminal.Gui.MouseEvent)%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>
  1042. </span>
  1043. <span class="small pull-right mobile-hide">
  1044. <a href="tig:tig/gui.cs/blob/main/Terminal.Gui/Core/Autocomplete/Autocomplete.cs/#L424">View Source</a>
  1045. </span>
  1046. <a id="Terminal_Gui_Autocomplete_RenderSelectedIdxByMouse_" data-uid="Terminal.Gui.Autocomplete.RenderSelectedIdxByMouse*"></a>
  1047. <h4 id="Terminal_Gui_Autocomplete_RenderSelectedIdxByMouse_Terminal_Gui_MouseEvent_" data-uid="Terminal.Gui.Autocomplete.RenderSelectedIdxByMouse(Terminal.Gui.MouseEvent)">RenderSelectedIdxByMouse(MouseEvent)</h4>
  1048. <div class="markdown level1 summary">
  1049. Render the current selection in the Autocomplete context menu by the mouse reporting.
  1050. </div>
  1051. <div class="markdown level1 conceptual"></div>
  1052. <h5 class="decalaration">Declaration</h5>
  1053. <div class="codewrapper">
  1054. <pre><code class="lang-csharp hljs">protected void RenderSelectedIdxByMouse(MouseEvent me)</code></pre>
  1055. </div>
  1056. <h5 class="parameters">Parameters</h5>
  1057. <table class="table table-bordered table-striped table-condensed">
  1058. <thead>
  1059. <tr>
  1060. <th>Type</th>
  1061. <th>Name</th>
  1062. <th>Description</th>
  1063. </tr>
  1064. </thead>
  1065. <tbody>
  1066. <tr>
  1067. <td><a class="xref" href="Terminal.Gui.MouseEvent.html">MouseEvent</a></td>
  1068. <td><span class="parametername">me</span></td>
  1069. <td></td>
  1070. </tr>
  1071. </tbody>
  1072. </table>
  1073. <span class="small pull-right mobile-hide">
  1074. <span class="divider">|</span>
  1075. <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/apidoc/new?filename=Terminal_Gui_Autocomplete_ReopenSuggestions.md&amp;value=---%0Auid%3A%20Terminal.Gui.Autocomplete.ReopenSuggestions%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>
  1076. </span>
  1077. <span class="small pull-right mobile-hide">
  1078. <a href="tig:tig/gui.cs/blob/main/Terminal.Gui/Core/Autocomplete/Autocomplete.cs/#L630">View Source</a>
  1079. </span>
  1080. <a id="Terminal_Gui_Autocomplete_ReopenSuggestions_" data-uid="Terminal.Gui.Autocomplete.ReopenSuggestions*"></a>
  1081. <h4 id="Terminal_Gui_Autocomplete_ReopenSuggestions" data-uid="Terminal.Gui.Autocomplete.ReopenSuggestions">ReopenSuggestions()</h4>
  1082. <div class="markdown level1 summary">
  1083. Reopen the popup after it has been closed.
  1084. </div>
  1085. <div class="markdown level1 conceptual"></div>
  1086. <h5 class="decalaration">Declaration</h5>
  1087. <div class="codewrapper">
  1088. <pre><code class="lang-csharp hljs">protected bool ReopenSuggestions()</code></pre>
  1089. </div>
  1090. <h5 class="returns">Returns</h5>
  1091. <table class="table table-bordered table-striped table-condensed">
  1092. <thead>
  1093. <tr>
  1094. <th>Type</th>
  1095. <th>Description</th>
  1096. </tr>
  1097. </thead>
  1098. <tbody>
  1099. <tr>
  1100. <td><span class="xref">System.Boolean</span></td>
  1101. <td></td>
  1102. </tr>
  1103. </tbody>
  1104. </table>
  1105. <span class="small pull-right mobile-hide">
  1106. <span class="divider">|</span>
  1107. <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/apidoc/new?filename=Terminal_Gui_Autocomplete_Select.md&amp;value=---%0Auid%3A%20Terminal.Gui.Autocomplete.Select%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>
  1108. </span>
  1109. <span class="small pull-right mobile-hide">
  1110. <a href="tig:tig/gui.cs/blob/main/Terminal.Gui/Core/Autocomplete/Autocomplete.cs/#L485">View Source</a>
  1111. </span>
  1112. <a id="Terminal_Gui_Autocomplete_Select_" data-uid="Terminal.Gui.Autocomplete.Select*"></a>
  1113. <h4 id="Terminal_Gui_Autocomplete_Select" data-uid="Terminal.Gui.Autocomplete.Select">Select()</h4>
  1114. <div class="markdown level1 summary">
  1115. Completes the autocomplete selection process. Called when user hits the <a class="xref" href="Terminal.Gui.Autocomplete.html#Terminal_Gui_Autocomplete_SelectionKey">SelectionKey</a>.
  1116. </div>
  1117. <div class="markdown level1 conceptual"></div>
  1118. <h5 class="decalaration">Declaration</h5>
  1119. <div class="codewrapper">
  1120. <pre><code class="lang-csharp hljs">protected bool Select()</code></pre>
  1121. </div>
  1122. <h5 class="returns">Returns</h5>
  1123. <table class="table table-bordered table-striped table-condensed">
  1124. <thead>
  1125. <tr>
  1126. <th>Type</th>
  1127. <th>Description</th>
  1128. </tr>
  1129. </thead>
  1130. <tbody>
  1131. <tr>
  1132. <td><span class="xref">System.Boolean</span></td>
  1133. <td></td>
  1134. </tr>
  1135. </tbody>
  1136. </table>
  1137. <h3 id="implements">Implements</h3>
  1138. <div>
  1139. <a class="xref" href="Terminal.Gui.IAutocomplete.html">IAutocomplete</a>
  1140. </div>
  1141. </article>
  1142. </div>
  1143. <div class="hidden-sm col-md-2" role="complementary">
  1144. <div class="sideaffix">
  1145. <div class="contribution">
  1146. <ul class="nav">
  1147. <li>
  1148. <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/apidoc/new?filename=Terminal_Gui_Autocomplete.md&amp;value=---%0Auid%3A%20Terminal.Gui.Autocomplete%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>
  1149. </li>
  1150. <li>
  1151. <a href="tig:tig/gui.cs/blob/main/Terminal.Gui/Core/Autocomplete/Autocomplete.cs/#L14" class="contribution-link">View Source</a>
  1152. </li>
  1153. </ul>
  1154. </div>
  1155. <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
  1156. <h5>In This Article</h5>
  1157. <div></div>
  1158. </nav>
  1159. </div>
  1160. </div>
  1161. </div>
  1162. </div>
  1163. <footer>
  1164. <div class="grad-bottom"></div>
  1165. <div class="footer">
  1166. <div class="container">
  1167. <span class="pull-right">
  1168. <a href="#top">Back to top</a>
  1169. </span>
  1170. <span>Generated by <strong>DocFX</strong></span>
  1171. </div>
  1172. </div>
  1173. </footer>
  1174. </div>
  1175. <script type="text/javascript" src="../../styles/docfx.vendor.js"></script>
  1176. <script type="text/javascript" src="../../styles/docfx.js"></script>
  1177. <script type="text/javascript" src="../../styles/main.js"></script>
  1178. </body>
  1179. </html>