Class TextView

Multi-line text editing View.

Inheritance

object

Responder

View

TextView

Implements

IDisposable

ISupportInitializeNotification

ISupportInitialize

Inherited Members

View.Added

View.Removed

View.Enter

View.Leave

View.MouseEnter

View.MouseLeave

View.MouseClick

View.CanFocusChanged

View.EnabledChanged

View.VisibleChanged

View.HotKeyChanged

View.HotKey

View.HotKeySpecifier

View.Shortcut

View.ShortcutTag

View.ShortcutAction

View.Data

View.Driver

View.Subviews

View.TabIndexes

View.TabIndex

View.TabStop

View.Id

View.IsCurrentTop

View.WantMousePositionReports

View.WantContinuousButtonPressed

View.LayoutStyle

View.Bounds

View.X

View.Y

View.Width

View.Height

View.ForceValidatePosDim

View.GetMinWidthHeight(out Size)

View.SetMinWidthHeight()

View.TextFormatter

View.SuperView

View.UpdateTextFormatterText()

View.ProcessResizeView()

View.SetNeedsDisplay()

View.ClearLayoutNeeded()

View.SetNeedsDisplay(Rect)

View.SetChildNeedsDisplay()

View.Add(View)

View.Add(params View[])

View.RemoveAll()

View.Remove(View)

View.BringSubviewToFront(View)

View.SendSubviewToBack(View)

View.SendSubviewBackwards(View)

View.BringSubviewForward(View)

View.Clear()

View.Clear(Rect)

View.ScreenToView(int, int)

View.ClipToBounds()

View.SetClip(Rect)

View.DrawFrame(Rect, int, bool)

View.DrawHotString(ustring, Attribute, Attribute)

View.DrawHotString(ustring, bool, ColorScheme)

View.Move(int, int, bool)

View.HasFocus

View.OnAdded(View)

View.OnRemoved(View)

View.Focused

View.MostFocused

View.ColorScheme

View.AddRune(int, int, Rune)

View.ClearNeedsDisplay()

View.DrawContent

View.OnDrawContent(Rect)

View.DrawContentComplete

View.OnDrawContentComplete(Rect)

View.SetFocus()

View.KeyPress

View.InvokeKeybindings(KeyEvent)

View.AddKeyBinding(Key, params Command[])

View.ReplaceKeyBinding(Key, Key)

View.ContainsKeyBinding(Key)

View.ClearKeybindings()

View.ClearKeybinding(Key)

View.ClearKeybinding(params Command[])

View.AddCommand(Command, Func<bool?>)

View.GetSupportedCommands()

View.GetKeyFromCommand(params Command[])

View.ProcessHotKey(KeyEvent)

View.ProcessColdKey(KeyEvent)

View.KeyDown

View.OnKeyDown(KeyEvent)

View.KeyUp

View.EnsureFocus()

View.FocusFirst()

View.FocusLast()

View.FocusPrev()

View.FocusNext()

View.LayoutStarted

View.LayoutComplete

View.Initialized

View.LayoutSubviews()

View.AutoSize

View.PreserveTrailingSpaces

View.TextAlignment

View.VerticalTextAlignment

View.TextDirection

View.IsInitialized

View.IsAdded

View.Enabled

View.ClearOnVisibleFalse

View.Visible

View.Border

View.IgnoreBorderPropertyOnRedraw

View.ToString()

View.GetAutoSize()

View.GetHotKeySpecifierLength(bool)

View.GetTextFormatterBoundsSize()

View.GetBoundsTextFormatterSize()

View.OnMouseEnter(MouseEvent)

View.OnMouseLeave(MouseEvent)

View.OnMouseEvent(MouseEvent)

View.OnMouseClick(View.MouseEventArgs)

View.OnCanFocusChanged()

View.OnEnabledChanged()

View.OnVisibleChanged()

View.Dispose(bool)

View.BeginInit()

View.EndInit()

View.SetWidth(int, out int)

View.SetHeight(int, out int)

View.GetCurrentWidth(out int)

View.GetCurrentHeight(out int)

View.GetFocusColor()

View.GetHotNormalColor()

View.GetTopSuperView()

Responder.Dispose()

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

Namespace: Terminal.Gui

Assembly: Terminal.Gui.dll

Syntax

