1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195 |
- <!DOCTYPE html>
- <!--[if IE]><![endif]-->
- <html>
-
- <head>
- <meta charset="utf-8">
- <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
- <title>Class Autocomplete
- </title>
- <meta name="viewport" content="width=device-width">
- <meta name="title" content="Class Autocomplete
- ">
- <meta name="generator" content="docfx 2.59.4.0">
-
- <link rel="shortcut icon" href="../../favicon.ico">
- <link rel="stylesheet" href="../../styles/docfx.vendor.css">
- <link rel="stylesheet" href="../../styles/docfx.css">
- <link rel="stylesheet" href="../../styles/main.css">
- <link href="https://fonts.googleapis.com/css?family=Source Sans Pro" rel="stylesheet">
- <link href="https://fonts.googleapis.com/css?family=Source Code Pro" rel="stylesheet">
- <meta property="docfx:navrel" content="../../toc.html">
- <meta property="docfx:tocrel" content="toc.html">
-
- <meta property="docfx:rel" content="../../">
-
- </head> <body data-spy="scroll" data-target="#affix" data-offset="120">
- <div id="wrapper">
- <header>
-
- <nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation">
- <div class="container">
- <div class="navbar-header">
- <button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
- <span class="sr-only">Toggle navigation</span>
- <span class="icon-bar"></span>
- <span class="icon-bar"></span>
- <span class="icon-bar"></span>
- </button>
-
- <a class="navbar-brand" href="../../index.html">
- <img id="logo" class="svg" src="../../images/logo48.png" alt="">
- </a>
- </div>
- <div class="collapse navbar-collapse" id="navbar">
- <form class="navbar-form navbar-right" role="search" id="search">
- <div class="form-group">
- <input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">
- </div>
- </form>
- </div>
- </div>
- </nav>
-
- <div class="subnav navbar navbar-default">
- <div class="container hide-when-search" id="breadcrumb">
- <ul class="breadcrumb">
- <li></li>
- </ul>
- </div>
- </div>
- </header>
- <div class="container body-content">
-
- <div id="search-results">
- <div class="search-list">Search Results for <span></span></div>
- <div class="sr-items">
- <p><i class="glyphicon glyphicon-refresh index-loading"></i></p>
- </div>
- <ul id="pagination" data-first="First" data-prev="Previous" data-next="Next" data-last="Last"></ul>
- </div>
- </div>
- <div role="main" class="container body-content hide-when-search">
-
- <div class="sidenav hide-when-search">
- <a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
- <div class="sidetoggle collapse" id="sidetoggle">
- <div id="sidetoc"></div>
- </div>
- </div>
- <div class="article row grid-right">
- <div class="col-md-10">
- <article class="content wrap" id="_content" data-uid="Terminal.Gui.Autocomplete">
-
-
- <h1 id="Terminal_Gui_Autocomplete" data-uid="Terminal.Gui.Autocomplete" class="text-break">Class Autocomplete
- </h1>
- <div class="markdown level0 summary">
- Renders an overlay on another view at a given point that allows selecting
- from a range of 'autocomplete' options.
- </div>
- <div class="markdown level0 conceptual"></div>
- <div class="inheritance">
- <h5>Inheritance</h5>
- <div class="level0"><span class="xref">System.Object</span></div>
- <div class="level1"><span class="xref">Autocomplete</span></div>
- <div class="level2"><a class="xref" href="Terminal.Gui.TextFieldAutocomplete.html">TextFieldAutocomplete</a></div>
- <div class="level2"><a class="xref" href="Terminal.Gui.TextViewAutocomplete.html">TextViewAutocomplete</a></div>
- </div>
- <div class="implements">
- <h5>Implements</h5>
- <div><a class="xref" href="Terminal.Gui.IAutocomplete.html">IAutocomplete</a></div>
- </div>
- <div class="inheritedMembers">
- <h5>Inherited Members</h5>
- <div>
- <span class="xref">System.Object.Equals(System.Object)</span>
- </div>
- <div>
- <span class="xref">System.Object.Equals(System.Object, System.Object)</span>
- </div>
- <div>
- <span class="xref">System.Object.GetHashCode()</span>
- </div>
- <div>
- <span class="xref">System.Object.GetType()</span>
- </div>
- <div>
- <span class="xref">System.Object.MemberwiseClone()</span>
- </div>
- <div>
- <span class="xref">System.Object.ReferenceEquals(System.Object, System.Object)</span>
- </div>
- <div>
- <span class="xref">System.Object.ToString()</span>
- </div>
- </div>
- <h6><strong>Namespace</strong>: <a class="xref" href="Terminal.Gui.html">Terminal.Gui</a></h6>
- <h6><strong>Assembly</strong>: Terminal.Gui.dll</h6>
- <h5 id="Terminal_Gui_Autocomplete_syntax">Syntax</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">public abstract class Autocomplete : IAutocomplete</code></pre>
- </div>
- <h3 id="properties">Properties
- </h3>
- <span class="small pull-right mobile-hide">
- <span class="divider">|</span>
- <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/apidoc/new?filename=Terminal_Gui_Autocomplete_AllSuggestions.md&value=---%0Auid%3A%20Terminal.Gui.Autocomplete.AllSuggestions%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
- </span>
- <span class="small pull-right mobile-hide">
- <a href="tig:tig/gui.cs/blob/main/Terminal.Gui/Core/Autocomplete/Autocomplete.cs/#L145">View Source</a>
- </span>
- <a id="Terminal_Gui_Autocomplete_AllSuggestions_" data-uid="Terminal.Gui.Autocomplete.AllSuggestions*"></a>
- <h4 id="Terminal_Gui_Autocomplete_AllSuggestions" data-uid="Terminal.Gui.Autocomplete.AllSuggestions">AllSuggestions</h4>
- <div class="markdown level1 summary">
- The full set of all strings that can be suggested.
- </div>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">public virtual List<string> AllSuggestions { get; set; }</code></pre>
- </div>
- <h5 class="propertyValue">Property Value</h5>
- <table class="table table-bordered table-striped table-condensed">
- <thead>
- <tr>
- <th>Type</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td><span class="xref">System.Collections.Generic.List</span><<span class="xref">System.String</span>></td>
- <td></td>
- </tr>
- </tbody>
- </table>
- <span class="small pull-right mobile-hide">
- <span class="divider">|</span>
- <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/apidoc/new?filename=Terminal_Gui_Autocomplete_CloseKey.md&value=---%0Auid%3A%20Terminal.Gui.Autocomplete.CloseKey%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
- </span>
- <span class="small pull-right mobile-hide">
- <a href="tig:tig/gui.cs/blob/main/Terminal.Gui/Core/Autocomplete/Autocomplete.cs/#L183">View Source</a>
- </span>
- <a id="Terminal_Gui_Autocomplete_CloseKey_" data-uid="Terminal.Gui.Autocomplete.CloseKey*"></a>
- <h4 id="Terminal_Gui_Autocomplete_CloseKey" data-uid="Terminal.Gui.Autocomplete.CloseKey">CloseKey</h4>
- <div class="markdown level1 summary">
- The key that the user can press to close the currently popped autocomplete menu
- </div>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">public virtual Key CloseKey { get; set; }</code></pre>
- </div>
- <h5 class="propertyValue">Property Value</h5>
- <table class="table table-bordered table-striped table-condensed">
- <thead>
- <tr>
- <th>Type</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td><a class="xref" href="Terminal.Gui.Key.html">Key</a></td>
- <td></td>
- </tr>
- </tbody>
- </table>
- <span class="small pull-right mobile-hide">
- <span class="divider">|</span>
- <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/apidoc/new?filename=Terminal_Gui_Autocomplete_ColorScheme.md&value=---%0Auid%3A%20Terminal.Gui.Autocomplete.ColorScheme%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
- </span>
- <span class="small pull-right mobile-hide">
- <a href="tig:tig/gui.cs/blob/main/Terminal.Gui/Core/Autocomplete/Autocomplete.cs/#L163">View Source</a>
- </span>
- <a id="Terminal_Gui_Autocomplete_ColorScheme_" data-uid="Terminal.Gui.Autocomplete.ColorScheme*"></a>
- <h4 id="Terminal_Gui_Autocomplete_ColorScheme" data-uid="Terminal.Gui.Autocomplete.ColorScheme">ColorScheme</h4>
- <div class="markdown level1 summary">
- The colors to use to render the overlay. Accessing this property before
- the Application has been initialized will cause an error
- </div>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">public virtual ColorScheme ColorScheme { get; set; }</code></pre>
- </div>
- <h5 class="propertyValue">Property Value</h5>
- <table class="table table-bordered table-striped table-condensed">
- <thead>
- <tr>
- <th>Type</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td><a class="xref" href="Terminal.Gui.ColorScheme.html">ColorScheme</a></td>
- <td></td>
- </tr>
- </tbody>
- </table>
- <span class="small pull-right mobile-hide">
- <span class="divider">|</span>
- <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/apidoc/new?filename=Terminal_Gui_Autocomplete_HostControl.md&value=---%0Auid%3A%20Terminal.Gui.Autocomplete.HostControl%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
- </span>
- <span class="small pull-right mobile-hide">
- <a href="tig:tig/gui.cs/blob/main/Terminal.Gui/Core/Autocomplete/Autocomplete.cs/#L64">View Source</a>
- </span>
- <a id="Terminal_Gui_Autocomplete_HostControl_" data-uid="Terminal.Gui.Autocomplete.HostControl*"></a>
- <h4 id="Terminal_Gui_Autocomplete_HostControl" data-uid="Terminal.Gui.Autocomplete.HostControl">HostControl</h4>
- <div class="markdown level1 summary">
- The host control to handle.
- </div>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">public virtual View HostControl { get; set; }</code></pre>
- </div>
- <h5 class="propertyValue">Property Value</h5>
- <table class="table table-bordered table-striped table-condensed">
- <thead>
- <tr>
- <th>Type</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td><a class="xref" href="Terminal.Gui.View.html">View</a></td>
- <td></td>
- </tr>
- </tbody>
- </table>
- <span class="small pull-right mobile-hide">
- <span class="divider">|</span>
- <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/apidoc/new?filename=Terminal_Gui_Autocomplete_MaxHeight.md&value=---%0Auid%3A%20Terminal.Gui.Autocomplete.MaxHeight%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
- </span>
- <span class="small pull-right mobile-hide">
- <a href="tig:tig/gui.cs/blob/main/Terminal.Gui/Core/Autocomplete/Autocomplete.cs/#L128">View Source</a>
- </span>
- <a id="Terminal_Gui_Autocomplete_MaxHeight_" data-uid="Terminal.Gui.Autocomplete.MaxHeight*"></a>
- <h4 id="Terminal_Gui_Autocomplete_MaxHeight" data-uid="Terminal.Gui.Autocomplete.MaxHeight">MaxHeight</h4>
- <div class="markdown level1 summary">
- The maximum number of visible rows in the autocomplete dropdown to render
- </div>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">public virtual int MaxHeight { get; set; }</code></pre>
- </div>
- <h5 class="propertyValue">Property Value</h5>
- <table class="table table-bordered table-striped table-condensed">
- <thead>
- <tr>
- <th>Type</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td><span class="xref">System.Int32</span></td>
- <td></td>
- </tr>
- </tbody>
- </table>
- <span class="small pull-right mobile-hide">
- <span class="divider">|</span>
- <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/apidoc/new?filename=Terminal_Gui_Autocomplete_MaxWidth.md&value=---%0Auid%3A%20Terminal.Gui.Autocomplete.MaxWidth%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
- </span>
- <span class="small pull-right mobile-hide">
- <a href="tig:tig/gui.cs/blob/main/Terminal.Gui/Core/Autocomplete/Autocomplete.cs/#L123">View Source</a>
- </span>
- <a id="Terminal_Gui_Autocomplete_MaxWidth_" data-uid="Terminal.Gui.Autocomplete.MaxWidth*"></a>
- <h4 id="Terminal_Gui_Autocomplete_MaxWidth" data-uid="Terminal.Gui.Autocomplete.MaxWidth">MaxWidth</h4>
- <div class="markdown level1 summary">
- The maximum width of the autocomplete dropdown
- </div>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">public virtual int MaxWidth { get; set; }</code></pre>
- </div>
- <h5 class="propertyValue">Property Value</h5>
- <table class="table table-bordered table-striped table-condensed">
- <thead>
- <tr>
- <th>Type</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td><span class="xref">System.Int32</span></td>
- <td></td>
- </tr>
- </tbody>
- </table>
- <span class="small pull-right mobile-hide">
- <span class="divider">|</span>
- <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/apidoc/new?filename=Terminal_Gui_Autocomplete_PopupInsideContainer.md&value=---%0Auid%3A%20Terminal.Gui.Autocomplete.PopupInsideContainer%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
- </span>
- <span class="small pull-right mobile-hide">
- <a href="tig:tig/gui.cs/blob/main/Terminal.Gui/Core/Autocomplete/Autocomplete.cs/#L118">View Source</a>
- </span>
- <a id="Terminal_Gui_Autocomplete_PopupInsideContainer_" data-uid="Terminal.Gui.Autocomplete.PopupInsideContainer*"></a>
- <h4 id="Terminal_Gui_Autocomplete_PopupInsideContainer" data-uid="Terminal.Gui.Autocomplete.PopupInsideContainer">PopupInsideContainer</h4>
- <div class="markdown level1 summary">
- Gets or sets If the popup is displayed inside or outside the host limits.
- </div>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">public bool PopupInsideContainer { get; set; }</code></pre>
- </div>
- <h5 class="propertyValue">Property Value</h5>
- <table class="table table-bordered table-striped table-condensed">
- <thead>
- <tr>
- <th>Type</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td><span class="xref">System.Boolean</span></td>
- <td></td>
- </tr>
- </tbody>
- </table>
- <span class="small pull-right mobile-hide">
- <span class="divider">|</span>
- <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/apidoc/new?filename=Terminal_Gui_Autocomplete_Reopen.md&value=---%0Auid%3A%20Terminal.Gui.Autocomplete.Reopen%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
- </span>
- <span class="small pull-right mobile-hide">
- <a href="tig:tig/gui.cs/blob/main/Terminal.Gui/Core/Autocomplete/Autocomplete.cs/#L188">View Source</a>
- </span>
- <a id="Terminal_Gui_Autocomplete_Reopen_" data-uid="Terminal.Gui.Autocomplete.Reopen*"></a>
- <h4 id="Terminal_Gui_Autocomplete_Reopen" data-uid="Terminal.Gui.Autocomplete.Reopen">Reopen</h4>
- <div class="markdown level1 summary">
- The key that the user can press to reopen the currently popped autocomplete menu
- </div>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">public virtual Key Reopen { get; set; }</code></pre>
- </div>
- <h5 class="propertyValue">Property Value</h5>
- <table class="table table-bordered table-striped table-condensed">
- <thead>
- <tr>
- <th>Type</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td><a class="xref" href="Terminal.Gui.Key.html">Key</a></td>
- <td></td>
- </tr>
- </tbody>
- </table>
- <span class="small pull-right mobile-hide">
- <span class="divider">|</span>
- <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/apidoc/new?filename=Terminal_Gui_Autocomplete_ScrollOffset.md&value=---%0Auid%3A%20Terminal.Gui.Autocomplete.ScrollOffset%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
- </span>
- <span class="small pull-right mobile-hide">
- <a href="tig:tig/gui.cs/blob/main/Terminal.Gui/Core/Autocomplete/Autocomplete.cs/#L157">View Source</a>
- </span>
- <a id="Terminal_Gui_Autocomplete_ScrollOffset_" data-uid="Terminal.Gui.Autocomplete.ScrollOffset*"></a>
- <h4 id="Terminal_Gui_Autocomplete_ScrollOffset" data-uid="Terminal.Gui.Autocomplete.ScrollOffset">ScrollOffset</h4>
- <div class="markdown level1 summary">
- When more suggestions are available than can be rendered the user
- can scroll down the dropdown list. This indicates how far down they
- have gone
- </div>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">public virtual int ScrollOffset { get; set; }</code></pre>
- </div>
- <h5 class="propertyValue">Property Value</h5>
- <table class="table table-bordered table-striped table-condensed">
- <thead>
- <tr>
- <th>Type</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td><span class="xref">System.Int32</span></td>
- <td></td>
- </tr>
- </tbody>
- </table>
- <span class="small pull-right mobile-hide">
- <span class="divider">|</span>
- <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/apidoc/new?filename=Terminal_Gui_Autocomplete_SelectedIdx.md&value=---%0Auid%3A%20Terminal.Gui.Autocomplete.SelectedIdx%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
- </span>
- <span class="small pull-right mobile-hide">
- <a href="tig:tig/gui.cs/blob/main/Terminal.Gui/Core/Autocomplete/Autocomplete.cs/#L150">View Source</a>
- </span>
- <a id="Terminal_Gui_Autocomplete_SelectedIdx_" data-uid="Terminal.Gui.Autocomplete.SelectedIdx*"></a>
- <h4 id="Terminal_Gui_Autocomplete_SelectedIdx" data-uid="Terminal.Gui.Autocomplete.SelectedIdx">SelectedIdx</h4>
- <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>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">public virtual int SelectedIdx { get; set; }</code></pre>
- </div>
- <h5 class="propertyValue">Property Value</h5>
- <table class="table table-bordered table-striped table-condensed">
- <thead>
- <tr>
- <th>Type</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td><span class="xref">System.Int32</span></td>
- <td></td>
- </tr>
- </tbody>
- </table>
- <span class="small pull-right mobile-hide">
- <span class="divider">|</span>
- <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/apidoc/new?filename=Terminal_Gui_Autocomplete_SelectionKey.md&value=---%0Auid%3A%20Terminal.Gui.Autocomplete.SelectionKey%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
- </span>
- <span class="small pull-right mobile-hide">
- <a href="tig:tig/gui.cs/blob/main/Terminal.Gui/Core/Autocomplete/Autocomplete.cs/#L178">View Source</a>
- </span>
- <a id="Terminal_Gui_Autocomplete_SelectionKey_" data-uid="Terminal.Gui.Autocomplete.SelectionKey*"></a>
- <h4 id="Terminal_Gui_Autocomplete_SelectionKey" data-uid="Terminal.Gui.Autocomplete.SelectionKey">SelectionKey</h4>
- <div class="markdown level1 summary">
- The key that the user must press to accept the currently selected autocomplete suggestion
- </div>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">public virtual Key SelectionKey { get; set; }</code></pre>
- </div>
- <h5 class="propertyValue">Property Value</h5>
- <table class="table table-bordered table-striped table-condensed">
- <thead>
- <tr>
- <th>Type</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td><a class="xref" href="Terminal.Gui.Key.html">Key</a></td>
- <td></td>
- </tr>
- </tbody>
- </table>
- <span class="small pull-right mobile-hide">
- <span class="divider">|</span>
- <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/apidoc/new?filename=Terminal_Gui_Autocomplete_Suggestions.md&value=---%0Auid%3A%20Terminal.Gui.Autocomplete.Suggestions%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
- </span>
- <span class="small pull-right mobile-hide">
- <a href="tig:tig/gui.cs/blob/main/Terminal.Gui/Core/Autocomplete/Autocomplete.cs/#L139">View Source</a>
- </span>
- <a id="Terminal_Gui_Autocomplete_Suggestions_" data-uid="Terminal.Gui.Autocomplete.Suggestions*"></a>
- <h4 id="Terminal_Gui_Autocomplete_Suggestions" data-uid="Terminal.Gui.Autocomplete.Suggestions">Suggestions</h4>
- <div class="markdown level1 summary">
- The strings that form the current list of suggestions to render
- based on what the user has typed so far.
- </div>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">public virtual ReadOnlyCollection<string> Suggestions { get; set; }</code></pre>
- </div>
- <h5 class="propertyValue">Property Value</h5>
- <table class="table table-bordered table-striped table-condensed">
- <thead>
- <tr>
- <th>Type</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td><span class="xref">System.Collections.ObjectModel.ReadOnlyCollection</span><<span class="xref">System.String</span>></td>
- <td></td>
- </tr>
- </tbody>
- </table>
- <span class="small pull-right mobile-hide">
- <span class="divider">|</span>
- <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/apidoc/new?filename=Terminal_Gui_Autocomplete_Visible.md&value=---%0Auid%3A%20Terminal.Gui.Autocomplete.Visible%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
- </span>
- <span class="small pull-right mobile-hide">
- <a href="tig:tig/gui.cs/blob/main/Terminal.Gui/Core/Autocomplete/Autocomplete.cs/#L133">View Source</a>
- </span>
- <a id="Terminal_Gui_Autocomplete_Visible_" data-uid="Terminal.Gui.Autocomplete.Visible*"></a>
- <h4 id="Terminal_Gui_Autocomplete_Visible" data-uid="Terminal.Gui.Autocomplete.Visible">Visible</h4>
- <div class="markdown level1 summary">
- True if the autocomplete should be considered open and visible
- </div>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">public virtual bool Visible { get; set; }</code></pre>
- </div>
- <h5 class="propertyValue">Property Value</h5>
- <table class="table table-bordered table-striped table-condensed">
- <thead>
- <tr>
- <th>Type</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td><span class="xref">System.Boolean</span></td>
- <td></td>
- </tr>
- </tbody>
- </table>
- <h3 id="methods">Methods
- </h3>
- <span class="small pull-right mobile-hide">
- <span class="divider">|</span>
- <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/apidoc/new?filename=Terminal_Gui_Autocomplete_ClearSuggestions.md&value=---%0Auid%3A%20Terminal.Gui.Autocomplete.ClearSuggestions%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
- </span>
- <span class="small pull-right mobile-hide">
- <a href="tig:tig/gui.cs/blob/main/Terminal.Gui/Core/Autocomplete/Autocomplete.cs/#L437">View Source</a>
- </span>
- <a id="Terminal_Gui_Autocomplete_ClearSuggestions_" data-uid="Terminal.Gui.Autocomplete.ClearSuggestions*"></a>
- <h4 id="Terminal_Gui_Autocomplete_ClearSuggestions" data-uid="Terminal.Gui.Autocomplete.ClearSuggestions">ClearSuggestions()</h4>
- <div class="markdown level1 summary">
- Clears <a class="xref" href="Terminal.Gui.Autocomplete.html#Terminal_Gui_Autocomplete_Suggestions">Suggestions</a>
- </div>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">public virtual void ClearSuggestions()</code></pre>
- </div>
- <span class="small pull-right mobile-hide">
- <span class="divider">|</span>
- <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/apidoc/new?filename=Terminal_Gui_Autocomplete_Close.md&value=---%0Auid%3A%20Terminal.Gui.Autocomplete.Close%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
- </span>
- <span class="small pull-right mobile-hide">
- <a href="tig:tig/gui.cs/blob/main/Terminal.Gui/Core/Autocomplete/Autocomplete.cs/#L591">View Source</a>
- </span>
- <a id="Terminal_Gui_Autocomplete_Close_" data-uid="Terminal.Gui.Autocomplete.Close*"></a>
- <h4 id="Terminal_Gui_Autocomplete_Close" data-uid="Terminal.Gui.Autocomplete.Close">Close()</h4>
- <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>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">protected void Close()</code></pre>
- </div>
- <span class="small pull-right mobile-hide">
- <span class="divider">|</span>
- <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/apidoc/new?filename=Terminal_Gui_Autocomplete_DeleteTextBackwards.md&value=---%0Auid%3A%20Terminal.Gui.Autocomplete.DeleteTextBackwards%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
- </span>
- <span class="small pull-right mobile-hide">
- <a href="tig:tig/gui.cs/blob/main/Terminal.Gui/Core/Autocomplete/Autocomplete.cs/#L580">View Source</a>
- </span>
- <a id="Terminal_Gui_Autocomplete_DeleteTextBackwards_" data-uid="Terminal.Gui.Autocomplete.DeleteTextBackwards*"></a>
- <h4 id="Terminal_Gui_Autocomplete_DeleteTextBackwards" data-uid="Terminal.Gui.Autocomplete.DeleteTextBackwards">DeleteTextBackwards()</h4>
- <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>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">protected abstract void DeleteTextBackwards()</code></pre>
- </div>
- <span class="small pull-right mobile-hide">
- <span class="divider">|</span>
- <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/apidoc/new?filename=Terminal_Gui_Autocomplete_EnsureSelectedIdxIsValid.md&value=---%0Auid%3A%20Terminal.Gui.Autocomplete.EnsureSelectedIdxIsValid%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
- </span>
- <span class="small pull-right mobile-hide">
- <a href="tig:tig/gui.cs/blob/main/Terminal.Gui/Core/Autocomplete/Autocomplete.cs/#L300">View Source</a>
- </span>
- <a id="Terminal_Gui_Autocomplete_EnsureSelectedIdxIsValid_" data-uid="Terminal.Gui.Autocomplete.EnsureSelectedIdxIsValid*"></a>
- <h4 id="Terminal_Gui_Autocomplete_EnsureSelectedIdxIsValid" data-uid="Terminal.Gui.Autocomplete.EnsureSelectedIdxIsValid">EnsureSelectedIdxIsValid()</h4>
- <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>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">public virtual void EnsureSelectedIdxIsValid()</code></pre>
- </div>
- <span class="small pull-right mobile-hide">
- <span class="divider">|</span>
- <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/apidoc/new?filename=Terminal_Gui_Autocomplete_GenerateSuggestions.md&value=---%0Auid%3A%20Terminal.Gui.Autocomplete.GenerateSuggestions%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
- </span>
- <span class="small pull-right mobile-hide">
- <a href="tig:tig/gui.cs/blob/main/Terminal.Gui/Core/Autocomplete/Autocomplete.cs/#L447">View Source</a>
- </span>
- <a id="Terminal_Gui_Autocomplete_GenerateSuggestions_" data-uid="Terminal.Gui.Autocomplete.GenerateSuggestions*"></a>
- <h4 id="Terminal_Gui_Autocomplete_GenerateSuggestions" data-uid="Terminal.Gui.Autocomplete.GenerateSuggestions">GenerateSuggestions()</h4>
- <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
- match with the current cursor position/text in the <a class="xref" href="Terminal.Gui.Autocomplete.html#Terminal_Gui_Autocomplete_HostControl">HostControl</a>
- </div>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">public virtual void GenerateSuggestions()</code></pre>
- </div>
- <span class="small pull-right mobile-hide">
- <span class="divider">|</span>
- <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/apidoc/new?filename=Terminal_Gui_Autocomplete_GetCurrentWord.md&value=---%0Auid%3A%20Terminal.Gui.Autocomplete.GetCurrentWord%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
- </span>
- <span class="small pull-right mobile-hide">
- <a href="tig:tig/gui.cs/blob/main/Terminal.Gui/Core/Autocomplete/Autocomplete.cs/#L531">View Source</a>
- </span>
- <a id="Terminal_Gui_Autocomplete_GetCurrentWord_" data-uid="Terminal.Gui.Autocomplete.GetCurrentWord*"></a>
- <h4 id="Terminal_Gui_Autocomplete_GetCurrentWord" data-uid="Terminal.Gui.Autocomplete.GetCurrentWord">GetCurrentWord()</h4>
- <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>.
- <p>
- 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<Rune>, Int32)</a>
- </p>
- </div>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">protected abstract string GetCurrentWord()</code></pre>
- </div>
- <h5 class="returns">Returns</h5>
- <table class="table table-bordered table-striped table-condensed">
- <thead>
- <tr>
- <th>Type</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td><span class="xref">System.String</span></td>
- <td></td>
- </tr>
- </tbody>
- </table>
- <span class="small pull-right mobile-hide">
- <span class="divider">|</span>
- <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/apidoc/new?filename=Terminal_Gui_Autocomplete_IdxToWord_System_Collections_Generic_List_System_Rune__System_Int32_.md&value=---%0Auid%3A%20Terminal.Gui.Autocomplete.IdxToWord(System.Collections.Generic.List%7BSystem.Rune%7D%2CSystem.Int32)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
- </span>
- <span class="small pull-right mobile-hide">
- <a href="tig:tig/gui.cs/blob/main/Terminal.Gui/Core/Autocomplete/Autocomplete.cs/#L545">View Source</a>
- </span>
- <a id="Terminal_Gui_Autocomplete_IdxToWord_" data-uid="Terminal.Gui.Autocomplete.IdxToWord*"></a>
- <h4 id="Terminal_Gui_Autocomplete_IdxToWord_System_Collections_Generic_List_System_Rune__System_Int32_" data-uid="Terminal.Gui.Autocomplete.IdxToWord(System.Collections.Generic.List{System.Rune},System.Int32)">IdxToWord(List<Rune>, Int32)</h4>
- <div class="markdown level1 summary">
- <p>
- Given a <code data-dev-comment-type="paramref" class="paramref">line</code> of characters, returns the word which ends at <code data-dev-comment-type="paramref" class="paramref">idx</code>
- or null. Also returns null if the <code data-dev-comment-type="paramref" class="paramref">idx</code> is positioned in the middle of a word.
- </p>
- <p>Use this method to determine whether autocomplete should be shown when the cursor is at
- a given point in a line and to get the word from which suggestions should be generated.</p>
- </div>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">protected virtual string IdxToWord(List<Rune> line, int idx)</code></pre>
- </div>
- <h5 class="parameters">Parameters</h5>
- <table class="table table-bordered table-striped table-condensed">
- <thead>
- <tr>
- <th>Type</th>
- <th>Name</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td><span class="xref">System.Collections.Generic.List</span><<span class="xref">System.Rune</span>></td>
- <td><span class="parametername">line</span></td>
- <td></td>
- </tr>
- <tr>
- <td><span class="xref">System.Int32</span></td>
- <td><span class="parametername">idx</span></td>
- <td></td>
- </tr>
- </tbody>
- </table>
- <h5 class="returns">Returns</h5>
- <table class="table table-bordered table-striped table-condensed">
- <thead>
- <tr>
- <th>Type</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td><span class="xref">System.String</span></td>
- <td></td>
- </tr>
- </tbody>
- </table>
- <span class="small pull-right mobile-hide">
- <span class="divider">|</span>
- <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/apidoc/new?filename=Terminal_Gui_Autocomplete_InsertSelection_System_String_.md&value=---%0Auid%3A%20Terminal.Gui.Autocomplete.InsertSelection(System.String)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
- </span>
- <span class="small pull-right mobile-hide">
- <a href="tig:tig/gui.cs/blob/main/Terminal.Gui/Core/Autocomplete/Autocomplete.cs/#L506">View Source</a>
- </span>
- <a id="Terminal_Gui_Autocomplete_InsertSelection_" data-uid="Terminal.Gui.Autocomplete.InsertSelection*"></a>
- <h4 id="Terminal_Gui_Autocomplete_InsertSelection_System_String_" data-uid="Terminal.Gui.Autocomplete.InsertSelection(System.String)">InsertSelection(String)</h4>
- <div class="markdown level1 summary">
- Called when the user confirms a selection at the current cursor location in
- the <a class="xref" href="Terminal.Gui.Autocomplete.html#Terminal_Gui_Autocomplete_HostControl">HostControl</a>. The <code data-dev-comment-type="paramref" class="paramref">accepted</code> string
- is the full autocomplete word to be inserted. Typically a host will have to
- remove some characters such that the <code data-dev-comment-type="paramref" class="paramref">accepted</code> string
- completes the word instead of simply being appended.
- </div>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">protected virtual bool InsertSelection(string accepted)</code></pre>
- </div>
- <h5 class="parameters">Parameters</h5>
- <table class="table table-bordered table-striped table-condensed">
- <thead>
- <tr>
- <th>Type</th>
- <th>Name</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td><span class="xref">System.String</span></td>
- <td><span class="parametername">accepted</span></td>
- <td></td>
- </tr>
- </tbody>
- </table>
- <h5 class="returns">Returns</h5>
- <table class="table table-bordered table-striped table-condensed">
- <thead>
- <tr>
- <th>Type</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td><span class="xref">System.Boolean</span></td>
- <td>True if the insertion was possible otherwise false</td>
- </tr>
- </tbody>
- </table>
- <span class="small pull-right mobile-hide">
- <span class="divider">|</span>
- <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/apidoc/new?filename=Terminal_Gui_Autocomplete_InsertText_System_String_.md&value=---%0Auid%3A%20Terminal.Gui.Autocomplete.InsertText(System.String)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
- </span>
- <span class="small pull-right mobile-hide">
- <a href="tig:tig/gui.cs/blob/main/Terminal.Gui/Core/Autocomplete/Autocomplete.cs/#L586">View Source</a>
- </span>
- <a id="Terminal_Gui_Autocomplete_InsertText_" data-uid="Terminal.Gui.Autocomplete.InsertText*"></a>
- <h4 id="Terminal_Gui_Autocomplete_InsertText_System_String_" data-uid="Terminal.Gui.Autocomplete.InsertText(System.String)">InsertText(String)</h4>
- <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>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">protected abstract void InsertText(string accepted)</code></pre>
- </div>
- <h5 class="parameters">Parameters</h5>
- <table class="table table-bordered table-striped table-condensed">
- <thead>
- <tr>
- <th>Type</th>
- <th>Name</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td><span class="xref">System.String</span></td>
- <td><span class="parametername">accepted</span></td>
- <td></td>
- </tr>
- </tbody>
- </table>
- <span class="small pull-right mobile-hide">
- <span class="divider">|</span>
- <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/apidoc/new?filename=Terminal_Gui_Autocomplete_IsWordChar_System_Rune_.md&value=---%0Auid%3A%20Terminal.Gui.Autocomplete.IsWordChar(System.Rune)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
- </span>
- <span class="small pull-right mobile-hide">
- <a href="tig:tig/gui.cs/blob/main/Terminal.Gui/Core/Autocomplete/Autocomplete.cs/#L476">View Source</a>
- </span>
- <a id="Terminal_Gui_Autocomplete_IsWordChar_" data-uid="Terminal.Gui.Autocomplete.IsWordChar*"></a>
- <h4 id="Terminal_Gui_Autocomplete_IsWordChar_System_Rune_" data-uid="Terminal.Gui.Autocomplete.IsWordChar(System.Rune)">IsWordChar(Rune)</h4>
- <div class="markdown level1 summary">
- Return true if the given symbol should be considered part of a word
- and can be contained in matches. Base behavior is to use <span class="xref">System.Char.IsLetterOrDigit(System.Char)</span>
- </div>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">public virtual bool IsWordChar(Rune rune)</code></pre>
- </div>
- <h5 class="parameters">Parameters</h5>
- <table class="table table-bordered table-striped table-condensed">
- <thead>
- <tr>
- <th>Type</th>
- <th>Name</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td><span class="xref">System.Rune</span></td>
- <td><span class="parametername">rune</span></td>
- <td></td>
- </tr>
- </tbody>
- </table>
- <h5 class="returns">Returns</h5>
- <table class="table table-bordered table-striped table-condensed">
- <thead>
- <tr>
- <th>Type</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td><span class="xref">System.Boolean</span></td>
- <td></td>
- </tr>
- </tbody>
- </table>
- <span class="small pull-right mobile-hide">
- <span class="divider">|</span>
- <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/apidoc/new?filename=Terminal_Gui_Autocomplete_MouseEvent_Terminal_Gui_MouseEvent_System_Boolean_.md&value=---%0Auid%3A%20Terminal.Gui.Autocomplete.MouseEvent(Terminal.Gui.MouseEvent%2CSystem.Boolean)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
- </span>
- <span class="small pull-right mobile-hide">
- <a href="tig:tig/gui.cs/blob/main/Terminal.Gui/Core/Autocomplete/Autocomplete.cs/#L368">View Source</a>
- </span>
- <a id="Terminal_Gui_Autocomplete_MouseEvent_" data-uid="Terminal.Gui.Autocomplete.MouseEvent*"></a>
- <h4 id="Terminal_Gui_Autocomplete_MouseEvent_Terminal_Gui_MouseEvent_System_Boolean_" data-uid="Terminal.Gui.Autocomplete.MouseEvent(Terminal.Gui.MouseEvent,System.Boolean)">MouseEvent(MouseEvent, Boolean)</h4>
- <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
- report/click apply to the autocomplete control instead of changing the cursor position in
- the underlying text view.
- </div>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">public virtual bool MouseEvent(MouseEvent me, bool fromHost = false)</code></pre>
- </div>
- <h5 class="parameters">Parameters</h5>
- <table class="table table-bordered table-striped table-condensed">
- <thead>
- <tr>
- <th>Type</th>
- <th>Name</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td><a class="xref" href="Terminal.Gui.MouseEvent.html">MouseEvent</a></td>
- <td><span class="parametername">me</span></td>
- <td>The mouse event.</td>
- </tr>
- <tr>
- <td><span class="xref">System.Boolean</span></td>
- <td><span class="parametername">fromHost</span></td>
- <td>If was called from the popup or from the host.</td>
- </tr>
- </tbody>
- </table>
- <h5 class="returns">Returns</h5>
- <table class="table table-bordered table-striped table-condensed">
- <thead>
- <tr>
- <th>Type</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td><span class="xref">System.Boolean</span></td>
- <td><code>true</code>if the mouse can be handled <code>false</code>otherwise.</td>
- </tr>
- </tbody>
- </table>
- <span class="small pull-right mobile-hide">
- <span class="divider">|</span>
- <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/apidoc/new?filename=Terminal_Gui_Autocomplete_MoveDown.md&value=---%0Auid%3A%20Terminal.Gui.Autocomplete.MoveDown%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
- </span>
- <span class="small pull-right mobile-hide">
- <a href="tig:tig/gui.cs/blob/main/Terminal.Gui/Core/Autocomplete/Autocomplete.cs/#L616">View Source</a>
- </span>
- <a id="Terminal_Gui_Autocomplete_MoveDown_" data-uid="Terminal.Gui.Autocomplete.MoveDown*"></a>
- <h4 id="Terminal_Gui_Autocomplete_MoveDown" data-uid="Terminal.Gui.Autocomplete.MoveDown">MoveDown()</h4>
- <div class="markdown level1 summary">
- Moves the selection in the Autocomplete context menu down one
- </div>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">protected void MoveDown()</code></pre>
- </div>
- <span class="small pull-right mobile-hide">
- <span class="divider">|</span>
- <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/apidoc/new?filename=Terminal_Gui_Autocomplete_MoveUp.md&value=---%0Auid%3A%20Terminal.Gui.Autocomplete.MoveUp%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
- </span>
- <span class="small pull-right mobile-hide">
- <a href="tig:tig/gui.cs/blob/main/Terminal.Gui/Core/Autocomplete/Autocomplete.cs/#L603">View Source</a>
- </span>
- <a id="Terminal_Gui_Autocomplete_MoveUp_" data-uid="Terminal.Gui.Autocomplete.MoveUp*"></a>
- <h4 id="Terminal_Gui_Autocomplete_MoveUp" data-uid="Terminal.Gui.Autocomplete.MoveUp">MoveUp()</h4>
- <div class="markdown level1 summary">
- Moves the selection in the Autocomplete context menu up one
- </div>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">protected void MoveUp()</code></pre>
- </div>
- <span class="small pull-right mobile-hide">
- <span class="divider">|</span>
- <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/apidoc/new?filename=Terminal_Gui_Autocomplete_ProcessKey_Terminal_Gui_KeyEvent_.md&value=---%0Auid%3A%20Terminal.Gui.Autocomplete.ProcessKey(Terminal.Gui.KeyEvent)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
- </span>
- <span class="small pull-right mobile-hide">
- <a href="tig:tig/gui.cs/blob/main/Terminal.Gui/Core/Autocomplete/Autocomplete.cs/#L322">View Source</a>
- </span>
- <a id="Terminal_Gui_Autocomplete_ProcessKey_" data-uid="Terminal.Gui.Autocomplete.ProcessKey*"></a>
- <h4 id="Terminal_Gui_Autocomplete_ProcessKey_Terminal_Gui_KeyEvent_" data-uid="Terminal.Gui.Autocomplete.ProcessKey(Terminal.Gui.KeyEvent)">ProcessKey(KeyEvent)</h4>
- <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
- up/down apply to the autocomplete control instead of changing the cursor position in
- the underlying text view.
- </div>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">public virtual bool ProcessKey(KeyEvent kb)</code></pre>
- </div>
- <h5 class="parameters">Parameters</h5>
- <table class="table table-bordered table-striped table-condensed">
- <thead>
- <tr>
- <th>Type</th>
- <th>Name</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td><a class="xref" href="Terminal.Gui.KeyEvent.html">KeyEvent</a></td>
- <td><span class="parametername">kb</span></td>
- <td>The key event.</td>
- </tr>
- </tbody>
- </table>
- <h5 class="returns">Returns</h5>
- <table class="table table-bordered table-striped table-condensed">
- <thead>
- <tr>
- <th>Type</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td><span class="xref">System.Boolean</span></td>
- <td><code>true</code>if the key can be handled <code>false</code>otherwise.</td>
- </tr>
- </tbody>
- </table>
- <span class="small pull-right mobile-hide">
- <span class="divider">|</span>
- <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/apidoc/new?filename=Terminal_Gui_Autocomplete_RenderOverlay_Terminal_Gui_Point_.md&value=---%0Auid%3A%20Terminal.Gui.Autocomplete.RenderOverlay(Terminal.Gui.Point)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
- </span>
- <span class="small pull-right mobile-hide">
- <a href="tig:tig/gui.cs/blob/main/Terminal.Gui/Core/Autocomplete/Autocomplete.cs/#L195">View Source</a>
- </span>
- <a id="Terminal_Gui_Autocomplete_RenderOverlay_" data-uid="Terminal.Gui.Autocomplete.RenderOverlay*"></a>
- <h4 id="Terminal_Gui_Autocomplete_RenderOverlay_Terminal_Gui_Point_" data-uid="Terminal.Gui.Autocomplete.RenderOverlay(Terminal.Gui.Point)">RenderOverlay(Point)</h4>
- <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
- given point.
- </div>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">public virtual void RenderOverlay(Point renderAt)</code></pre>
- </div>
- <h5 class="parameters">Parameters</h5>
- <table class="table table-bordered table-striped table-condensed">
- <thead>
- <tr>
- <th>Type</th>
- <th>Name</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td><a class="xref" href="Terminal.Gui.Point.html">Point</a></td>
- <td><span class="parametername">renderAt</span></td>
- <td></td>
- </tr>
- </tbody>
- </table>
- <span class="small pull-right mobile-hide">
- <span class="divider">|</span>
- <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/apidoc/new?filename=Terminal_Gui_Autocomplete_RenderSelectedIdxByMouse_Terminal_Gui_MouseEvent_.md&value=---%0Auid%3A%20Terminal.Gui.Autocomplete.RenderSelectedIdxByMouse(Terminal.Gui.MouseEvent)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
- </span>
- <span class="small pull-right mobile-hide">
- <a href="tig:tig/gui.cs/blob/main/Terminal.Gui/Core/Autocomplete/Autocomplete.cs/#L424">View Source</a>
- </span>
- <a id="Terminal_Gui_Autocomplete_RenderSelectedIdxByMouse_" data-uid="Terminal.Gui.Autocomplete.RenderSelectedIdxByMouse*"></a>
- <h4 id="Terminal_Gui_Autocomplete_RenderSelectedIdxByMouse_Terminal_Gui_MouseEvent_" data-uid="Terminal.Gui.Autocomplete.RenderSelectedIdxByMouse(Terminal.Gui.MouseEvent)">RenderSelectedIdxByMouse(MouseEvent)</h4>
- <div class="markdown level1 summary">
- Render the current selection in the Autocomplete context menu by the mouse reporting.
- </div>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">protected void RenderSelectedIdxByMouse(MouseEvent me)</code></pre>
- </div>
- <h5 class="parameters">Parameters</h5>
- <table class="table table-bordered table-striped table-condensed">
- <thead>
- <tr>
- <th>Type</th>
- <th>Name</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td><a class="xref" href="Terminal.Gui.MouseEvent.html">MouseEvent</a></td>
- <td><span class="parametername">me</span></td>
- <td></td>
- </tr>
- </tbody>
- </table>
- <span class="small pull-right mobile-hide">
- <span class="divider">|</span>
- <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/apidoc/new?filename=Terminal_Gui_Autocomplete_ReopenSuggestions.md&value=---%0Auid%3A%20Terminal.Gui.Autocomplete.ReopenSuggestions%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
- </span>
- <span class="small pull-right mobile-hide">
- <a href="tig:tig/gui.cs/blob/main/Terminal.Gui/Core/Autocomplete/Autocomplete.cs/#L630">View Source</a>
- </span>
- <a id="Terminal_Gui_Autocomplete_ReopenSuggestions_" data-uid="Terminal.Gui.Autocomplete.ReopenSuggestions*"></a>
- <h4 id="Terminal_Gui_Autocomplete_ReopenSuggestions" data-uid="Terminal.Gui.Autocomplete.ReopenSuggestions">ReopenSuggestions()</h4>
- <div class="markdown level1 summary">
- Reopen the popup after it has been closed.
- </div>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">protected bool ReopenSuggestions()</code></pre>
- </div>
- <h5 class="returns">Returns</h5>
- <table class="table table-bordered table-striped table-condensed">
- <thead>
- <tr>
- <th>Type</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td><span class="xref">System.Boolean</span></td>
- <td></td>
- </tr>
- </tbody>
- </table>
- <span class="small pull-right mobile-hide">
- <span class="divider">|</span>
- <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/apidoc/new?filename=Terminal_Gui_Autocomplete_Select.md&value=---%0Auid%3A%20Terminal.Gui.Autocomplete.Select%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
- </span>
- <span class="small pull-right mobile-hide">
- <a href="tig:tig/gui.cs/blob/main/Terminal.Gui/Core/Autocomplete/Autocomplete.cs/#L485">View Source</a>
- </span>
- <a id="Terminal_Gui_Autocomplete_Select_" data-uid="Terminal.Gui.Autocomplete.Select*"></a>
- <h4 id="Terminal_Gui_Autocomplete_Select" data-uid="Terminal.Gui.Autocomplete.Select">Select()</h4>
- <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>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">protected bool Select()</code></pre>
- </div>
- <h5 class="returns">Returns</h5>
- <table class="table table-bordered table-striped table-condensed">
- <thead>
- <tr>
- <th>Type</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td><span class="xref">System.Boolean</span></td>
- <td></td>
- </tr>
- </tbody>
- </table>
- <h3 id="implements">Implements</h3>
- <div>
- <a class="xref" href="Terminal.Gui.IAutocomplete.html">IAutocomplete</a>
- </div>
- </article>
- </div>
-
- <div class="hidden-sm col-md-2" role="complementary">
- <div class="sideaffix">
- <div class="contribution">
- <ul class="nav">
- <li>
- <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/apidoc/new?filename=Terminal_Gui_Autocomplete.md&value=---%0Auid%3A%20Terminal.Gui.Autocomplete%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A" class="contribution-link">Improve this Doc</a>
- </li>
- <li>
- <a href="tig:tig/gui.cs/blob/main/Terminal.Gui/Core/Autocomplete/Autocomplete.cs/#L14" class="contribution-link">View Source</a>
- </li>
- </ul>
- </div>
- <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
- <h5>In This Article</h5>
- <div></div>
- </nav>
- </div>
- </div>
- </div>
- </div>
-
- <footer>
- <div class="grad-bottom"></div>
- <div class="footer">
- <div class="container">
- <span class="pull-right">
- <a href="#top">Back to top</a>
- </span>
-
- <span>Generated by <strong>DocFX</strong></span>
- </div>
- </div>
- </footer>
- </div>
-
- <script type="text/javascript" src="../../styles/docfx.vendor.js"></script>
- <script type="text/javascript" src="../../styles/docfx.js"></script>
- <script type="text/javascript" src="../../styles/main.js"></script>
- </body>
- </html>
|