Class AutocompleteBase

Namespace: Terminal.Gui

Assembly: Terminal.Gui.dll

Abstract implementation of IAutocomplete allows for tailoring how autocomplete is rendered/interacted with.

public abstract class AutocompleteBase : IAutocomplete

Inheritance: object

AutocompleteBase

Implements: IAutocomplete

Derived: AppendAutocomplete

PopupAutocomplete

Inherited Members: object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Properties

CloseKey: The key that the user can press to close the currently popped autocomplete menu

ColorScheme: The colors to use to render the overlay. Accessing this property before the Application has been initialized will cause an error

Context: The context used by the autocomplete menu.

HostControl: The host control that will use autocomplete.

MaxHeight: The maximum number of visible rows in the autocomplete dropdown to render

MaxWidth: The maximum width of the autocomplete dropdown

PopupInsideContainer: Gets or sets where the popup will be displayed.

Reopen: The key that the user can press to reopen the currently popped autocomplete menu

SelectedIdx: The currently selected index into Suggestions that the user has highlighted

SelectionKey: The key that the user must press to accept the currently selected autocomplete suggestion

SuggestionGenerator: Gets or Sets the class responsible for generating Suggestions based on a given AutocompleteContext of the HostControl.

Suggestions: The strings that form the current list of suggestions to render based on what the user has typed so far.

Visible: True if the autocomplete should be considered open and visible

Methods

ClearSuggestions(): Clears Suggestions

EnsureSelectedIdxIsValid(): Updates SelectedIdx to be a valid index within Suggestions

GenerateSuggestions(AutocompleteContext): Populates Suggestions with all Suggestion proposed by SuggestionGenerator at the given context (cursor position)

OnMouseEvent(MouseEventArgs, bool): Handle mouse events before HostControl 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.

ProcessKey(Key): Handle key events before HostControl 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.

RenderOverlay(Point): Renders the autocomplete dialog inside the given HostControl at the given point.

Edit this page