s&box docs
API ReferenceEditor

StringControlWidgetclass

object→ControlWidget→StringControlWidget
Namespace
Editor
Assembly
Sandbox.Tools
Declaration
public class Editor.StringControlWidget : Editor.ControlWidget

Constructors1

Showing 1 constructors

Methods9

Showing 9 methods

protected virtual void DoLayout()PROTECTEDVIRTUAL

Returns:void—

public virtual void FromClipboardString(string clipboard)PUBLICVIRTUAL

ParameterTypeDescription
clipboardstring—
Returns:void—

public virtual void OnDestroyed()PUBLICVIRTUALLIFECYCLE

Returns:void—

protected virtual void OnMultipleDifferentValues(bool state)PROTECTEDVIRTUAL

Change text to pink if we're editing multiple values, and they differ

ParameterTypeDescription
statebool—
Returns:void—

protected virtual void OnValueChanged()PROTECTEDVIRTUAL

Returns:void—

public virtual void StartEditing()PUBLICVIRTUAL

Returns:void—

protected virtual object StringToValue(string text)PROTECTEDVIRTUAL

ParameterTypeDescription
textstring—
Returns:object—

public virtual string ToClipboardString()PUBLICVIRTUAL

Returns:string—

protected virtual string ValueToString()PROTECTEDVIRTUAL

Returns:string—

Properties5

Showing 5 properties

public virtual bool Editor.StringControlWidget.IsControlActive { get; set; }PUBLICVIRTUALGETSET

Returns:bool—

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

Returns:bool—

public string Editor.StringControlWidget.RegexValidator { get; set; }PUBLICGETSET

Allow overriding the regex validator on `Editor.StringControlWidget.LineEdit`.

Returns:string—

public virtual bool Editor.StringControlWidget.SupportsMultiEdit { get; set; }PUBLICVIRTUALGETSET

Returns:bool—

StatusBar.ctor()

Previous Page

CellAlignment

Next Page

On this page

Constructorspublic StringControlWidget(Sandbox.SerializedProperty property)Methodsprotected virtual System.Void DoLayout()public virtual System.Void FromClipboardString(System.String clipboard)public virtual System.Void OnDestroyed()protected virtual System.Void OnMultipleDifferentValues(System.Boolean state)protected virtual System.Void OnValueChanged()public virtual System.Void StartEditing()protected virtual System.Object StringToValue(System.String text)public virtual System.String ToClipboardString()protected virtual System.String ValueToString()Propertiespublic virtual Sandbox.TextFlag Editor.StringControlWidget.CellAlignment { get; set; }public virtual System.Boolean Editor.StringControlWidget.IsControlActive { get; set; }public virtual System.Boolean Editor.StringControlWidget.ReadOnly { get; set; }public System.String Editor.StringControlWidget.RegexValidator { get; set; }public virtual System.Boolean Editor.StringControlWidget.SupportsMultiEdit { get; set; }Metadata