s&box docs
API ReferenceSandbox.UI

TextEntryclass

object→BaseControl→TextEntry
Namespace
Sandbox.UI
Assembly
Base Library
Declaration
public class Sandbox.UI.TextEntry : Sandbox.UI.BaseControl

Constructors1

Showing 1 constructors

Methods29

Showing 29 methods

public void AddToHistory(string str)PUBLIC

ParameterTypeDescription
strstring—
Returns:void—

protected virtual void AutoCompleteCancel()PROTECTEDVIRTUAL

Returns:void—

protected virtual void AutoCompleteSelectionChanged()PROTECTEDVIRTUAL

Returns:void—

public virtual bool CanEnterCharacter(char c)PUBLICVIRTUAL

ParameterTypeDescription
cchar—
Returns:bool—

public void ClearHistory()PUBLIC

Returns:void—

public virtual void DestroyAutoComplete()PUBLICVIRTUAL

Returns:void—

public virtual string FixNumeric()PUBLICVIRTUAL

Returns:string—

public virtual string GetClipboardValue(bool cut)PUBLICVIRTUAL

ParameterTypeDescription
cutbool—
Returns:string—

protected virtual bool IsPanelEmpty()PROTECTEDVIRTUAL

Returns:bool—

protected virtual void OnBlur(Sandbox.UI.PanelEvent e)PROTECTEDVIRTUAL

ParameterTypeDescription
ePanelEvent—
Returns:void—

public virtual void OnButtonEvent(Sandbox.UI.ButtonEvent e)PUBLICVIRTUAL

ParameterTypeDescription
eButtonEvent—
Returns:void—

public virtual void OnButtonTyped(Sandbox.UI.ButtonEvent e)PUBLICVIRTUAL

ParameterTypeDescription
eButtonEvent—
Returns:void—

public virtual void OnDraw()PUBLICVIRTUAL

Returns:void—

protected virtual void OnEscape(Sandbox.UI.PanelEvent e)PROTECTEDVIRTUAL

ParameterTypeDescription
ePanelEvent—
Returns:void—

protected virtual void OnEvent(Sandbox.UI.PanelEvent e)PROTECTEDVIRTUAL

ParameterTypeDescription
ePanelEvent—
Returns:void—

protected virtual void OnFocus(Sandbox.UI.PanelEvent e)PROTECTEDVIRTUAL

ParameterTypeDescription
ePanelEvent—
Returns:void—

public virtual void OnKeyTyped(char k)PUBLICVIRTUAL

ParameterTypeDescription
kchar—
Returns:void—

public virtual void OnPaste(string text)PUBLICVIRTUAL

ParameterTypeDescription
textstring—
Returns:void—

public virtual void OnValueChanged()PUBLICVIRTUAL

Returns:void—

public virtual void SetProperty(string name, string value)PUBLICVIRTUAL

ParameterTypeDescription
namestring—
valuestring—
Returns:void—

public virtual void Tick()PUBLICVIRTUAL

Returns:void—

public void UpdateValidation()PUBLICPER-FRAME

Returns:void—

Properties32

Showing 32 properties

public virtual bool Sandbox.UI.TextEntry.AcceptsImeInput { get; set; }PUBLICVIRTUALGETSETINGEST

Returns:bool—

public bool Sandbox.UI.TextEntry.AllowEmojiReplace { get; set; }PUBLICGETSET

Returns:bool—

