Class Label

Namespace
Forma
Assembly
Forma.dll

Displays shaped text with alignment, wrapping, trimming, casing, and visible-character controls.

public class Label : Control, IAddChild<Control>, IAddChild, INotifyPropertyChanged
Inheritance
Label
Implements
Derived
Inherited Members

Constructors

Label() 

public Label()

Properties

Autowrap

Legacy convenience switch; true maps to Godot's WordSmart mode.

public bool Autowrap { get; set; }

Property Value

bool

AutowrapMode 

public LabelAutowrapMode AutowrapMode { get; set; }

Property Value

LabelAutowrapMode

ClipText 

public bool ClipText { get; set; }

Property Value

bool

EllipsisCharacter 

public string EllipsisCharacter { get; set; }

Property Value

string

Font 

public SpriteFont Font { get; set; }

Property Value

SpriteFont

FontColor 

public Color? FontColor { get; set; }

Property Value

Color?

HorizontalAlignment 

public HorizontalAlignment HorizontalAlignment { get; set; }

Property Value

HorizontalAlignment

JustificationFlags 

public LabelJustificationFlags JustificationFlags { get; set; }

Property Value

LabelJustificationFlags

LinesSkipped 

public int LinesSkipped { get; set; }

Property Value

int

MaxLinesVisible 

public int MaxLinesVisible { get; set; }

Property Value

int

Padding 

public Thickness Padding { get; set; }

Property Value

Thickness

ParagraphSeparator 

public string ParagraphSeparator { get; set; }

Property Value

string

ParagraphSpacing 

public float ParagraphSpacing { get; set; }

Property Value

float

StructuredTextBidiOverride 

public StructuredTextParser StructuredTextBidiOverride { get; set; }

Property Value

StructuredTextParser

Text 

public string Text { get; set; }

Property Value

string

TextDirection 

public TextDirection TextDirection { get; set; }

Property Value

TextDirection

TextOverrunBehavior 

public LabelTextOverrunBehavior TextOverrunBehavior { get; set; }

Property Value

LabelTextOverrunBehavior

UIFont 

public UIFont UIFont { get; set; }

Property Value

UIFont

Uppercase 

public bool Uppercase { get; set; }

Property Value

bool

VerticalAlignment 

public VerticalAlignment VerticalAlignment { get; set; }

Property Value

VerticalAlignment

VisibleCharacters 

public int VisibleCharacters { get; set; }

Property Value

int

VisibleCharactersBehavior 

public LabelVisibleCharactersBehavior VisibleCharactersBehavior { get; set; }

Property Value

LabelVisibleCharactersBehavior

VisibleRatio 

public float VisibleRatio { get; set; }

Property Value

float

Methods

AdjustTextLayout(TextLayout) 

protected virtual TextLayout AdjustTextLayout(TextLayout layout)

Parameters

layout TextLayout

Returns

TextLayout

DrawLabelChildren(UIRenderContext)

Draws retained child controls after the label's text.

protected void DrawLabelChildren(UIRenderContext context)

Parameters

context UIRenderContext

DrawLabelText(UIRenderContext)

Draws this label's text. Rich-text derived controls can replace this while retaining child rendering.

protected virtual void DrawLabelText(UIRenderContext context)

Parameters

context UIRenderContext

GetAutowrapMode() 

public LabelAutowrapMode GetAutowrapMode()

Returns

LabelAutowrapMode

GetCharacterBounds(int) 

public virtual Rectangle GetCharacterBounds(int position)

Parameters

position int

Returns

Rectangle

GetDisplayLines()

Returns the text as it will be displayed after casing, visible-character, wrapping, and line-limit rules.

public IReadOnlyList<string> GetDisplayLines()

Returns

IReadOnlyList<string>

GetEllipsisChar() 

public string GetEllipsisChar()

Returns

string

GetHorizontalAlignment() 

public HorizontalAlignment GetHorizontalAlignment()

Returns

HorizontalAlignment

GetJustificationFlags() 

public LabelJustificationFlags GetJustificationFlags()

Returns

LabelJustificationFlags

GetLanguage() 

public string GetLanguage()

Returns

string

GetLineCount() 

public int GetLineCount()

Returns

int

GetLineHeight(int) 

public int GetLineHeight(int line = -1)

Parameters

line int

Returns

int

GetLinesSkipped() 

public int GetLinesSkipped()

Returns

int

GetMaxLinesVisible() 

public int GetMaxLinesVisible()

Returns

int

GetMinimumSize() 

public override Vector2 GetMinimumSize()

Returns

Vector2

GetOpenTypeFeatures() 

public IReadOnlyList<UIFontOpenTypeFeature> GetOpenTypeFeatures()

Returns

IReadOnlyList<UIFontOpenTypeFeature>

GetParagraphSeparator() 

public string GetParagraphSeparator()

Returns

string