public class TextView : View, IDisposable, ISupportInitializeNotification, ISupportInitialize

Remarks

TextView provides a multi-line text editor. Users interact with it with the standard Windows, Mac, and Linux (Emacs) commands.

Shortcut	Action performed
Left cursor, Control-b	Moves the editing point left.
Right cursor, Control-f	Moves the editing point right.
Alt-b	Moves one word back.
Alt-f	Moves one word forward.
Up cursor, Control-p	Moves the editing point one line up.
Down cursor, Control-n	Moves the editing point one line down
Home key, Control-a	Moves the cursor to the beginning of the line.
End key, Control-e	Moves the cursor to the end of the line.
Control-Home	Scrolls to the first line and moves the cursor there.
Control-End	Scrolls to the last line and moves the cursor there.
Delete, Control-d	Deletes the character in front of the cursor.
Backspace	Deletes the character behind the cursor.
Control-k	Deletes the text until the end of the line and replaces the kill buffer with the deleted text. You can paste this text in a different place by using Control-y.
Control-y	Pastes the content of the kill ring into the current position.
Alt-d	Deletes the word above the cursor and adds it to the kill ring. You can paste the contents of the kill ring with Control-y.
Control-q	Quotes the next input character, to prevent the normal processing of key handling to take place.

Constructors

TextView()

Initializes a TextView on the specified area, with dimensions controlled with the X, Y, Width and Height properties.

Declaration

public TextView()

TextView(Rect)

Initializes a TextView on the specified area, with absolute position and size.

Declaration

public TextView(Rect frame)

Parameters

Type	Name	Description
Rect	frame

Properties

AllowsReturn

Gets or sets a value indicating whether pressing ENTER in a TextView creates a new line of text in the view or activates the default button for the toplevel.

Declaration

public bool AllowsReturn { get; set; }

Property Value

Type	Description
bool

AllowsTab

Gets or sets whether the TextView inserts a tab character into the text or ignores tab input. If set to `false` and the user presses the tab key (or shift-tab) the focus will move to the next view (or previous with shift-tab). The default is `true`; if the user presses the tab key, a tab character will be inserted into the text.

Declaration

public bool AllowsTab { get; set; }

Property Value

Type	Description
bool

Autocomplete

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

Declaration

public IAutocomplete Autocomplete { get; protected set; }

Property Value

Type	Description
IAutocomplete

BottomOffset

The bottom offset needed to use a horizontal scrollbar or for another reason. This is only needed with the keyboard navigation.

Declaration

public int BottomOffset { get; set; }

Property Value

Type	Description
int

CanFocus

Gets or sets a value indicating whether this Responder can focus.

Declaration

public override bool CanFocus { get; set; }

Property Value

Type	Description
bool	true if can focus; otherwise, false.

Overrides

View.CanFocus

ContextMenu

Get the ContextMenu for this view.

Declaration

public ContextMenu ContextMenu { get; }

Property Value

Type	Description
ContextMenu

CurrentColumn

Gets the cursor column.

Declaration

public int CurrentColumn { get; }

Property Value

Type	Description
int	The cursor column.

CurrentRow

Gets the current cursor row.

Declaration

public int CurrentRow { get; }

Property Value

Type	Description
int

CursorPosition

Sets or gets the current cursor position.

Declaration

public Point CursorPosition { get; set; }

Property Value

Type	Description
Point

DesiredCursorVisibility

Get / Set the wished cursor when the field is focused

Declaration

public CursorVisibility DesiredCursorVisibility { get; set; }

Property Value

Type	Description
CursorVisibility

Frame

Gets or sets the frame for the view. The frame is relative to the view's container (SuperView).

Declaration

public override Rect Frame { get; set; }

Property Value

Type	Description
Rect	The frame.

Overrides

View.Frame

Remarks

Change the Frame when using the Absolute layout style to move or resize views.

Altering the Frame of a view will trigger the redrawing of the view as well as the redrawing of the affected regions of the SuperView.

HasHistoryChanges

Indicates whatever the text has history changes or not. true if the text has history changes false otherwise.

Declaration

public bool HasHistoryChanges { get; }

Property Value

Type	Description
bool

IsDirty

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

Declaration

public bool IsDirty { get; }

Property Value

Type	Description
bool

LeftColumn

Gets or sets the left column.

Declaration