public System.Func`2<string,object[]> Sandbox.UI.TextEntry.AutoComplete { get; set; }PUBLICGETSET

Returns:Func<string,object[]>—

public int Sandbox.UI.TextEntry.CaretPosition { get; set; }PUBLICGETSET

Returns:int—

public string Sandbox.UI.TextEntry.CharacterRegex { get; set; }PUBLICGETSET

Returns:string—

public bool Sandbox.UI.TextEntry.Disabled { get; set; }PUBLICGETSET

Returns:bool—

public bool Sandbox.UI.TextEntry.HasClearButton { get; set; }PUBLICGETSET

Returns:bool—

public bool Sandbox.UI.TextEntry.HasValidationErrors { get; set; }PUBLICGETSET

Returns:bool—

public string Sandbox.UI.TextEntry.HistoryCookie { get; set; }PUBLICGETSET

Returns:string—

public int Sandbox.UI.TextEntry.HistoryMaxItems { get; set; }PUBLICGETSET

Returns:int—

public string Sandbox.UI.TextEntry.Icon { get; set; }PUBLICGETSET

Returns:string—

protected Sandbox.UI.Label Sandbox.UI.TextEntry.Label { get; set; }PROTECTEDGETSET

Returns:Label—

public System.Nullable`1<int> Sandbox.UI.TextEntry.MaxLength { get; set; }PUBLICGETSET

Returns:Nullable<int>—

public System.Nullable`1<float> Sandbox.UI.TextEntry.MaxValue { get; set; }PUBLICGETSET

Returns:Nullable<float>—

public System.Nullable`1<int> Sandbox.UI.TextEntry.MinLength { get; set; }PUBLICGETSET

Returns:Nullable<int>—

public System.Nullable`1<float> Sandbox.UI.TextEntry.MinValue { get; set; }PUBLICGETSET

Returns:Nullable<float>—

public bool Sandbox.UI.TextEntry.Multiline { get; set; }PUBLICGETSET

Returns:bool—

public string Sandbox.UI.TextEntry.NumberFormat { get; set; }PUBLICGETSET

Returns:string—

public bool Sandbox.UI.TextEntry.Numeric { get; set; }PUBLICGETSET

Returns:bool—

public System.Action`1<string> Sandbox.UI.TextEntry.OnTextEdited { get; set; }PUBLICGETSET

Returns:Action<string>—

public string Sandbox.UI.TextEntry.Placeholder { get; set; }PUBLICGETSET

Returns:string—

public string Sandbox.UI.TextEntry.Prefix { get; set; }PUBLICGETSET

Returns:string—

public Sandbox.UI.Label Sandbox.UI.TextEntry.PrefixLabel { get; set; }PUBLICGETSET

Returns:Label—

public string Sandbox.UI.TextEntry.StringRegex { get; set; }PUBLICGETSET

Returns:string—

public string Sandbox.UI.TextEntry.Suffix { get; set; }PUBLICGETSET

Returns:string—

public Sandbox.UI.Label Sandbox.UI.TextEntry.SuffixLabel { get; set; }PUBLICGETSET

Returns:Label—

public virtual bool Sandbox.UI.TextEntry.SupportsMultiEdit { get; set; }PUBLICVIRTUALGETSET

Returns:bool—

public string Sandbox.UI.TextEntry.Text { get; set; }PUBLICGETSET

Returns:string—

public int Sandbox.UI.TextEntry.TextLength { get; set; }PUBLICGETSET

Returns:int—

public string Sandbox.UI.TextEntry.Value { get; set; }PUBLICGETSET

Returns:string—

TextDecorationStyle

Previous Page

AcceptsImeInput

Next Page

On this page

