Table of Contents

Class TextField

Namespace
Terminal.Gui.Views
Assembly
Terminal.Gui.dll

Single-line text editor.

public class TextField : View, IDisposable, ISupportInitializeNotification, ISupportInitialize, IDesignable
Inheritance
TextField
Implements
Derived
Inherited Members
Extension Methods

Remarks

The TextField View provides editing functionality and mouse support.

Constructors

TextField()

Initializes a new instance of the TextField class.

Properties

Autocomplete

Provides autocomplete context menu based on suggestions at the current cursor position. Configure ISuggestionGenerator to enable this feature.

ContextMenu

Get the Context Menu for this view.

InsertionPoint

Gets or sets the insertion point within the text, measured as a 0-based index into text elements.

IsDirty

Indicates whatever the text was changed or not. true if the text was changed false otherwise.

ReadOnly

Gets or sets whether the text field is read-only.

ScrollOffset

Gets the horizontal scroll offset, representing the index of the first visible text element.

Secret

Gets or sets whether the text entered is treated as secret (e.g., for passwords). The displayed text is masked (e.g., with asterisks) when this is set to true.

SelectWordOnlyOnDoubleClick

Gets or sets whether the word navigation should select only the word itself without spaces around it or with the spaces at right. Default is false meaning that the spaces at right are included in the selection.

SelectedLength

Gets the length of the selected text in text elements.

SelectedStart

Gets or sets the anchor position where text selection began, measured as a 0-based index into text elements.

SelectedText

Gets The selected text.

Text

Sets or gets the text held by the view.

UseSameRuneTypeForWords

Gets or sets whether the word forward and word backward navigation should use the same or equivalent rune type. Default is false meaning using equivalent rune type.

Used

Tracks whether the text field should be considered "used", that is, that the user has moved in the entry, so new input should be appended at the cursor position, rather than clearing the entry

Methods

ClearAllSelection()

Clear the selected text.

ClearHistoryChanges()

Clears the history.

Copy()

Copy the selected text to the clipboard.

Cut()

Cut the selected text to the clipboard.

DeleteAll()

Deletes all text.

DeleteCharLeft(bool)

Deletes the character to the left.

DeleteCharRight()

Deletes the character to the right.

Dispose(bool)

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

EnableForDesign()

Causes the View to enable design-time mode. This typically means that the view will load demo data and be configured to allow for design-time manipulation.

InsertText(string, bool)

Inserts the given toAdd text at the current cursor position exactly as if the user had just typed it

KillWordBackwards()

Deletes word backwards.

KillWordForwards()

Deletes word forwards.

MoveEnd()

Moves cursor to the end of the typed text.

OnDrawingContent(DrawContext?)

Called when the View's content is to be drawn. The default implementation does nothing.

OnGettingAttributeForRole(in VisualRole, ref Attribute)

Called when the Attribute for a GetAttributeForRole(VisualRole) is being retrieved. Implementations can return true to stop further processing and optionally set the Attribute in the event args to a different value.

OnHasFocusChanged(bool, View?, View?)

Invoked after HasFocus has changed. This method is called before the HasFocusChanged event is raised.

OnKeyDown(Key)

Called when the user presses a key, allowing subscribers to pre-process the key down event. Called before key bindings are invoked and KeyDownNotHandled is raised. Set Handled to true to stop the key from being processed further.

OnKeyDownNotHandled(Key)

Called when the user has pressed key it wasn't handled by KeyDown and was not bound to a key binding.

OnMouseEvent(Mouse)

Called when a mouse event occurs within the view's Viewport.

OnSuperViewChanged(ValueChangedEventArgs<View?>)

Called when the SuperView of this View has changed.

Paste()

Paste the selected text from the clipboard.

PositionCursor()

Converts the logical InsertionPoint to screen coordinates and positions the terminal cursor.

RaiseTextChanging(ResultEventArgs<string>)

Raises the TextChanging event, enabling canceling the change or adjusting the text.

Redo()

Redoes the latest changes.

SelectAll()

Selects all text.

Undo()

Undoes the latest changes.

Events

TextChanging

Raised before Text changes. The change can be canceled the text adjusted.

Edit this page