public int LeftColumn { get; set; }

Property Value

Type	Description
int

Lines

Gets the number of lines.

Declaration

public int Lines { get; }

Property Value

Type	Description
int

Maxlength

Gets the maximum visible length line.

Declaration

public int Maxlength { get; }

Property Value

Type	Description
int

Multiline

Gets or sets a value indicating whether this TextView is a multiline text view.

Declaration

public bool Multiline { get; set; }

Property Value

Type	Description
bool

ReadOnly

Gets or sets whether the TextView is in read-only mode or not

Declaration

public bool ReadOnly { get; set; }

Property Value

Type	Description
bool	Boolean value(Default false)

RightOffset

The right offset needed to use a vertical scrollbar or for another reason. This is only needed with the keyboard navigation.

Declaration

public int RightOffset { get; set; }

Property Value

Type	Description
int

SelectedLength

Length of the selected text.

Declaration

public int SelectedLength { get; }

Property Value

Type	Description
int

SelectedText

The selected text.

Declaration

public ustring SelectedText { get; }

Property Value

Type	Description
ustring

Selecting

Get or sets the selecting.

Declaration

public bool Selecting { get; set; }

Property Value

Type	Description
bool

SelectionStartColumn

Start column position of the selected text.

Declaration

public int SelectionStartColumn { get; set; }

Property Value

Type	Description
int

SelectionStartRow

Start row position of the selected text.

Declaration

public int SelectionStartRow { get; set; }

Property Value

Type	Description
int

TabWidth

Gets or sets a value indicating the number of whitespace when pressing the TAB key.

Declaration

public int TabWidth { get; set; }

Property Value

Type	Description
int

Text

Sets or gets the text in the TextView.

Declaration

public override ustring Text { get; set; }

Property Value

Type	Description
ustring

Overrides

View.Text

Remarks

The TextChanged event is fired whenever this property is set. Note, however, that Text is not set by TextView as the user types.

TopRow

Gets or sets the top row.

Declaration

public int TopRow { get; set; }

Property Value

Type	Description
int

Used

Tracks whether the text view 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

Declaration

public bool Used { get; set; }

Property Value

Type	Description
bool

WordWrap

Allows word wrap the to fit the available container width.

Declaration

public bool WordWrap { get; set; }

Property Value

Type	Description
bool

Methods

ClearHistoryChanges()

Allows clearing the HistoryText.HistoryTextItem items updating the original text.

Declaration

public void ClearHistoryChanges()

CloseFile()

Closes the contents of the stream into the TextView.

Declaration

public bool CloseFile()

Returns

Type	Description
bool	true, if stream was closed, false otherwise.

Copy()

Copy the selected text to the clipboard contents.

Declaration

public void Copy()

Cut()

Cut the selected text to the clipboard contents.

Declaration

public void Cut()

DeleteAll()

Deletes all text.

Declaration

public void DeleteAll()

DeleteCharLeft()

Deletes all the selected or a single character at left from the position of the cursor.

Declaration

public void DeleteCharLeft()

DeleteCharRight()

Deletes all the selected or a single character at right from the position of the cursor.

Declaration

public void DeleteCharRight()

FindNextText(ustring, out bool, bool, bool, ustring, bool)

Find the next text based on the match case with the option to replace it.

Declaration

public bool FindNextText(ustring textToFind, out bool gaveFullTurn, bool matchCase = false, bool matchWholeWord = false, ustring textToReplace = null, bool replace = false)

Parameters

Type	Name	Description
ustring	textToFind	The text to find.
bool	gaveFullTurn	trueIf all the text was forward searched.falseotherwise.
bool	matchCase	The match case setting.
bool	matchWholeWord	The match whole word setting.
ustring	textToReplace	The text to replace.
bool	replace	trueIf is replacing.falseotherwise.

Returns

Type	Description
bool	trueIf the text was found.falseotherwise.

FindPreviousText(ustring, out bool, bool, bool, ustring, bool)

Find the previous text based on the match case with the option to replace it.

Declaration

public bool FindPreviousText(ustring textToFind, out bool gaveFullTurn, bool matchCase = false, bool matchWholeWord = false, ustring textToReplace = null, bool replace = false)

Parameters

