Label

public Label();

Creates a plain label: empty Text, Left/Top, AutowrapMode = Off, VisibleCharacters = -1, MouseFilter = Ignore, vertical SizeFlags ShrinkCenter.

public TextServer.AutowrapMode AutowrapMode { get; set; }

Wrapping, default Off. WordSmart wraps words and breaks oversized fragments; Arbitrary uses grapheme boundaries. Requires bounded width; configure positive minimum or maximum width for stable layout.

public TextServer.LineBreakFlag AutowrapTrimFlags { get; set; }

Line-edge space trimming, default TrimStartEdgeSpaces | TrimEndEdgeSpaces. Other LineBreakFlag bits are discarded rather than configuring wrapping.

public bool ClipText { get; set; }

Area clipping, default false. Releases natural text minimum width without automatically enabling ellipsis or removing CustomMinimumSize/style margins.

public string EllipsisChar { get; set; }

Trimming character, default …. Use one Unicode character; longer strings warn and truncate to the first. Does not automatically enable TextOverrunBehavior.

public HorizontalAlignment HorizontalAlignment { get; set; }

Left/Center/Right/Fill text alignment inside the area, default Left. Left/Right respect RTL LayoutDirection; Fill uses JustificationFlags. Does not move the Control itself.

public TextServer.JustificationFlag JustificationFlags { get; set; }

Text justification flags for HorizontalAlignment = Fill, including word boundaries, kashida and last-line rules. Do not enable Fill by themselves.

public LabelSettings LabelSettings { get; set; }

Shared styling resource overriding corresponding theme values; null returns styling to the theme. Resource changes invalidate shaping for Labels using it. Missing resource Font can fall back to theme font.

public string Language { get; set; }

Text-shaping language for this Label. Does not change the global TranslationServer locale or select another translation catalog. Check message selection and glyph processing separately.

public int LinesSkipped { get; set; }

Nonnegative number of skipped lines, default 0. Does not remove Text characters; affects drawing window and CharacterBounds.

public int MaxLinesVisible { get; set; }

Displayed-line cap, -1 for unlimited. Not GetLineCount and does not delete Text. Available height can further limit the result.

public int MaximumFontSize { get; set; }

Fitting upper bound, default 60. Does not cap ordinary theme/LabelSettings size while ResizeFontToFit is off. Supply positive maximum ≥ minimum.

public int MinimumFontSize { get; set; }

Fitting lower bound and minimum vertical-size basis, default 10. Validate 1 ≤ minimum ≤ maximum yourself: the setter does not constrain the number.

public string ParagraphSeparator { get; set; }

Paragraph delimiter with c_unescape processing; default \n string means newline. Neither a regular expression nor paragraph spacing.

public bool ResizeFontToFit { get; set; }

Fit font size between MinimumFontSize/MaximumFontSize to area width/height, default false. Can grow or shrink. Trimming remains possible when even minimum size does not fit.

public TextServer.StructuredTextParser StructuredTextBidiOverride { get; set; }

Structured BiDi parser for URIs, file paths and other mixed-direction text. Processes text without opening targets or translating it.

public Reckfell.Collections.Array StructuredTextBidiOverrideOptions { get; set; }

Shared BiDi parser options Array. Alias edits do not invalidate shaping; reassigning the same array can also do nothing. Copy before editing and assign the new version.

public float[] TabStops { get; set; }

Pixel tab-stop positions. C# float[] is copied on get/set; edit a copy and assign it back. Neither space count nor container column sizes.

public string Text { get; set; }

Source text or automatic-translation key. Label retains this source value while its internal display text changes with locale and context. Disable automatic translation for player-supplied text. Assigning the same value does not force translation lookup again.

public Control.TextDirection TextDirection { get; set; }

Text-processing direction, default Auto. Inherited uses Control layout direction. Does not replace LayoutDirection for line placement or GlyphsAuto.

public TextServer.OverrunBehavior TextOverrunBehavior { get; set; }

Trimming when space is insufficient, default NoTrimming. Choose TrimChar/TrimWord or an Ellipsis mode. Does not change source Text; result depends on wrapping, area and visible-line limits.

public bool Uppercase { get; set; }

