Class FormField

A content widget with the visual appearance and behaviour of a form field.

Inheritance
object
Widget
ContentWidget
FormField
Implements
Inherited Members
Namespace: SociallyDistant.Core.UI.Recycling.SettingsWidgets
Assembly: SociallyDistant.Framework.dll
Syntax
public sealed class FormField : ContentWidget, IFontFamilyProvider, IInspectable, IContentWidget, IUpdateThemeProperties, IMouseDownHandler, IMouseUpHandler, IMouseClickHandler, IMouseHandler, IVisual<FormField.VisualState>

Constructors

FormField()

Creates a new instance of the FormField widget.

Declaration
public FormField()

Properties

ClickCallback

Gets or sets a callback to execute when the field is clicked.

Declaration
public Action? ClickCallback { get; set; }
Property Value
Type Description
Action

Content

Declaration
public override Widget? Content { get; set; }
Property Value
Type Description
Widget
Overrides

Description

Gets or sets the description of the field.

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

Title

Gets or sets the field's title.

Declaration
public string Title { 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 FormField.VisualState VisualProperties { get; }
Property Value
Type Description
FormField.VisualState

Methods

OnMouseClick(MouseButtonEvent)

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

OnMouseDown(MouseButtonEvent)

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

OnMouseUp(MouseButtonEvent)

Declaration
public void OnMouseUp(MouseButtonEvent e)
Parameters
Type Name Description
MouseButtonEvent 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()

Implements