Constructorspublic TextEntry()Methodspublic System.Void AddToHistory(System.String str)protected virtual System.Void AutoCompleteCancel()protected virtual System.Void AutoCompleteSelectionChanged()public virtual System.Boolean CanEnterCharacter(System.Char c)public System.Void ClearHistory()public virtual System.Void DestroyAutoComplete()public virtual System.String FixNumeric()public virtual System.String GetClipboardValue(System.Boolean cut)protected virtual System.Boolean IsPanelEmpty()protected virtual System.Void OnBlur(Sandbox.UI.PanelEvent e)public virtual System.Void OnButtonEvent(Sandbox.UI.ButtonEvent e)public virtual System.Void OnButtonTyped(Sandbox.UI.ButtonEvent e)protected virtual System.Void OnDoubleClick(Sandbox.UI.MousePanelEvent e)protected virtual System.Void OnDragSelect(Sandbox.UI.SelectionEvent e)public virtual System.Void OnDraw()protected virtual System.Void OnEscape(Sandbox.UI.PanelEvent e)protected virtual System.Void OnEvent(Sandbox.UI.PanelEvent e)protected virtual System.Void OnFocus(Sandbox.UI.PanelEvent e)public virtual System.Void OnKeyTyped(System.Char k)protected virtual System.Void OnMouseDown(Sandbox.UI.MousePanelEvent e)protected virtual System.Void OnMouseMove(Sandbox.UI.MousePanelEvent e)protected virtual System.Void OnMouseUp(Sandbox.UI.MousePanelEvent e)public virtual System.Void OnPaste(System.String text)public virtual System.Void OnValueChanged()public virtual System.Void SetProperty(System.String name, System.String value)public virtual System.Void Tick()public System.Void UpdateAutoComplete()public System.Void UpdateAutoComplete(System.Object[] options)public System.Void UpdateValidation()Propertiespublic virtual System.Boolean Sandbox.UI.TextEntry.AcceptsImeInput { get; set; }public System.Boolean Sandbox.UI.TextEntry.AllowEmojiReplace { get; set; }public System.Func`2<System.String,System.Object[]> Sandbox.UI.TextEntry.AutoComplete { get; set; }public System.Int32 Sandbox.UI.TextEntry.CaretPosition { get; set; }public System.String Sandbox.UI.TextEntry.CharacterRegex { get; set; }public System.Boolean Sandbox.UI.TextEntry.Disabled { get; set; }public System.Boolean Sandbox.UI.TextEntry.HasClearButton { get; set; }public System.Boolean Sandbox.UI.TextEntry.HasValidationErrors { get; set; }public System.String Sandbox.UI.TextEntry.HistoryCookie { get; set; }public System.Int32 Sandbox.UI.TextEntry.HistoryMaxItems { get; set; }public System.String Sandbox.UI.TextEntry.Icon { get; set; }public Sandbox.UI.IconPanel Sandbox.UI.TextEntry.IconPanel { get; set; }protected Sandbox.UI.Label Sandbox.UI.TextEntry.Label { get; set; }public System.Nullable`1<System.Int32> Sandbox.UI.TextEntry.MaxLength { get; set; }public System.Nullable`1<System.Single> Sandbox.UI.TextEntry.MaxValue { get; set; }public System.Nullable`1<System.Int32> Sandbox.UI.TextEntry.MinLength { get; set; }public System.Nullable`1<System.Single> Sandbox.UI.TextEntry.MinValue { get; set; }public System.Boolean Sandbox.UI.TextEntry.Multiline { get; set; }public System.String Sandbox.UI.TextEntry.NumberFormat { get; set; }public System.Boolean Sandbox.UI.TextEntry.Numeric { get; set; }public System.Action`1<System.String> Sandbox.UI.TextEntry.OnTextEdited { get; set; }public System.String Sandbox.UI.TextEntry.Placeholder { get; set; }public System.String Sandbox.UI.TextEntry.Prefix { get; set; }public Sandbox.UI.Label Sandbox.UI.TextEntry.PrefixLabel { get; set; }public Color Sandbox.UI.TextEntry.SelectionColor { get; set; }public System.String Sandbox.UI.TextEntry.StringRegex { get; set; }public System.String Sandbox.UI.TextEntry.Suffix { get; set; }public Sandbox.UI.Label Sandbox.UI.TextEntry.SuffixLabel { get; set; }public virtual System.Boolean Sandbox.UI.TextEntry.SupportsMultiEdit { get; set; }public System.String Sandbox.UI.TextEntry.Text { get; set; }public System.Int32 Sandbox.UI.TextEntry.TextLength { get; set; }public System.String Sandbox.UI.TextEntry.Value { get; set; }Metadata