Uppercase display, default false. Text remains source. Conversion depends on language and can change displayed codepoint count.

public VerticalAlignment VerticalAlignment { get; set; }

Top/Center/Bottom/Fill inside the area, default Top. Does not replace LinesSkipped or change parent Control layout.

public int VisibleCharacters { get; set; }

Reveal position count: -1 for all, otherwise use 0…GetTotalCharacterCount. Not C# char or grapheme count; interpretation depends on VisibleCharactersBehavior. Excess counts are not clamped and can put VisibleRatio above 1.

public TextServer.VisibleCharactersBehavior VisibleCharactersBehavior { get; set; }

Default CharsBeforeShaping cuts input before preparation; CharsAfterShaping keeps full layout. GlyphsAuto/Ltr/Rtl reveal directional glyphs rather than whole user-perceived text elements.

public float VisibleRatio { get; set; }

Reveal fraction, default 1. A changed fraction ≥1 shows all, negative gives 0, intermediate fractions floor position count. If VisibleCharacters already produced the same out-of-range ratio, reassignment does not normalize it. Supply finite 0…1 values.

public TextServer.AutowrapMode GetAutowrapMode();

Wrapping, default Off. WordSmart wraps words and breaks oversized fragments; Arbitrary uses grapheme boundaries. Requires bounded width; configure positive minimum or maximum width for stable layout.

public TextServer.LineBreakFlag GetAutowrapTrimFlags();

Line-edge space trimming, default TrimStartEdgeSpaces | TrimEndEdgeSpaces. Other LineBreakFlag bits are discarded rather than configuring wrapping.

public Rect2 GetCharacterBounds(int pos);

Local cluster-advance rectangle for a codepoint position. Accounts for layout and skipped lines; multiple positions can share a box. Empty Rect2 means no corresponding box rather than necessarily an error. Not tight pixel bounds.

public string GetEllipsisChar();

Trimming character, default …. Use one Unicode character; longer strings warn and truncate to the first. Does not automatically enable TextOverrunBehavior.

public HorizontalAlignment GetHorizontalAlignment();

Left/Center/Right/Fill text alignment inside the area, default Left. Left/Right respect RTL LayoutDirection; Fill uses JustificationFlags. Does not move the Control itself.

public TextServer.JustificationFlag GetJustificationFlags();

Text justification flags for HorizontalAlignment = Fill, including word boundaries, kashida and last-line rules. Do not enable Fill by themselves.

public LabelSettings GetLabelSettings();

Shared styling resource overriding corresponding theme values; null returns styling to the theme. Resource changes invalidate shaping for Labels using it. Missing resource Font can fall back to theme font.

public string GetLanguage();

Shaping/case-conversion language; empty uses Control locale. Does not switch application locale or make GetText return translation.

public int GetLineCount();

Shapes text if needed and returns total wrapped-line count. Returns 1 outside the tree. Before-shaping reveal affects it; it is not the visible-on-screen line count.

public int GetLineHeight(int line = -1);

Prepared line height in pixels. -1 or an out-of-range index returns maximum line/font height rather than an error. Prepare layout through GetLineCount before measuring.

public int GetLinesSkipped();

Nonnegative number of skipped lines, default 0. Does not remove Text characters; affects drawing window and CharacterBounds.

public int GetMaxLinesVisible();

Displayed-line cap, -1 for unlimited. Not GetLineCount and does not delete Text. Available height can further limit the result.

public int GetMaximumFontSize();

Fitting upper bound, default 60. Does not cap ordinary theme/LabelSettings size while ResizeFontToFit is off. Supply positive maximum ≥ minimum.

public int GetMinimumFontSize();

Fitting lower bound and minimum vertical-size basis, default 10. Validate 1 ≤ minimum ≤ maximum yourself: the setter does not constrain the number.

public string GetParagraphSeparator();

Paragraph delimiter with c_unescape processing; default \n string means newline. Neither a regular expression nor paragraph spacing.

public int GetRenderedFontSize();

Last calculated font size or base size. Getter does not run new fitting: call GetLineCount/GetMinimumSize after area/setting changes first.

public TextServer.StructuredTextParser GetStructuredTextBidiOverride();

