Terminal.Gui.CollectionNavigator.html 28 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516
  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 CollectionNavigator
  8. </title>
  9. <meta name="viewport" content="width=device-width">
  10. <meta name="title" content="Class CollectionNavigator
  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.CollectionNavigator">
  72. <h1 id="Terminal_Gui_CollectionNavigator" data-uid="Terminal.Gui.CollectionNavigator" class="text-break">Class CollectionNavigator
  73. </h1>
  74. <div class="markdown level0 summary">Navigates a collection of items using keystrokes. The keystrokes are used to build a search string.
  75. The <a class="xref" href="Terminal.Gui.CollectionNavigator.html#Terminal_Gui_CollectionNavigator_SearchString">SearchString</a> is used to find the next item in the collection that matches the search string
  76. when <a class="xref" href="Terminal.Gui.CollectionNavigator.html#Terminal_Gui_CollectionNavigator_GetNextMatchingItem_System_Int32_System_Char_">GetNextMatchingItem(int, char)</a> is called.
  77. <p>
  78. If the user types keystrokes that can't be found in the collection,
  79. the search string is cleared and the next item is found that starts with the last keystroke.
  80. </p>
  81. <p>
  82. If the user pauses keystrokes for a short time (see <a class="xref" href="Terminal.Gui.CollectionNavigator.html#Terminal_Gui_CollectionNavigator_TypingDelay">TypingDelay</a>), the search string is cleared.
  83. </p></div>
  84. <div class="markdown level0 conceptual"></div>
  85. <div class="inheritance">
  86. <h5>Inheritance</h5>
  87. <div class="level0"><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a></div>
  88. <div class="level1"><span class="xref">CollectionNavigator</span></div>
  89. </div>
  90. <div class="inheritedMembers">
  91. <h5>Inherited Members</h5>
  92. <div>
  93. <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)">object.Equals(object)</a>
  94. </div>
  95. <div>
  96. <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>
  97. </div>
  98. <div>
  99. <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.gethashcode">object.GetHashCode()</a>
  100. </div>
  101. <div>
  102. <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.gettype">object.GetType()</a>
  103. </div>
  104. <div>
  105. <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone">object.MemberwiseClone()</a>
  106. </div>
  107. <div>
  108. <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.referenceequals">object.ReferenceEquals(object, object)</a>
  109. </div>
  110. <div>
  111. <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.tostring">object.ToString()</a>
  112. </div>
  113. </div>
  114. <h6><strong>Namespace</strong>: <a class="xref" href="Terminal.html">Terminal</a>.<a class="xref" href="Terminal.Gui.html">Gui</a></h6>
  115. <h6><strong>Assembly</strong>: Terminal.Gui.dll</h6>
  116. <h5 id="Terminal_Gui_CollectionNavigator_syntax">Syntax</h5>
  117. <div class="codewrapper">
  118. <pre><code class="lang-csharp hljs">public class CollectionNavigator</code></pre>
  119. </div>
  120. <h3 id="constructors">Constructors
  121. </h3>
  122. <span class="small pull-right mobile-hide">
  123. <span class="divider">|</span>
  124. <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/docfx/overrides/new?filename=Terminal_Gui_CollectionNavigator__ctor.md&amp;value=---%0Auid%3A%20Terminal.Gui.CollectionNavigator.%23ctor%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>
  125. </span>
  126. <span class="small pull-right mobile-hide">
  127. <a href="tig:tig/Terminal.Gui/blob/v2_develop/Terminal.Gui/Core/CollectionNavigator.cs/#L22">View Source</a>
  128. </span>
  129. <a id="Terminal_Gui_CollectionNavigator__ctor_" data-uid="Terminal.Gui.CollectionNavigator.#ctor*"></a>
  130. <h4 id="Terminal_Gui_CollectionNavigator__ctor" data-uid="Terminal.Gui.CollectionNavigator.#ctor">CollectionNavigator()</h4>
  131. <div class="markdown level1 summary">Constructs a new CollectionNavigator.</div>
  132. <div class="markdown level1 conceptual"></div>
  133. <h5 class="declaration">Declaration</h5>
  134. <div class="codewrapper">
  135. <pre><code class="lang-csharp hljs">public CollectionNavigator()</code></pre>
  136. </div>
  137. <span class="small pull-right mobile-hide">
  138. <span class="divider">|</span>
  139. <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/docfx/overrides/new?filename=Terminal_Gui_CollectionNavigator__ctor_System_Collections_Generic_IEnumerable_System_Object__.md&amp;value=---%0Auid%3A%20Terminal.Gui.CollectionNavigator.%23ctor(System.Collections.Generic.IEnumerable%7BSystem.Object%7D)%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>
  140. </span>
  141. <span class="small pull-right mobile-hide">
  142. <a href="tig:tig/Terminal.Gui/blob/v2_develop/Terminal.Gui/Core/CollectionNavigator.cs/#L28">View Source</a>
  143. </span>
  144. <a id="Terminal_Gui_CollectionNavigator__ctor_" data-uid="Terminal.Gui.CollectionNavigator.#ctor*"></a>
  145. <h4 id="Terminal_Gui_CollectionNavigator__ctor_System_Collections_Generic_IEnumerable_System_Object__" data-uid="Terminal.Gui.CollectionNavigator.#ctor(System.Collections.Generic.IEnumerable{System.Object})">CollectionNavigator(IEnumerable&lt;object&gt;)</h4>
  146. <div class="markdown level1 summary">Constructs a new CollectionNavigator for the given collection.</div>
  147. <div class="markdown level1 conceptual"></div>
  148. <h5 class="declaration">Declaration</h5>
  149. <div class="codewrapper">
  150. <pre><code class="lang-csharp hljs">public CollectionNavigator(IEnumerable&lt;object&gt; collection)</code></pre>
  151. </div>
  152. <h5 class="parameters">Parameters</h5>
  153. <table class="table table-bordered table-condensed">
  154. <thead>
  155. <tr>
  156. <th>Type</th>
  157. <th>Name</th>
  158. <th>Description</th>
  159. </tr>
  160. </thead>
  161. <tbody>
  162. <tr>
  163. <td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.ienumerable-1">IEnumerable</a>&lt;<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a>&gt;</td>
  164. <td><span class="parametername">collection</span></td>
  165. <td></td>
  166. </tr>
  167. </tbody>
  168. </table>
  169. <h3 id="properties">Properties
  170. </h3>
  171. <span class="small pull-right mobile-hide">
  172. <span class="divider">|</span>
  173. <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/docfx/overrides/new?filename=Terminal_Gui_CollectionNavigator_Collection.md&amp;value=---%0Auid%3A%20Terminal.Gui.CollectionNavigator.Collection%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>
  174. </span>
  175. <span class="small pull-right mobile-hide">
  176. <a href="tig:tig/Terminal.Gui/blob/v2_develop/Terminal.Gui/Core/CollectionNavigator.cs/#L45">View Source</a>
  177. </span>
  178. <a id="Terminal_Gui_CollectionNavigator_Collection_" data-uid="Terminal.Gui.CollectionNavigator.Collection*"></a>
  179. <h4 id="Terminal_Gui_CollectionNavigator_Collection" data-uid="Terminal.Gui.CollectionNavigator.Collection">Collection</h4>
  180. <div class="markdown level1 summary">The collection of objects to search. <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.tostring">ToString()</a> is used to search the collection.</div>
  181. <div class="markdown level1 conceptual"></div>
  182. <h5 class="declaration">Declaration</h5>
  183. <div class="codewrapper">
  184. <pre><code class="lang-csharp hljs">public IEnumerable&lt;object&gt; Collection { get; set; }</code></pre>
  185. </div>
  186. <h5 class="propertyValue">Property Value</h5>
  187. <table class="table table-bordered table-condensed">
  188. <thead>
  189. <tr>
  190. <th>Type</th>
  191. <th>Description</th>
  192. </tr>
  193. </thead>
  194. <tbody>
  195. <tr>
  196. <td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.ienumerable-1">IEnumerable</a>&lt;<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a>&gt;</td>
  197. <td></td>
  198. </tr>
  199. </tbody>
  200. </table>
  201. <span class="small pull-right mobile-hide">
  202. <span class="divider">|</span>
  203. <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/docfx/overrides/new?filename=Terminal_Gui_CollectionNavigator_Comparer.md&amp;value=---%0Auid%3A%20Terminal.Gui.CollectionNavigator.Comparer%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>
  204. </span>
  205. <span class="small pull-right mobile-hide">
  206. <a href="tig:tig/Terminal.Gui/blob/v2_develop/Terminal.Gui/Core/CollectionNavigator.cs/#L40">View Source</a>
  207. </span>
  208. <a id="Terminal_Gui_CollectionNavigator_Comparer_" data-uid="Terminal.Gui.CollectionNavigator.Comparer*"></a>
  209. <h4 id="Terminal_Gui_CollectionNavigator_Comparer" data-uid="Terminal.Gui.CollectionNavigator.Comparer">Comparer</h4>
  210. <div class="markdown level1 summary">The compararer function to use when searching the collection.</div>
  211. <div class="markdown level1 conceptual"></div>
  212. <h5 class="declaration">Declaration</h5>
  213. <div class="codewrapper">
  214. <pre><code class="lang-csharp hljs">public StringComparer Comparer { get; set; }</code></pre>
  215. </div>
  216. <h5 class="propertyValue">Property Value</h5>
  217. <table class="table table-bordered table-condensed">
  218. <thead>
  219. <tr>
  220. <th>Type</th>
  221. <th>Description</th>
  222. </tr>
  223. </thead>
  224. <tbody>
  225. <tr>
  226. <td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.stringcomparer">StringComparer</a></td>
  227. <td></td>
  228. </tr>
  229. </tbody>
  230. </table>
  231. <span class="small pull-right mobile-hide">
  232. <span class="divider">|</span>
  233. <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/docfx/overrides/new?filename=Terminal_Gui_CollectionNavigator_SearchString.md&amp;value=---%0Auid%3A%20Terminal.Gui.CollectionNavigator.SearchString%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>
  234. </span>
  235. <span class="small pull-right mobile-hide">
  236. <a href="tig:tig/Terminal.Gui/blob/v2_develop/Terminal.Gui/Core/CollectionNavigator.cs/#L76">View Source</a>
  237. </span>
  238. <a id="Terminal_Gui_CollectionNavigator_SearchString_" data-uid="Terminal.Gui.CollectionNavigator.SearchString*"></a>
  239. <h4 id="Terminal_Gui_CollectionNavigator_SearchString" data-uid="Terminal.Gui.CollectionNavigator.SearchString">SearchString</h4>
  240. <div class="markdown level1 summary">Gets the current search string. This includes the set of keystrokes that have been pressed
  241. since the last unsuccessful match or after <a class="xref" href="Terminal.Gui.CollectionNavigator.html#Terminal_Gui_CollectionNavigator_TypingDelay">TypingDelay</a>) milliseconds. Useful for debugging.</div>
  242. <div class="markdown level1 conceptual"></div>
  243. <h5 class="declaration">Declaration</h5>
  244. <div class="codewrapper">
  245. <pre><code class="lang-csharp hljs">public string SearchString { get; }</code></pre>
  246. </div>
  247. <h5 class="propertyValue">Property Value</h5>
  248. <table class="table table-bordered table-condensed">
  249. <thead>
  250. <tr>
  251. <th>Type</th>
  252. <th>Description</th>
  253. </tr>
  254. </thead>
  255. <tbody>
  256. <tr>
  257. <td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></td>
  258. <td></td>
  259. </tr>
  260. </tbody>
  261. </table>
  262. <span class="small pull-right mobile-hide">
  263. <span class="divider">|</span>
  264. <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/docfx/overrides/new?filename=Terminal_Gui_CollectionNavigator_TypingDelay.md&amp;value=---%0Auid%3A%20Terminal.Gui.CollectionNavigator.TypingDelay%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>
  265. </span>
  266. <span class="small pull-right mobile-hide">
  267. <a href="tig:tig/Terminal.Gui/blob/v2_develop/Terminal.Gui/Core/CollectionNavigator.cs/#L35">View Source</a>
  268. </span>
  269. <a id="Terminal_Gui_CollectionNavigator_TypingDelay_" data-uid="Terminal.Gui.CollectionNavigator.TypingDelay*"></a>
  270. <h4 id="Terminal_Gui_CollectionNavigator_TypingDelay" data-uid="Terminal.Gui.CollectionNavigator.TypingDelay">TypingDelay</h4>
  271. <div class="markdown level1 summary">Gets or sets the number of milliseconds to delay before clearing the search string. The delay is
  272. reset on each call to <a class="xref" href="Terminal.Gui.CollectionNavigator.html#Terminal_Gui_CollectionNavigator_GetNextMatchingItem_System_Int32_System_Char_">GetNextMatchingItem(int, char)</a>. The default is 500ms.</div>
  273. <div class="markdown level1 conceptual"></div>
  274. <h5 class="declaration">Declaration</h5>
  275. <div class="codewrapper">
  276. <pre><code class="lang-csharp hljs">public int TypingDelay { get; set; }</code></pre>
  277. </div>
  278. <h5 class="propertyValue">Property Value</h5>
  279. <table class="table table-bordered table-condensed">
  280. <thead>
  281. <tr>
  282. <th>Type</th>
  283. <th>Description</th>
  284. </tr>
  285. </thead>
  286. <tbody>
  287. <tr>
  288. <td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></td>
  289. <td></td>
  290. </tr>
  291. </tbody>
  292. </table>
  293. <h3 id="methods">Methods
  294. </h3>
  295. <span class="small pull-right mobile-hide">
  296. <span class="divider">|</span>
  297. <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/docfx/overrides/new?filename=Terminal_Gui_CollectionNavigator_GetNextMatchingItem_System_Int32_System_Char_.md&amp;value=---%0Auid%3A%20Terminal.Gui.CollectionNavigator.GetNextMatchingItem(System.Int32%2CSystem.Char)%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>
  298. </span>
  299. <span class="small pull-right mobile-hide">
  300. <a href="tig:tig/Terminal.Gui/blob/v2_develop/Terminal.Gui/Core/CollectionNavigator.cs/#L101">View Source</a>
  301. </span>
  302. <a id="Terminal_Gui_CollectionNavigator_GetNextMatchingItem_" data-uid="Terminal.Gui.CollectionNavigator.GetNextMatchingItem*"></a>
  303. <h4 id="Terminal_Gui_CollectionNavigator_GetNextMatchingItem_System_Int32_System_Char_" data-uid="Terminal.Gui.CollectionNavigator.GetNextMatchingItem(System.Int32,System.Char)">GetNextMatchingItem(int, char)</h4>
  304. <div class="markdown level1 summary">Gets the index of the next item in the collection that matches the current <a class="xref" href="Terminal.Gui.CollectionNavigator.html#Terminal_Gui_CollectionNavigator_SearchString">SearchString</a> plus the provided character (typically
  305. from a key press).</div>
  306. <div class="markdown level1 conceptual"></div>
  307. <h5 class="declaration">Declaration</h5>
  308. <div class="codewrapper">
  309. <pre><code class="lang-csharp hljs">public int GetNextMatchingItem(int currentIndex, char keyStruck)</code></pre>
  310. </div>
  311. <h5 class="parameters">Parameters</h5>
  312. <table class="table table-bordered table-condensed">
  313. <thead>
  314. <tr>
  315. <th>Type</th>
  316. <th>Name</th>
  317. <th>Description</th>
  318. </tr>
  319. </thead>
  320. <tbody>
  321. <tr>
  322. <td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></td>
  323. <td><span class="parametername">currentIndex</span></td>
  324. <td>The index in the collection to start the search from.</td>
  325. </tr>
  326. <tr>
  327. <td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.char">char</a></td>
  328. <td><span class="parametername">keyStruck</span></td>
  329. <td>The character of the key the user pressed.</td>
  330. </tr>
  331. </tbody>
  332. </table>
  333. <h5 class="returns">Returns</h5>
  334. <table class="table table-bordered table-condensed">
  335. <thead>
  336. <tr>
  337. <th>Type</th>
  338. <th>Description</th>
  339. </tr>
  340. </thead>
  341. <tbody>
  342. <tr>
  343. <td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></td>
  344. <td>The index of the item that matches what the user has typed.
  345. Returns <code>-1</code> if no item in the collection matched.</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/docfx/overrides/new?filename=Terminal_Gui_CollectionNavigator_IsCompatibleKey_Terminal_Gui_KeyEvent_.md&amp;value=---%0Auid%3A%20Terminal.Gui.CollectionNavigator.IsCompatibleKey(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>
  352. </span>
  353. <span class="small pull-right mobile-hide">
  354. <a href="tig:tig/Terminal.Gui/blob/v2_develop/Terminal.Gui/Core/CollectionNavigator.cs/#L239">View Source</a>
  355. </span>
  356. <a id="Terminal_Gui_CollectionNavigator_IsCompatibleKey_" data-uid="Terminal.Gui.CollectionNavigator.IsCompatibleKey*"></a>
  357. <h4 id="Terminal_Gui_CollectionNavigator_IsCompatibleKey_Terminal_Gui_KeyEvent_" data-uid="Terminal.Gui.CollectionNavigator.IsCompatibleKey(Terminal.Gui.KeyEvent)">IsCompatibleKey(KeyEvent)</h4>
  358. <div class="markdown level1 summary">Returns true if <code class="paramref">kb</code> is a searchable key
  359. (e.g. letters, numbers etc) that is valid to pass to to this
  360. class for search filtering.</div>
  361. <div class="markdown level1 conceptual"></div>
  362. <h5 class="declaration">Declaration</h5>
  363. <div class="codewrapper">
  364. <pre><code class="lang-csharp hljs">public static bool IsCompatibleKey(KeyEvent kb)</code></pre>
  365. </div>
  366. <h5 class="parameters">Parameters</h5>
  367. <table class="table table-bordered table-condensed">
  368. <thead>
  369. <tr>
  370. <th>Type</th>
  371. <th>Name</th>
  372. <th>Description</th>
  373. </tr>
  374. </thead>
  375. <tbody>
  376. <tr>
  377. <td><a class="xref" href="Terminal.Gui.KeyEvent.html">KeyEvent</a></td>
  378. <td><span class="parametername">kb</span></td>
  379. <td></td>
  380. </tr>
  381. </tbody>
  382. </table>
  383. <h5 class="returns">Returns</h5>
  384. <table class="table table-bordered table-condensed">
  385. <thead>
  386. <tr>
  387. <th>Type</th>
  388. <th>Description</th>
  389. </tr>
  390. </thead>
  391. <tbody>
  392. <tr>
  393. <td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></td>
  394. <td></td>
  395. </tr>
  396. </tbody>
  397. </table>
  398. <span class="small pull-right mobile-hide">
  399. <span class="divider">|</span>
  400. <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/docfx/overrides/new?filename=Terminal_Gui_CollectionNavigator_OnSearchStringChanged_Terminal_Gui_CollectionNavigator_KeystrokeNavigatorEventArgs_.md&amp;value=---%0Auid%3A%20Terminal.Gui.CollectionNavigator.OnSearchStringChanged(Terminal.Gui.CollectionNavigator.KeystrokeNavigatorEventArgs)%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>
  401. </span>
  402. <span class="small pull-right mobile-hide">
  403. <a href="tig:tig/Terminal.Gui/blob/v2_develop/Terminal.Gui/Core/CollectionNavigator.cs/#L88">View Source</a>
  404. </span>
  405. <a id="Terminal_Gui_CollectionNavigator_OnSearchStringChanged_" data-uid="Terminal.Gui.CollectionNavigator.OnSearchStringChanged*"></a>
  406. <h4 id="Terminal_Gui_CollectionNavigator_OnSearchStringChanged_Terminal_Gui_CollectionNavigator_KeystrokeNavigatorEventArgs_" data-uid="Terminal.Gui.CollectionNavigator.OnSearchStringChanged(Terminal.Gui.CollectionNavigator.KeystrokeNavigatorEventArgs)">OnSearchStringChanged(KeystrokeNavigatorEventArgs)</h4>
  407. <div class="markdown level1 summary">Invoked when the <a class="xref" href="Terminal.Gui.CollectionNavigator.html#Terminal_Gui_CollectionNavigator_SearchString">SearchString</a> changes. Useful for debugging. Invokes the <a class="xref" href="Terminal.Gui.CollectionNavigator.html#Terminal_Gui_CollectionNavigator_SearchStringChanged">SearchStringChanged</a> event.</div>
  408. <div class="markdown level1 conceptual"></div>
  409. <h5 class="declaration">Declaration</h5>
  410. <div class="codewrapper">
  411. <pre><code class="lang-csharp hljs">public virtual void OnSearchStringChanged(CollectionNavigator.KeystrokeNavigatorEventArgs e)</code></pre>
  412. </div>
  413. <h5 class="parameters">Parameters</h5>
  414. <table class="table table-bordered table-condensed">
  415. <thead>
  416. <tr>
  417. <th>Type</th>
  418. <th>Name</th>
  419. <th>Description</th>
  420. </tr>
  421. </thead>
  422. <tbody>
  423. <tr>
  424. <td><a class="xref" href="Terminal.Gui.CollectionNavigator.html">CollectionNavigator</a>.<a class="xref" href="Terminal.Gui.CollectionNavigator.KeystrokeNavigatorEventArgs.html">KeystrokeNavigatorEventArgs</a></td>
  425. <td><span class="parametername">e</span></td>
  426. <td></td>
  427. </tr>
  428. </tbody>
  429. </table>
  430. <h3 id="events">Events
  431. </h3>
  432. <span class="small pull-right mobile-hide">
  433. <span class="divider">|</span>
  434. <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/docfx/overrides/new?filename=Terminal_Gui_CollectionNavigator_SearchStringChanged.md&amp;value=---%0Auid%3A%20Terminal.Gui.CollectionNavigator.SearchStringChanged%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>
  435. </span>
  436. <span class="small pull-right mobile-hide">
  437. <a href="tig:tig/Terminal.Gui/blob/v2_develop/Terminal.Gui/Core/CollectionNavigator.cs/#L69">View Source</a>
  438. </span>
  439. <h4 id="Terminal_Gui_CollectionNavigator_SearchStringChanged" data-uid="Terminal.Gui.CollectionNavigator.SearchStringChanged">SearchStringChanged</h4>
  440. <div class="markdown level1 summary">This event is invoked when <a class="xref" href="Terminal.Gui.CollectionNavigator.html#Terminal_Gui_CollectionNavigator_SearchString">SearchString</a> changes. Useful for debugging.</div>
  441. <div class="markdown level1 conceptual"></div>
  442. <h5 class="declaration">Declaration</h5>
  443. <div class="codewrapper">
  444. <pre><code class="lang-csharp hljs">public event Action&lt;CollectionNavigator.KeystrokeNavigatorEventArgs&gt; SearchStringChanged</code></pre>
  445. </div>
  446. <h5 class="eventType">Event Type</h5>
  447. <table class="table table-bordered table-condensed">
  448. <thead>
  449. <tr>
  450. <th>Type</th>
  451. <th>Description</th>
  452. </tr>
  453. </thead>
  454. <tbody>
  455. <tr>
  456. <td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.action-1">Action</a>&lt;<a class="xref" href="Terminal.Gui.CollectionNavigator.html">CollectionNavigator</a>.<a class="xref" href="Terminal.Gui.CollectionNavigator.KeystrokeNavigatorEventArgs.html">KeystrokeNavigatorEventArgs</a>&gt;</td>
  457. <td></td>
  458. </tr>
  459. </tbody>
  460. </table>
  461. </article>
  462. </div>
  463. <div class="hidden-sm col-md-2" role="complementary">
  464. <div class="sideaffix">
  465. <div class="contribution">
  466. <ul class="nav">
  467. <li>
  468. <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/docfx/overrides/new?filename=Terminal_Gui_CollectionNavigator.md&amp;value=---%0Auid%3A%20Terminal.Gui.CollectionNavigator%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>
  469. </li>
  470. <li>
  471. <a href="tig:tig/Terminal.Gui/blob/v2_develop/Terminal.Gui/Core/CollectionNavigator.cs/#L18" class="contribution-link">View Source</a>
  472. </li>
  473. </ul>
  474. </div>
  475. <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
  476. <h5>In this article</h5>
  477. <div></div>
  478. </nav>
  479. </div>
  480. </div>
  481. </div>
  482. </div>
  483. <footer>
  484. <div class="grad-bottom"></div>
  485. <div class="footer">
  486. <div class="container">
  487. <span class="pull-right">
  488. <a href="#top">Back to top</a>
  489. </span>
  490. <span>Generated by <strong>DocFX</strong></span>
  491. </div>
  492. </div>
  493. </footer>
  494. </div>
  495. <script type="text/javascript" src="../../styles/docfx.vendor.min.js"></script>
  496. <script type="text/javascript" src="../../styles/docfx.js"></script>
  497. <script type="text/javascript" src="../../styles/main.js"></script>
  498. </body>
  499. </html>