Table of Contents

Class LabelBox

Namespace
RichHudFramework.UI
Assembly
RichHudClient.dll

A composite UI element that renders text over a textured background.

public class LabelBox : LabelBoxBase, IReadOnlyHudElement, IReadOnlyHudNode, IReadOnlyHudParent, ILabelElement, IMinLabelElement
Inheritance
LabelBox
Implements
Derived
Inherited Members

Constructors

LabelBox() 

public LabelBox()

LabelBox(HudParentBase) 

public LabelBox(HudParentBase parent)

Parameters

parent HudParentBase

Fields

textElement

The internal Label element responsible for rendering the text.

public readonly Label textElement

Field Value

Label

Properties

AutoResize

If true, the element will automatically resize to fit the text content.

public override bool AutoResize { get; set; }

Property Value

bool

BuilderMode

Gets or sets the text composition mode, which controls how text is arranged (e.g., single line, wrapped, etc.).

public TextBuilderModes BuilderMode { get; set; }

Property Value

TextBuilderModes

Format

Gets or sets the default glyph formatting (font, style, size, color) applied to text that does not have specific formatting defined.

public GlyphFormat Format { get; set; }

Property Value

GlyphFormat

Text

Gets or sets the rich text content displayed by the label.

public RichText Text { get; set; }

Property Value

RichText

TextBoard

Gets the ITextBoard backing the internal label element.

public ITextBoard TextBoard { get; }

Property Value

ITextBoard

TextPadding

Gets or sets the padding applied to the text element, offsetting it from the edges of the background box.

public override Vector2 TextPadding { get; set; }

Property Value

Vector2

TextSize

Gets or sets the total size of the text element, including the applied TextPadding.

public override Vector2 TextSize { get; set; }

Property Value

Vector2

VertCenterText

If true, the text will be vertically centered relative to the text board's bounds.

public bool VertCenterText { get; set; }

Property Value

bool
Edit this page