Terminal.Gui.Autocomplete.html 63 KB

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