Terminal.Gui.TextFieldAutocomplete.html 14 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315
  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 TextFieldAutocomplete
  8. </title>
  9. <meta name="viewport" content="width=device-width">
  10. <meta name="title" content="Class TextFieldAutocomplete
  11. ">
  12. <meta name="generator" content="docfx 2.59.3.0">
  13. <link rel="shortcut icon" href="../../favicon.ico">
  14. <link rel="stylesheet" href="../../styles/docfx.vendor.css">
  15. <link rel="stylesheet" href="../../styles/docfx.css">
  16. <link rel="stylesheet" href="../../styles/main.css">
  17. <link href="https://fonts.googleapis.com/css?family=Source Sans Pro" rel="stylesheet">
  18. <link href="https://fonts.googleapis.com/css?family=Source Code Pro" rel="stylesheet">
  19. <meta property="docfx:navrel" content="../../toc.html">
  20. <meta property="docfx:tocrel" content="toc.html">
  21. <meta property="docfx:rel" content="../../">
  22. </head> <body data-spy="scroll" data-target="#affix" data-offset="120">
  23. <div id="wrapper">
  24. <header>
  25. <nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation">
  26. <div class="container">
  27. <div class="navbar-header">
  28. <button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
  29. <span class="sr-only">Toggle navigation</span>
  30. <span class="icon-bar"></span>
  31. <span class="icon-bar"></span>
  32. <span class="icon-bar"></span>
  33. </button>
  34. <a class="navbar-brand" href="../../index.html">
  35. <img id="logo" class="svg" src="../../images/logo48.png" alt="">
  36. </a>
  37. </div>
  38. <div class="collapse navbar-collapse" id="navbar">
  39. <form class="navbar-form navbar-right" role="search" id="search">
  40. <div class="form-group">
  41. <input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">
  42. </div>
  43. </form>
  44. </div>
  45. </div>
  46. </nav>
  47. <div class="subnav navbar navbar-default">
  48. <div class="container hide-when-search" id="breadcrumb">
  49. <ul class="breadcrumb">
  50. <li></li>
  51. </ul>
  52. </div>
  53. </div>
  54. </header>
  55. <div class="container body-content">
  56. <div id="search-results">
  57. <div class="search-list">Search Results for <span></span></div>
  58. <div class="sr-items">
  59. <p><i class="glyphicon glyphicon-refresh index-loading"></i></p>
  60. </div>
  61. <ul id="pagination" data-first="First" data-prev="Previous" data-next="Next" data-last="Last"></ul>
  62. </div>
  63. </div>
  64. <div role="main" class="container body-content hide-when-search">
  65. <div class="sidenav hide-when-search">
  66. <a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
  67. <div class="sidetoggle collapse" id="sidetoggle">
  68. <div id="sidetoc"></div>
  69. </div>
  70. </div>
  71. <div class="article row grid-right">
  72. <div class="col-md-10">
  73. <article class="content wrap" id="_content" data-uid="Terminal.Gui.TextFieldAutocomplete">
  74. <h1 id="Terminal_Gui_TextFieldAutocomplete" data-uid="Terminal.Gui.TextFieldAutocomplete" class="text-break">Class TextFieldAutocomplete
  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. An implementation on a TextField.
  80. </div>
  81. <div class="markdown level0 conceptual"></div>
  82. <div class="inheritance">
  83. <h5>Inheritance</h5>
  84. <div class="level0"><span class="xref">System.Object</span></div>
  85. <div class="level1"><a class="xref" href="Terminal.Gui.Autocomplete.html">Autocomplete</a></div>
  86. <div class="level2"><span class="xref">TextFieldAutocomplete</span></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. <a class="xref" href="Terminal.Gui.Autocomplete.html#Terminal_Gui_Autocomplete_RenderOverlay_Terminal_Gui_Point_">Autocomplete.RenderOverlay(Point)</a>
  96. </div>
  97. <div>
  98. <a class="xref" href="Terminal.Gui.Autocomplete.html#Terminal_Gui_Autocomplete_EnsureSelectedIdxIsValid">Autocomplete.EnsureSelectedIdxIsValid()</a>
  99. </div>
  100. <div>
  101. <a class="xref" href="Terminal.Gui.Autocomplete.html#Terminal_Gui_Autocomplete_ProcessKey_Terminal_Gui_KeyEvent_">Autocomplete.ProcessKey(KeyEvent)</a>
  102. </div>
  103. <div>
  104. <a class="xref" href="Terminal.Gui.Autocomplete.html#Terminal_Gui_Autocomplete_MouseEvent_Terminal_Gui_MouseEvent_System_Boolean_">Autocomplete.MouseEvent(MouseEvent, Boolean)</a>
  105. </div>
  106. <div>
  107. <a class="xref" href="Terminal.Gui.Autocomplete.html#Terminal_Gui_Autocomplete_RenderSelectedIdxByMouse_Terminal_Gui_MouseEvent_">Autocomplete.RenderSelectedIdxByMouse(MouseEvent)</a>
  108. </div>
  109. <div>
  110. <a class="xref" href="Terminal.Gui.Autocomplete.html#Terminal_Gui_Autocomplete_ClearSuggestions">Autocomplete.ClearSuggestions()</a>
  111. </div>
  112. <div>
  113. <a class="xref" href="Terminal.Gui.Autocomplete.html#Terminal_Gui_Autocomplete_GenerateSuggestions">Autocomplete.GenerateSuggestions()</a>
  114. </div>
  115. <div>
  116. <a class="xref" href="Terminal.Gui.Autocomplete.html#Terminal_Gui_Autocomplete_IsWordChar_System_Rune_">Autocomplete.IsWordChar(Rune)</a>
  117. </div>
  118. <div>
  119. <a class="xref" href="Terminal.Gui.Autocomplete.html#Terminal_Gui_Autocomplete_Select">Autocomplete.Select()</a>
  120. </div>
  121. <div>
  122. <a class="xref" href="Terminal.Gui.Autocomplete.html#Terminal_Gui_Autocomplete_InsertSelection_System_String_">Autocomplete.InsertSelection(String)</a>
  123. </div>
  124. <div>
  125. <a class="xref" href="Terminal.Gui.Autocomplete.html#Terminal_Gui_Autocomplete_IdxToWord_System_Collections_Generic_List_System_Rune__System_Int32_">Autocomplete.IdxToWord(List&lt;Rune&gt;, Int32)</a>
  126. </div>
  127. <div>
  128. <a class="xref" href="Terminal.Gui.Autocomplete.html#Terminal_Gui_Autocomplete_Close">Autocomplete.Close()</a>
  129. </div>
  130. <div>
  131. <a class="xref" href="Terminal.Gui.Autocomplete.html#Terminal_Gui_Autocomplete_MoveUp">Autocomplete.MoveUp()</a>
  132. </div>
  133. <div>
  134. <a class="xref" href="Terminal.Gui.Autocomplete.html#Terminal_Gui_Autocomplete_MoveDown">Autocomplete.MoveDown()</a>
  135. </div>
  136. <div>
  137. <a class="xref" href="Terminal.Gui.Autocomplete.html#Terminal_Gui_Autocomplete_ReopenSuggestions">Autocomplete.ReopenSuggestions()</a>
  138. </div>
  139. <div>
  140. <a class="xref" href="Terminal.Gui.Autocomplete.html#Terminal_Gui_Autocomplete_HostControl">Autocomplete.HostControl</a>
  141. </div>
  142. <div>
  143. <a class="xref" href="Terminal.Gui.Autocomplete.html#Terminal_Gui_Autocomplete_PopupInsideContainer">Autocomplete.PopupInsideContainer</a>
  144. </div>
  145. <div>
  146. <a class="xref" href="Terminal.Gui.Autocomplete.html#Terminal_Gui_Autocomplete_MaxWidth">Autocomplete.MaxWidth</a>
  147. </div>
  148. <div>
  149. <a class="xref" href="Terminal.Gui.Autocomplete.html#Terminal_Gui_Autocomplete_MaxHeight">Autocomplete.MaxHeight</a>
  150. </div>
  151. <div>
  152. <a class="xref" href="Terminal.Gui.Autocomplete.html#Terminal_Gui_Autocomplete_Visible">Autocomplete.Visible</a>
  153. </div>
  154. <div>
  155. <a class="xref" href="Terminal.Gui.Autocomplete.html#Terminal_Gui_Autocomplete_Suggestions">Autocomplete.Suggestions</a>
  156. </div>
  157. <div>
  158. <a class="xref" href="Terminal.Gui.Autocomplete.html#Terminal_Gui_Autocomplete_AllSuggestions">Autocomplete.AllSuggestions</a>
  159. </div>
  160. <div>
  161. <a class="xref" href="Terminal.Gui.Autocomplete.html#Terminal_Gui_Autocomplete_SelectedIdx">Autocomplete.SelectedIdx</a>
  162. </div>
  163. <div>
  164. <a class="xref" href="Terminal.Gui.Autocomplete.html#Terminal_Gui_Autocomplete_ScrollOffset">Autocomplete.ScrollOffset</a>
  165. </div>
  166. <div>
  167. <a class="xref" href="Terminal.Gui.Autocomplete.html#Terminal_Gui_Autocomplete_ColorScheme">Autocomplete.ColorScheme</a>
  168. </div>
  169. <div>
  170. <a class="xref" href="Terminal.Gui.Autocomplete.html#Terminal_Gui_Autocomplete_SelectionKey">Autocomplete.SelectionKey</a>
  171. </div>
  172. <div>
  173. <a class="xref" href="Terminal.Gui.Autocomplete.html#Terminal_Gui_Autocomplete_CloseKey">Autocomplete.CloseKey</a>
  174. </div>
  175. <div>
  176. <a class="xref" href="Terminal.Gui.Autocomplete.html#Terminal_Gui_Autocomplete_Reopen">Autocomplete.Reopen</a>
  177. </div>
  178. </div>
  179. <h6><strong>Namespace</strong>: <a class="xref" href="Terminal.Gui.html">Terminal.Gui</a></h6>
  180. <h6><strong>Assembly</strong>: Terminal.Gui.dll</h6>
  181. <h5 id="Terminal_Gui_TextFieldAutocomplete_syntax">Syntax</h5>
  182. <div class="codewrapper">
  183. <pre><code class="lang-csharp hljs">public class TextFieldAutocomplete : Autocomplete, IAutocomplete</code></pre>
  184. </div>
  185. <h3 id="constructors">Constructors
  186. </h3>
  187. <a id="Terminal_Gui_TextFieldAutocomplete__ctor_" data-uid="Terminal.Gui.TextFieldAutocomplete.#ctor*"></a>
  188. <h4 id="Terminal_Gui_TextFieldAutocomplete__ctor" data-uid="Terminal.Gui.TextFieldAutocomplete.#ctor">TextFieldAutocomplete()</h4>
  189. <div class="markdown level1 summary"></div>
  190. <div class="markdown level1 conceptual"></div>
  191. <h5 class="decalaration">Declaration</h5>
  192. <div class="codewrapper">
  193. <pre><code class="lang-csharp hljs">public TextFieldAutocomplete()</code></pre>
  194. </div>
  195. <h3 id="methods">Methods
  196. </h3>
  197. <a id="Terminal_Gui_TextFieldAutocomplete_DeleteTextBackwards_" data-uid="Terminal.Gui.TextFieldAutocomplete.DeleteTextBackwards*"></a>
  198. <h4 id="Terminal_Gui_TextFieldAutocomplete_DeleteTextBackwards" data-uid="Terminal.Gui.TextFieldAutocomplete.DeleteTextBackwards">DeleteTextBackwards()</h4>
  199. <div class="markdown level1 summary">
  200. 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>.
  201. </div>
  202. <div class="markdown level1 conceptual"></div>
  203. <h5 class="decalaration">Declaration</h5>
  204. <div class="codewrapper">
  205. <pre><code class="lang-csharp hljs">protected override void DeleteTextBackwards()</code></pre>
  206. </div>
  207. <h5 class="overrides">Overrides</h5>
  208. <div><a class="xref" href="Terminal.Gui.Autocomplete.html#Terminal_Gui_Autocomplete_DeleteTextBackwards">Autocomplete.DeleteTextBackwards()</a></div>
  209. <a id="Terminal_Gui_TextFieldAutocomplete_GetCurrentWord_" data-uid="Terminal.Gui.TextFieldAutocomplete.GetCurrentWord*"></a>
  210. <h4 id="Terminal_Gui_TextFieldAutocomplete_GetCurrentWord" data-uid="Terminal.Gui.TextFieldAutocomplete.GetCurrentWord">GetCurrentWord()</h4>
  211. <div class="markdown level1 summary">
  212. Returns the currently selected word from the <a class="xref" href="Terminal.Gui.Autocomplete.html#Terminal_Gui_Autocomplete_HostControl">HostControl</a>.
  213. <p>
  214. 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>
  215. </p>
  216. </div>
  217. <div class="markdown level1 conceptual"></div>
  218. <h5 class="decalaration">Declaration</h5>
  219. <div class="codewrapper">
  220. <pre><code class="lang-csharp hljs">protected override string GetCurrentWord()</code></pre>
  221. </div>
  222. <h5 class="returns">Returns</h5>
  223. <table class="table table-bordered table-striped table-condensed">
  224. <thead>
  225. <tr>
  226. <th>Type</th>
  227. <th>Description</th>
  228. </tr>
  229. </thead>
  230. <tbody>
  231. <tr>
  232. <td><span class="xref">System.String</span></td>
  233. <td></td>
  234. </tr>
  235. </tbody>
  236. </table>
  237. <h5 class="overrides">Overrides</h5>
  238. <div><a class="xref" href="Terminal.Gui.Autocomplete.html#Terminal_Gui_Autocomplete_GetCurrentWord">Autocomplete.GetCurrentWord()</a></div>
  239. <a id="Terminal_Gui_TextFieldAutocomplete_InsertText_" data-uid="Terminal.Gui.TextFieldAutocomplete.InsertText*"></a>
  240. <h4 id="Terminal_Gui_TextFieldAutocomplete_InsertText_System_String_" data-uid="Terminal.Gui.TextFieldAutocomplete.InsertText(System.String)">InsertText(String)</h4>
  241. <div class="markdown level1 summary">
  242. Inser the selected text in the <a class="xref" href="Terminal.Gui.Autocomplete.html#Terminal_Gui_Autocomplete_HostControl">HostControl</a>.
  243. </div>
  244. <div class="markdown level1 conceptual"></div>
  245. <h5 class="decalaration">Declaration</h5>
  246. <div class="codewrapper">
  247. <pre><code class="lang-csharp hljs">protected override void InsertText(string accepted)</code></pre>
  248. </div>
  249. <h5 class="parameters">Parameters</h5>
  250. <table class="table table-bordered table-striped table-condensed">
  251. <thead>
  252. <tr>
  253. <th>Type</th>
  254. <th>Name</th>
  255. <th>Description</th>
  256. </tr>
  257. </thead>
  258. <tbody>
  259. <tr>
  260. <td><span class="xref">System.String</span></td>
  261. <td><span class="parametername">accepted</span></td>
  262. <td></td>
  263. </tr>
  264. </tbody>
  265. </table>
  266. <h5 class="overrides">Overrides</h5>
  267. <div><a class="xref" href="Terminal.Gui.Autocomplete.html#Terminal_Gui_Autocomplete_InsertText_System_String_">Autocomplete.InsertText(String)</a></div>
  268. <h3 id="implements">Implements</h3>
  269. <div>
  270. <a class="xref" href="Terminal.Gui.IAutocomplete.html">IAutocomplete</a>
  271. </div>
  272. </article>
  273. </div>
  274. <div class="hidden-sm col-md-2" role="complementary">
  275. <div class="sideaffix">
  276. <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
  277. <h5>In This Article</h5>
  278. <div></div>
  279. </nav>
  280. </div>
  281. </div>
  282. </div>
  283. </div>
  284. <footer>
  285. <div class="grad-bottom"></div>
  286. <div class="footer">
  287. <div class="container">
  288. <span class="pull-right">
  289. <a href="#top">Back to top</a>
  290. </span>
  291. <span>Generated by <strong>DocFX</strong></span>
  292. </div>
  293. </div>
  294. </footer>
  295. </div>
  296. <script type="text/javascript" src="../../styles/docfx.vendor.js"></script>
  297. <script type="text/javascript" src="../../styles/docfx.js"></script>
  298. <script type="text/javascript" src="../../styles/main.js"></script>
  299. </body>
  300. </html>