Class TextField

Inheritance
object
Widget
TextField
Implements
Inherited Members
Namespace: Ritchie.Toolbox.Widgets
Assembly: Ritchie.Toolbox.dll
Syntax
public sealed class TextField : Widget, IFontFamilyProvider, IInspectable, IUpdateThemeProperties, IGainFocusHandler, ILoseFocusHandler, IMouseClickHandler, IMouseHandler, IKeyCharHandler, IKeyDownHandler, IVisual<TextField.VisualState>

Constructors

TextField()

Declaration
public TextField()

Properties

HasSelection

Declaration
public bool HasSelection { get; }
Property Value
Type Description
bool

Placeholder

Declaration
public string Placeholder { get; set; }
Property Value
Type Description
string

SelectAllOnFocus

Declaration
public bool SelectAllOnFocus { get; set; }
Property Value
Type Description
bool

UsePasswordMask

Declaration
public bool UsePasswordMask { get; set; }
Property Value
Type Description
bool

Value

Declaration
public string Value { get; }
Property Value
Type Description
string

VisualProperties

Gets a read-only reference to the visual properties associated with the widget.

Declaration
public ref readonly TextField.VisualState VisualProperties { get; }
Property Value
Type Description
TextField.VisualState

Methods

ArrangeChildren(IGuiContext, LayoutRect)

Declaration
protected override void ArrangeChildren(IGuiContext context, LayoutRect availableSpace)
Parameters
Type Name Description
IGuiContext context
LayoutRect availableSpace
Overrides

BeforeRender()

Declaration
protected override void BeforeRender()
Overrides

DeleteSelectionIfAny()

Declaration
public bool DeleteSelectionIfAny()
Returns
Type Description
bool

DeselectAll()

Declaration
public void DeselectAll()

GetContentSize(Point)

Declaration
protected override Point GetContentSize(Point availableSize)
Parameters
Type Name Description
Point availableSize
Returns
Type Description
Point
Overrides

GetSelectionText()

Declaration
public string GetSelectionText()
Returns
Type Description
string

OnFocusGained(FocusEvent)

Declaration
public void OnFocusGained(FocusEvent e)
Parameters
Type Name Description
FocusEvent e

OnFocusLost(FocusEvent)

Declaration
public void OnFocusLost(FocusEvent e)
Parameters
Type Name Description
FocusEvent e

OnKeyChar(KeyCharEvent)

Declaration
public void OnKeyChar(KeyCharEvent e)
Parameters
Type Name Description
KeyCharEvent e

OnKeyDown(KeyEvent)

Declaration
public void OnKeyDown(KeyEvent e)
Parameters
Type Name Description
KeyEvent e

OnMouseClick(MouseButtonEvent)

Declaration
public void OnMouseClick(MouseButtonEvent e)
Parameters
Type Name Description
MouseButtonEvent e

RebuildClippingZone(GeometryHelper)

Declaration
protected override void RebuildClippingZone(GeometryHelper geometry)
Parameters
Type Name Description
GeometryHelper geometry
Overrides

RebuildGeometry(GeometryHelper)

Declaration
protected override void RebuildGeometry(GeometryHelper geometry)
Parameters
Type Name Description
GeometryHelper geometry
Overrides

SelectAll()

Declaration
public void SelectAll()

SetValue(string)

Declaration
public void SetValue(string newValue)
Parameters
Type Name Description
string newValue

UpdateThemeProperties()

Retrieves layout properties from the visual style. Called by the UI system on every frame before layout updates occur. If layout properties change during this method call, the widget will automatically invalidate its own layout.

Declaration
public void UpdateThemeProperties()

Events

OnSubmit

Declaration
public event Action<string>? OnSubmit
Event Type
Type Description
Action<string>

OnValueChanged

Declaration
public event Action<string>? OnValueChanged
Event Type
Type Description
Action<string>

Implements

Extension Methods