Skip to content

UIRichTextLabel Class

Definition

Namespace: Brine2D.UI

A text label that renders markup through ParseMarkup. Use instead of UILabel when you need inline colour, bold/italic, word-wrap, or alignment.

C#
public class UIRichTextLabel : Brine2D.UI.IUIComponent, Brine2D.UI.IAnchoredUIComponent

Inheritance System.Object → UIRichTextLabel

Implements IUIComponent, IAnchoredUIComponent

Constructors
UIRichTextLabel\(string, Vector2\) Creates a rich text label at position.
Properties
Anchor The screen anchor point this component is positioned relative to.
AnchorOffset Pixel offset from the resolved anchor point.
Color Default text colour \(applied where no inline colour tag overrides it\).
Font Font to use for rendering. When null, the renderer's default font is used.
HorizontalAlign Horizontal text alignment within MaxWidth. Only meaningful when MaxWidth is non-zero.
LineSpacing Line spacing multiplier \(1\.0 = normal, 1\.2 = 120% spacing\).
MarkupParser The markup parser to use. When null, the renderer falls back to its default BBCode parser.
MaxHeight Maximum pixel height for vertical alignment. 0 = no constraint.
MaxWidth Maximum pixel width before text wraps. 0 = no wrapping.
ShadowColor Drop-shadow colour. Only used when ShadowOffset is non-null.
ShadowOffset Drop-shadow offset in pixels. Null disables the shadow.
Text Markup text to display. Parsed according to MarkupParser.
VerticalAlign Vertical alignment within MaxHeight. Only meaningful when MaxHeight is non-zero.
Events
OnClick Fired when the label is clicked.