Class TextWidget

Inheritance
object
Widget
TextWidget
Implements
Inherited Members
Namespace: Ritchie.Toolbox.Widgets
Assembly: Ritchie.Toolbox.dll
Syntax
public class TextWidget : Widget, IFontFamilyProvider, IInspectable, IMouseClickHandler, IMouseHandler, IUpdateThemeProperties, 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

AllowEmoji

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

CharacterSpacing

Declaration
public float CharacterSpacing { get; set; }
Property Value
Type Description
float

FontFamily

Declaration
public FontFamilyInfo FontFamily { get; set; }
Property Value
Type Description
FontFamilyInfo

FontSize

Declaration
public int FontSize { get; set; }
Property Value
Type Description
int

FontWeight

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

HasSelection

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

ImageLocator

Gets or sets a reference to an object implementing IImageLocator for retrieving images in TextWidget markup. Changing this property does not automatically tell extisting text widgets to re-render, you must do that yourself.

Declaration
public static IImageLocator? ImageLocator { get; set; }
Property Value
Type Description
IImageLocator

ShowMarkup

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

Text

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

TextAlignment

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

TextColor

Declaration
public Color TextColor { get; }
Property Value
Type Description
Color

TextColorOverride

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

TextTransform

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

UseMarkup

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

WordWrapping

Declaration
public bool WordWrapping { 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

GetLineAtIndex(int)

Declaration
public int GetLineAtIndex(int characterIndex)
Parameters
Type Name Description
int characterIndex
Returns
Type Description
int

GetLineCount()

Declaration
public int GetLineCount()
Returns
Type Description
int

GetLineLength(int)

Declaration
public int GetLineLength(int line)
Parameters
Type Name Description
int line
Returns
Type Description
int

GetLineStart(int)

Declaration
public int GetLineStart(int line)
Parameters
Type Name Description
int line
Returns
Type Description
int

GetLineStartElement(int)

Declaration
public int GetLineStartElement(int line)
Parameters
Type Name Description
int line
Returns
Type Description
int

GetPositionOfCharacter(int)

Declaration
public LayoutRect GetPositionOfCharacter(int characterIndex)
Parameters
Type Name Description
int characterIndex
Returns
Type Description
LayoutRect

Inspect(IInspector)

Declaration
public override void Inspect(IInspector inspector)
Parameters
Type Name Description
IInspector inspector
Overrides

OnMouseClick(MouseButtonEvent)

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

RebuildGeometry(GeometryHelper)

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

SelectAll()

Declaration
public void SelectAll()

SelectNone()

Declaration
public void SelectNone()

SetSelection(int, int)

Declaration
public void SetSelection(int start, int count)
Parameters
Type Name Description
int start
int count

TryFindLink(Point, out string?)

Declaration
public bool TryFindLink(Point position, out string? linkId)
Parameters
Type Name Description
Point position
string linkId
Returns
Type Description
bool

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

LinkClicked

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

Implements

Extension Methods