Structured BiDi parser for URIs, file paths and other mixed-direction text. Processes text without opening targets or translating it.

public Reckfell.Collections.Array GetStructuredTextBidiOverrideOptions();

Shared BiDi parser options Array. Alias edits do not invalidate shaping; reassigning the same array can also do nothing. Copy before editing and assign the new version.

public float[] GetTabStops();

Pixel tab-stop positions. C# float[] is copied on get/set; edit a copy and assign it back. Neither space count nor container column sizes.

public string GetText();

Source plain text rather than BBCode. Getter returns source while character counts use translated text. Replacing text with partial VisibleRatio recalculates VisibleCharacters from that fraction.

public Control.TextDirection GetTextDirection();

Text-processing direction, default Auto. Inherited uses Control layout direction. Does not replace LayoutDirection for line placement or GlyphsAuto.

public TextServer.OverrunBehavior GetTextOverrunBehavior();

Trimming when space is insufficient, default NoTrimming. Choose TrimChar/TrimWord or an Ellipsis mode. Does not change source Text; result depends on wrapping, area and visible-line limits.

public int GetTotalCharacterCount();

Returns the length of the Label’s internal translated text. Can differ from the length of Text, which retains the source key. This is not a rendered glyph count or a test for clipping.

public VerticalAlignment GetVerticalAlignment();

Top/Center/Bottom/Fill inside the area, default Top. Does not replace LinesSkipped or change parent Control layout.

public int GetVisibleCharacters();

Reveal position count: -1 for all, otherwise use 0…GetTotalCharacterCount. Not C# char or grapheme count; interpretation depends on VisibleCharactersBehavior. Excess counts are not clamped and can put VisibleRatio above 1.

public TextServer.VisibleCharactersBehavior GetVisibleCharactersBehavior();

Default CharsBeforeShaping cuts input before preparation; CharsAfterShaping keeps full layout. GlyphsAuto/Ltr/Rtl reveal directional glyphs rather than whole user-perceived text elements.

public int GetVisibleLineCount();

Counts fitting prepared-layout lines subject to LinesSkipped/MaxLinesVisible and height. Does not itself shape: call GetLineCount/GetMinimumSize after changes first. Not a count of actually revealed glyphs.

public float GetVisibleRatio();

Reveal fraction, default 1. A changed fraction ≥1 shows all, negative gives 0, intermediate fractions floor position count. If VisibleCharacters already produced the same out-of-range ratio, reassignment does not normalize it. Supply finite 0…1 values.

public bool IsClippingText();

Area clipping, default false. Releases natural text minimum width without automatically enabling ellipsis or removing CustomMinimumSize/style margins.

public bool IsResizeFontToFitEnabled();

Fit font size between MinimumFontSize/MaximumFontSize to area width/height, default false. Can grow or shrink. Trimming remains possible when even minimum size does not fit.

public bool IsUppercase();

Uppercase display, default false. Text remains source. Conversion depends on language and can change displayed codepoint count.

public void SetAutowrapMode(TextServer.AutowrapMode autowrapMode);

Wrapping, default Off. WordSmart wraps words and breaks oversized fragments; Arbitrary uses grapheme boundaries. Requires bounded width; configure positive minimum or maximum width for stable layout.

public void SetAutowrapTrimFlags(TextServer.LineBreakFlag autowrapTrimFlags);

Line-edge space trimming, default TrimStartEdgeSpaces | TrimEndEdgeSpaces. Other LineBreakFlag bits are discarded rather than configuring wrapping.

public void SetClipText(bool enable);

Area clipping, default false. Releases natural text minimum width without automatically enabling ellipsis or removing CustomMinimumSize/style margins.

public void SetEllipsisChar(string @char);

Trimming character, default …. Use one Unicode character; longer strings warn and truncate to the first. Does not automatically enable TextOverrunBehavior.

public void SetHorizontalAlignment(HorizontalAlignment alignment);

Left/Center/Right/Fill text alignment inside the area, default Left. Left/Right respect RTL LayoutDirection; Fill uses JustificationFlags. Does not move the Control itself.

public void SetJustificationFlags(TextServer.JustificationFlag justificationFlags);