Type	Name	Description
ustring	textToFind	The text to find.
bool	gaveFullTurn	trueIf all the text was backward searched.falseotherwise.
bool	matchCase	The match case setting.
bool	matchWholeWord	The match whole word setting.
ustring	textToReplace	The text to replace.
bool	replace	trueIf the text was found.falseotherwise.

Returns

Type	Description
bool	trueIf the text was found.falseotherwise.

FindTextChanged()

Reset the flag to stop continuous find.

Declaration

public void FindTextChanged()

GetCurrentLine()

Returns the characters on the current line (where the cursor is positioned). Use CurrentColumn to determine the position of the cursor within that line

Declaration

public List<Rune> GetCurrentLine()

Returns

Type	Description
List<Rune>

GetNormalColor()

Determines the current ColorScheme based on the Enabled value.

Declaration

public override Attribute GetNormalColor()

Returns

Type	Description
Attribute	Normal if Enabled is true or Disabled if Enabled is false. If it's overridden can return other values.

Overrides

View.GetNormalColor()

InsertText(string)

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

Declaration

public void InsertText(string toAdd)

Parameters

Type	Name	Description
string	toAdd	Text to add

LoadFile(string)

Loads the contents of the file into the TextView.

Declaration

public bool LoadFile(string path)

Parameters

Type	Name	Description
string	path	Path to the file to load.

Returns

Type	Description
bool	true, if file was loaded, false otherwise.

LoadStream(Stream)

Loads the contents of the stream into the TextView.

Declaration

public void LoadStream(Stream stream)

Parameters

Type	Name	Description
Stream	stream	Stream to load the contents from.

MouseEvent(MouseEvent)

Method invoked when a mouse event is generated

Declaration

public override bool MouseEvent(MouseEvent ev)

Parameters

Type	Name	Description
MouseEvent	ev

Returns

Type	Description
bool	true, if the event was handled, false otherwise.

Overrides

Responder.MouseEvent(MouseEvent)

MoveEnd()

Will scroll the TextView to the last line and position the cursor there.

Declaration

public void MoveEnd()

MoveHome()

Will scroll the TextView to the first line and position the cursor there.

Declaration

public void MoveHome()

OnContentsChanged()

Called when the contents of the TextView change. E.g. when the user types text or deletes text. Raises the ContentsChanged event.

Declaration

public virtual void OnContentsChanged()

OnEnter(View)

Method invoked when a view gets focus.

Declaration

public override bool OnEnter(View view)

Parameters

Type	Name	Description
View	view	The view that is losing focus.

Returns

Type	Description
bool	true, if the event was handled, false otherwise.

Overrides

View.OnEnter(View)

OnKeyUp(KeyEvent)

Method invoked when a key is released.

Declaration

public override bool OnKeyUp(KeyEvent kb)

Parameters

Type	Name	Description
KeyEvent	kb

Returns

Type	Description
bool	true if the event was handled

Overrides

View.OnKeyUp(KeyEvent)

OnLeave(View)

Method invoked when a view loses focus.

Declaration

public override bool OnLeave(View view)

Parameters

Type	Name	Description
View	view	The view that is getting focus.

Returns

Type	Description
bool	true, if the event was handled, false otherwise.

Overrides

View.OnLeave(View)

OnUnwrappedCursorPosition(int?, int?)

Invoke the UnwrappedCursorPosition event with the unwrapped CursorPosition.

Declaration

public virtual void OnUnwrappedCursorPosition(int? cRow = null, int? cCol = null)

Parameters

Type	Name	Description
int?	cRow
int?	cCol

Paste()

Paste the clipboard contents into the current selected position.

Declaration

public void Paste()

PositionCursor()

Positions the cursor on the current row and column

Declaration

public override void PositionCursor()

Overrides

View.PositionCursor()

ProcessKey(KeyEvent)

If the view is focused, gives the view a chance to process the keystroke.

Declaration

public override bool ProcessKey(KeyEvent kb)

Parameters

Type	Name	Description
KeyEvent	kb

Returns

Type	Description
bool

Overrides

View.ProcessKey(KeyEvent)

Remarks

Views can override this method if they are interested in processing the given keystroke. If they consume the keystroke, they must return true to stop the keystroke from being processed by other widgets or consumed by the widget engine. If they return false, the keystroke will be passed using the ProcessColdKey method to other views to process.

