Class Toggle

Inheritance
object
Widget
Toggle
Implements
Inherited Members
Namespace: Ritchie.Toolbox.Widgets
Assembly: Ritchie.Toolbox.dll
Syntax
public sealed class Toggle : Widget, IFontFamilyProvider, IInspectable, IMouseEnterHandler, IMouseLeaveHandler, IGainFocusHandler, ILoseFocusHandler, IMouseDownHandler, IMouseUpHandler, IMouseClickHandler, IMouseHandler, IUpdateThemeProperties, IVisual<Toggle.VisualState>, IAccessibleDescription

Properties

AccessibleContent

Gets a string of text representing the widget's content, in a screen-reader-friendly format.

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

ToggleValue

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

UseSwitchVariant

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

VisualProperties

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

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

Methods

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

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

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

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()

Events

OnBeforeValueChanged

Declaration
public event Action<StateChange<bool>>? OnBeforeValueChanged
Event Type
Type Description
Action<StateChange<bool>>

OnValueChanged

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

Implements

Extension Methods