Text justification flags for HorizontalAlignment = Fill, including word boundaries, kashida and last-line rules. Do not enable Fill by themselves.

public void SetLabelSettings(LabelSettings settings);

Shared styling resource overriding corresponding theme values; null returns styling to the theme. Resource changes invalidate shaping for Labels using it. Missing resource Font can fall back to theme font.

public void SetLanguage(string language);

Shaping/case-conversion language; empty uses Control locale. Does not switch application locale or make GetText return translation.

public void SetLinesSkipped(int linesSkipped);

Nonnegative number of skipped lines, default 0. Does not remove Text characters; affects drawing window and CharacterBounds.

public void SetMaxLinesVisible(int linesVisible);

Displayed-line cap, -1 for unlimited. Not GetLineCount and does not delete Text. Available height can further limit the result.

public void SetMaximumFontSize(int size);

Fitting upper bound, default 60. Does not cap ordinary theme/LabelSettings size while ResizeFontToFit is off. Supply positive maximum ≥ minimum.

public void SetMinimumFontSize(int size);

Fitting lower bound and minimum vertical-size basis, default 10. Validate 1 ≤ minimum ≤ maximum yourself: the setter does not constrain the number.

public void SetParagraphSeparator(string paragraphSeparator);

Paragraph delimiter with c_unescape processing; default \n string means newline. Neither a regular expression nor paragraph spacing.

public void SetResizeFontToFit(bool enabled);

Fit font size between MinimumFontSize/MaximumFontSize to area width/height, default false. Can grow or shrink. Trimming remains possible when even minimum size does not fit.

public void SetStructuredTextBidiOverride(TextServer.StructuredTextParser parser);

Structured BiDi parser for URIs, file paths and other mixed-direction text. Processes text without opening targets or translating it.

public void SetStructuredTextBidiOverrideOptions(Reckfell.Collections.Array args);

Shared BiDi parser options Array. Alias edits do not invalidate shaping; reassigning the same array can also do nothing. Copy before editing and assign the new version.

public void SetTabStops(ReadOnlySpan<float> tabStops);

Pixel tab-stop positions. C# float[] is copied on get/set; edit a copy and assign it back. Neither space count nor container column sizes.

public void SetTabStops(float[] tabStops);

Pixel tab-stop positions. C# float[] is copied on get/set; edit a copy and assign it back. Neither space count nor container column sizes.

public void SetText(string text);

Source plain text rather than BBCode. Getter returns source while character counts use translated text. Replacing text with partial VisibleRatio recalculates VisibleCharacters from that fraction.

public void SetTextDirection(Control.TextDirection direction);

Text-processing direction, default Auto. Inherited uses Control layout direction. Does not replace LayoutDirection for line placement or GlyphsAuto.

public void SetTextOverrunBehavior(TextServer.OverrunBehavior overrunBehavior);

Trimming when space is insufficient, default NoTrimming. Choose TrimChar/TrimWord or an Ellipsis mode. Does not change source Text; result depends on wrapping, area and visible-line limits.

public void SetUppercase(bool enable);

Uppercase display, default false. Text remains source. Conversion depends on language and can change displayed codepoint count.

public void SetVerticalAlignment(VerticalAlignment alignment);

Top/Center/Bottom/Fill inside the area, default Top. Does not replace LinesSkipped or change parent Control layout.

public void SetVisibleCharacters(int amount);

Reveal position count: -1 for all, otherwise use 0…GetTotalCharacterCount. Not C# char or grapheme count; interpretation depends on VisibleCharactersBehavior. Excess counts are not clamped and can put VisibleRatio above 1.

public void SetVisibleCharactersBehavior(TextServer.VisibleCharactersBehavior behavior);

Default CharsBeforeShaping cuts input before preparation; CharsAfterShaping keeps full layout. GlyphsAuto/Ltr/Rtl reveal directional glyphs rather than whole user-perceived text elements.

public void SetVisibleRatio(float ratio);

Reveal fraction, default 1. A changed fraction ≥1 shows all, negative gives 0, intermediate fractions floor position count. If VisibleCharacters already produced the same out-of-range ratio, reassignment does not normalize it. Supply finite 0…1 values.