TextArea Class

Control for multi-line text

Inheritance Hierarchy

SystemObject
  EtoWidget
    Eto.FormsBindableWidget
      Eto.FormsControl
        Eto.FormsCommonControl
          Eto.FormsTextControl
            Eto.FormsTextArea
              Eto.FormsRichTextArea

Namespace: Eto.Forms
Assembly: Eto (in Eto.dll) Version: 2.5.3-dev

Syntax

public class TextArea : TextControl

Public Class TextArea
	Inherits TextControl

type TextArea =  
    class
        inherit TextControl
    end

The TextArea type exposes the following members.

Constructors

	Name	Description
	TextArea	Initializes a new instance of the TextArea class

Properties

	Name	Description
	AcceptsReturn	Gets or sets a value indicating whether the return key is inserted into the text area, or if it should be ignored by this control.
	AcceptsTab	Gets or sets a value indicating whether the tab key is inserted into the text area, or if it should be ignored by this control and used for navigating to the next control.
	CaretIndex	Gets or sets the index of the insertion caret.
	HorizontalAlign	Obsolete. Gets or sets the horizontal alignment of the text.
	ReadOnly	Gets or sets a value indicating whether this TextArea is read only.
	SelectedText	Gets or sets the selected text.
	Selection	Gets or sets the range of selected text.
	SpellCheck	Gets or sets a value indicating whether this TextArea will perform spell checking.
	SpellCheckIsSupported	Gets a value indicating whether the SpellCheck property is supported on the control's platform.
	SupportedTextReplacements	Gets the text replacements that this control supports on the current platform.
	TextAlignment	Gets or sets the horizontal alignment of the text.
	TextReplacements	Gets or sets a hint value indicating whether this TextArea will automatically correct text.
	Wrap	Gets or sets a value indicating whether text will wrap if lines are longer than the width of the control.

Methods

	Name	Description
	Append	Append the specified text to the control and optionally scrolls to make the inserted text visible.
	GetCallback	Gets an instance of an object used to perform callbacks to the widget from handler implementations (Overrides TextControlGetCallback.)
	OnCaretIndexChanged	Raises the CaretIndexChanged event.
	OnSelectionChanged	Raises the SelectionChanged event.
	SelectAll	Selects all text.

Events

	Name	Description
	CaretIndexChanged	Occurs when the CaretIndex has changed.
	SelectionChanged	Occurs when the Selection is changed.

Fields

	Name	Description
	CaretIndexChangedEvent	Identifier for handlers when attaching the CaretIndexChanged event.
	SelectionChangedEvent	Identifier for handlers when attaching the SelectionChanged event.

Remarks

This differs from the TextBox in that it is used for multi-line text entry and can accept Tab and Enter input.