Class InputField

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

Constructors

InputField()

Declaration
public InputField()

Properties

MultiLine

Declaration
public bool MultiLine { get; set; }
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

SubmitOnEnter

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

Value

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

VisualProperties

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

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

WordWrapped

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

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

GetContentSize(Point)

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

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

OnKeyUp(KeyEvent)

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

OnMouseClick(MouseButtonEvent)

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

OnMouseEnter(MouseMoveEvent)

Declaration
public void OnMouseEnter(MouseMoveEvent e)
Parameters
Type Name Description
MouseMoveEvent e

OnMouseLeave(MouseMoveEvent)

Declaration
public void OnMouseLeave(MouseMoveEvent e)
Parameters
Type Name Description
MouseMoveEvent e

OnMouseMove(MouseMoveEvent)

Declaration
public void OnMouseMove(MouseMoveEvent e)
Parameters
Type Name Description
MouseMoveEvent e

OnMouseScroll(MouseScrollEvent)

Declaration
public void OnMouseScroll(MouseScrollEvent e)
Parameters
Type Name Description
MouseScrollEvent e

RebuildGeometry(GeometryHelper)

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

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