GetParagraphSpacing() 

public float GetParagraphSpacing()

Returns

float

GetStructuredTextBidiOverride() 

public StructuredTextParser GetStructuredTextBidiOverride()

Returns

StructuredTextParser

GetStructuredTextBidiOverrideOptions() 

public IReadOnlyList<object> GetStructuredTextBidiOverrideOptions()

Returns

IReadOnlyList<object>

GetTabStops() 

public IReadOnlyList<float> GetTabStops()

Returns

IReadOnlyList<float>

GetText() 

public string GetText()

Returns

string

GetTextDirection() 

public TextDirection GetTextDirection()

Returns

TextDirection

GetTextLineSpacing(UIFont) 

protected virtual float GetTextLineSpacing(UIFont font)

Parameters

font UIFont

Returns

float

GetTextOverrunBehavior() 

public LabelTextOverrunBehavior GetTextOverrunBehavior()

Returns

LabelTextOverrunBehavior

GetTotalCharacterCount() 

public int GetTotalCharacterCount()

Returns

int

GetVerticalAlignment() 

public VerticalAlignment GetVerticalAlignment()

Returns

VerticalAlignment

GetVisibleCharacters() 

public int GetVisibleCharacters()

Returns

int

GetVisibleCharactersBehavior() 

public LabelVisibleCharactersBehavior GetVisibleCharactersBehavior()

Returns

LabelVisibleCharactersBehavior

GetVisibleLineCount() 

public int GetVisibleLineCount()

Returns

int

GetVisibleRatio() 

public float GetVisibleRatio()

Returns

float

IsClippingText() 

public bool IsClippingText()

Returns

bool

IsUppercase() 

public bool IsUppercase()

Returns

bool

SetAutowrapMode(LabelAutowrapMode) 

public void SetAutowrapMode(LabelAutowrapMode mode)

Parameters

mode LabelAutowrapMode

SetClipText(bool) 

public void SetClipText(bool enable)

Parameters

enable bool

SetEllipsisChar(string) 

public void SetEllipsisChar(string value)

Parameters

value string

SetHorizontalAlignment(HorizontalAlignment) 

public void SetHorizontalAlignment(HorizontalAlignment alignment)

Parameters

alignment HorizontalAlignment

SetJustificationFlags(LabelJustificationFlags) 

public void SetJustificationFlags(LabelJustificationFlags flags)

Parameters

flags LabelJustificationFlags

SetLanguage(string) 

public void SetLanguage(string language)

Parameters

language string

SetLinesSkipped(int) 

public void SetLinesSkipped(int lines)

Parameters

lines int

SetMaxLinesVisible(int) 

public void SetMaxLinesVisible(int lines)

Parameters

lines int

SetOpenTypeFeatures(IEnumerable<UIFontOpenTypeFeature>) 

public void SetOpenTypeFeatures(IEnumerable<UIFontOpenTypeFeature> features)

Parameters

features IEnumerable<UIFontOpenTypeFeature>

SetParagraphSeparator(string) 

public void SetParagraphSeparator(string paragraphSeparator)

Parameters

paragraphSeparator string

SetParagraphSpacing(float) 

public void SetParagraphSpacing(float spacing)

Parameters

spacing float

SetStructuredTextBidiOverride(StructuredTextParser) 

public void SetStructuredTextBidiOverride(StructuredTextParser parser)

Parameters

parser StructuredTextParser

SetStructuredTextBidiOverrideOptions(IEnumerable<object>) 

public void SetStructuredTextBidiOverrideOptions(IEnumerable<object> options)

Parameters

options IEnumerable<object>

SetTabStops(IEnumerable<float>) 

public void SetTabStops(IEnumerable<float> tabStops)

Parameters

tabStops IEnumerable<float>

SetText(string) 

public void SetText(string text)

Parameters

text string

SetTextDirection(TextDirection) 

public void SetTextDirection(TextDirection direction)

Parameters

direction TextDirection

SetTextOverrunBehavior(LabelTextOverrunBehavior) 

public void SetTextOverrunBehavior(LabelTextOverrunBehavior behavior)

Parameters

behavior LabelTextOverrunBehavior

SetUppercase(bool) 

public void SetUppercase(bool enable)

Parameters

enable bool

SetVerticalAlignment(VerticalAlignment) 

public void SetVerticalAlignment(VerticalAlignment alignment)

Parameters

alignment VerticalAlignment

SetVisibleCharacters(int) 

public void SetVisibleCharacters(int amount)

Parameters

amount int

SetVisibleCharactersBehavior(LabelVisibleCharactersBehavior) 

public void SetVisibleCharactersBehavior(LabelVisibleCharactersBehavior behavior)

Parameters

behavior LabelVisibleCharactersBehavior

SetVisibleRatio(float) 

public void SetVisibleRatio(float ratio)

Parameters

ratio float
Edit this page