Table of Contents

Class Label

Namespace
BSGameLib.UI.Builder.Models
Assembly
BSGameLib.UI.dll

The Label element of a view file: text, with optional fill and border.

public class Label : Control
Inheritance
Label
Inherited Members

Properties

Alignment

How the text is aligned within the label. Left by default.

[EnumDataType(typeof(Label.Alignment))]
public Label.Alignment Alignment { get; set; }

Property Value

Label.Alignment

BorderColor

The color of a border drawn around the label's bounds. Independent of FillColor.

public string BorderColor { get; set; }

Property Value

string

BorderThickness

The border's width in pixels. Has no effect unless BorderColor is set. One by default.

[Range(0, 2147483647)]
public int BorderThickness { get; set; }

Property Value

int

Color

The color of the text.

public string Color { get; set; }

Property Value

string

FillColor

A flat fill drawn behind the text.

public string FillColor { get; set; }

Property Value

string

FillGradient

A gradient fill drawn behind the text, naming a Gradient resource. Drawn in place of FillColor when both are set.

public string FillGradient { get; set; }

Property Value

string

Font

The font for the text: a BMFont (.fnt) or TrueType (.ttf/.otf) file.

public string Font { get; set; }

Property Value

string

FontSize

The point size of the text. 18 by default.

public float FontSize { get; set; }

Property Value

float

LetterSpacing

Extra space between glyphs, in pixels. Zero adds none.

public float LetterSpacing { get; set; }

Property Value

float

Size

The label's size in pixels.

public Size Size { get; set; }

Property Value

Size

SizeValue

The Size attribute's text form. See Size.

public string SizeValue { get; set; }

Property Value

string

Text

The text shown. A "{Localize key}" shows that key's text in the current language.

public string Text { get; set; }

Property Value

string

WrapText

Whether the text wraps onto further lines when it is wider than the label.

public bool WrapText { get; set; }

Property Value

bool