The View implementation does nothing but return false, so it is not necessary to call base.ProcessKey if you derive directly from View, but you should if you derive other View subclasses.

Redraw(Rect)

Redraws this view and its subviews; only redraws the views that have been flagged for a re-display.

Declaration

public override void Redraw(Rect bounds)

Parameters

Type	Name	Description
Rect	bounds	The bounds (view-relative region) to redraw.

Overrides

View.Redraw(Rect)

Remarks

Always use Bounds (view-relative) when calling Redraw(Rect), NOT Frame (superview-relative).

Views should set the color that they want to use on entry, as otherwise this will inherit the last color that was set globally on the driver.

Overrides of Redraw(Rect) must ensure they do not set Driver.Clip to a clip region larger than the parameter, as this will cause the driver to clip the entire region.

ReplaceAllText(ustring, bool, bool, ustring)

Replaces all the text based on the match case.

Declaration

public bool ReplaceAllText(ustring textToFind, bool matchCase = false, bool matchWholeWord = false, ustring textToReplace = null)

Parameters

Type	Name	Description
ustring	textToFind	The text to find.
bool	matchCase	The match case setting.
bool	matchWholeWord	The match whole word setting.
ustring	textToReplace	The text to replace.

Returns

Type	Description
bool	trueIf the text was found.falseotherwise.

ScrollTo(int, bool)

Will scroll the TextView to display the specified row at the top if isRow is true or will scroll the TextView to display the specified column at the left if isRow is false.

Declaration

public void ScrollTo(int idx, bool isRow = true)

Parameters

Type	Name	Description
int	idx	Row that should be displayed at the top or Column that should be displayed at the left, if the value is negative it will be reset to zero
bool	isRow	If true (default) the idx is a row, column otherwise.

SelectAll()

Select all text.

Declaration

public void SelectAll()

SetNormalColor()

Sets the driver to the default color for the control where no text is being rendered. Defaults to Normal.

Declaration

protected virtual void SetNormalColor()

SetNormalColor(List<Rune>, int)

Sets the Driver to an appropriate color for rendering the given idx of the current line. Override to provide custom coloring by calling SetAttribute(Attribute) Defaults to Normal.

Declaration

protected virtual void SetNormalColor(List<Rune> line, int idx)

Parameters

Type	Name	Description
List<Rune>	line
int	idx

SetReadOnlyColor(List<Rune>, int)

Sets the Driver to an appropriate color for rendering the given idx of the current line. Override to provide custom coloring by calling SetAttribute(Attribute) Defaults to Focus.

Declaration

protected virtual void SetReadOnlyColor(List<Rune> line, int idx)

Parameters

Type	Name	Description
List<Rune>	line
int	idx

SetSelectionColor(List<Rune>, int)

Sets the Driver to an appropriate color for rendering the given idx of the current line. Override to provide custom coloring by calling SetAttribute(Attribute) Defaults to Focus.

Declaration

protected virtual void SetSelectionColor(List<Rune> line, int idx)

Parameters

Type	Name	Description
List<Rune>	line
int	idx

SetUsedColor(List<Rune>, int)

Sets the Driver to an appropriate color for rendering the given idx of the current line. Override to provide custom coloring by calling SetAttribute(Attribute) Defaults to HotFocus.

Declaration

protected virtual void SetUsedColor(List<Rune> line, int idx)

Parameters

Type	Name	Description
List<Rune>	line
int	idx

Events

ContentsChanged

Raised when the contents of the TextView are changed.

Declaration

public event Action<TextView.ContentsChangedEventArgs> ContentsChanged

Event Type

Type	Description
Action<TextView.ContentsChangedEventArgs>

Remarks

Unlike the TextChanged event, this event is raised whenever the user types or otherwise changes the contents of the TextView.

TextChanged

Raised when the Text property of the TextView changes.

Declaration

public event Action TextChanged

Event Type

Type	Description
Action

Remarks

The Text property of TextView only changes when it is explicitly set, not as the user types. To be notified as the user changes the contents of the TextView see IsDirty.

UnwrappedCursorPosition

Invoked with the unwrapped CursorPosition.

Declaration

public event Action<Point> UnwrappedCursorPosition

Event Type

Type	Description
Action<Point>

Implements

IDisposable

ISupportInitializeNotification

ISupportInitialize