s&box docs
API ReferenceEditor

TextEditclass

A multi-line text entry. See `Editor.LineEdit` for a single line version.

object→Widget→TextEdit
Namespace
Editor
Assembly
Sandbox.Tools
Declaration
public class Editor.TextEdit : Editor.Widget

Constructors1

Showing 1 constructors

public TextEdit(Editor.Widget parent = null)PUBLICCONSTRUCTOR

ParameterTypeDescription
parent = nullWidget—

Methods15

Showing 15 methods

public void AppendHtml(string html)PUBLIC

ParameterTypeDescription
htmlstring—
Returns:void—

public void AppendPlainText(string text)PUBLIC

ParameterTypeDescription
textstring—
Returns:void—

public void CenterOnCursor()PUBLIC

Returns:void—

public virtual void Clear()PUBLICVIRTUAL

Returns:void—

public string GetAnchorAt(Vector2 point)PUBLIC

ParameterTypeDescription
pointVector2—
Returns:string—

public Editor.TextCursor GetCursorAtBlock(int block)PUBLIC

ParameterTypeDescription
blockint—
Returns:TextCursor—

protected virtual void OnTextChanged(string value)PROTECTEDVIRTUAL

Called when text changed.

ParameterTypeDescription
valuestring—
Returns:void—

public void ScrollToBottom()PUBLIC

Returns:void—

public void SelectAll()PUBLIC

Returns:void—

public void SetTextCursor(Editor.TextCursor cursor)PUBLIC

ParameterTypeDescription
cursorTextCursor—
Returns:void—

Properties16

Showing 16 properties

public bool Editor.TextEdit.BackgroundVisible { get; set; }PUBLICGETSET

Returns:bool—

public bool Editor.TextEdit.CenterOnScroll { get; set; }PUBLICGETSET

Returns:bool—

public bool Editor.TextEdit.Editable { get; set; }PUBLICGETSET

Returns:bool—

public string Editor.TextEdit.Html { get; set; }PUBLICGETSET

Returns:string—

public bool Editor.TextEdit.LinksClickable { get; set; }PUBLICGETSET

Returns:bool—

public int Editor.TextEdit.MaximumBlockCount { get; set; }PUBLICGETSET

Returns:int—

public string Editor.TextEdit.PlaceholderText { get; set; }PUBLICGETSET

Returns:string—

public string Editor.TextEdit.PlainText { get; set; }PUBLICGETSET

Returns:string—

public virtual bool Editor.TextEdit.ReadOnly { get; set; }PUBLICVIRTUALGETSET

Returns:bool—

public float Editor.TextEdit.TabSize { get; set; }PUBLICGETSET

Returns:float—

public bool Editor.TextEdit.TextSelectable { get; set; }PUBLICGETSET

Returns:bool—

SelectBlockUnderCursor()

Previous Page

BackgroundVisible

Next Page

On this page

Constructorspublic TextEdit(Editor.Widget parent = null)Methodspublic System.Void AppendHtml(System.String html)public System.Void AppendPlainText(System.String text)public System.Void CenterOnCursor()public virtual System.Void Clear()public System.String GetAnchorAt(Vector2 point)public Editor.TextCursor GetCursorAtBlock(System.Int32 block)public Editor.TextCursor GetCursorAtPosition(Vector2 position)public Sandbox.Rect GetCursorRect(Editor.TextCursor cursor)public Editor.TextCursor GetTextCursor()protected virtual System.Void OnBlur(Editor.FocusChangeReason reason)protected virtual System.Void OnFocus(Editor.FocusChangeReason reason)protected virtual System.Void OnTextChanged(System.String value)public System.Void ScrollToBottom()public System.Void SelectAll()public System.Void SetTextCursor(Editor.TextCursor cursor)Propertiespublic System.Boolean Editor.TextEdit.BackgroundVisible { get; set; }public System.Boolean Editor.TextEdit.CenterOnScroll { get; set; }public virtual Editor.CursorShape Editor.TextEdit.Cursor { get; set; }public System.Boolean Editor.TextEdit.Editable { get; set; }public Editor.ScrollBar Editor.TextEdit.HorizontalScrollbar { get; set; }public Editor.ScrollbarMode Editor.TextEdit.HorizontalScrollbarMode { get; set; }public System.String Editor.TextEdit.Html { get; set; }public System.Boolean Editor.TextEdit.LinksClickable { get; set; }public System.Int32 Editor.TextEdit.MaximumBlockCount { get; set; }public System.String Editor.TextEdit.PlaceholderText { get; set; }public System.String Editor.TextEdit.PlainText { get; set; }public virtual System.Boolean Editor.TextEdit.ReadOnly { get; set; }public System.Single Editor.TextEdit.TabSize { get; set; }public System.Boolean Editor.TextEdit.TextSelectable { get; set; }public Editor.ScrollBar Editor.TextEdit.VerticalScrollbar { get; set; }public Editor.ScrollbarMode Editor.TextEdit.VerticalScrollbarMode { get; set; }Metadata