Table of Contents

Class TextBox

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

The TextBox element of a view file.

public class TextBox : Control
Inheritance
TextBox
Derived
Inherited Members

Properties

ClickedState

The look while the text box is pressed with the mouse. Falls back to NormalState.

public ControlState ClickedState { get; set; }

Property Value

ControlState

FocusedState

The look while the text box has keyboard focus. Falls back to NormalState.

public ControlState FocusedState { get; set; }

Property Value

ControlState

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. Zero keeps the font's own size.

[Range(0, 3.4028234663852886E+38)]
public float FontSize { get; set; }

Property Value

float

HoverState

The look while the pointer is over the text box. Falls back to NormalState.

public ControlState HoverState { get; set; }

Property Value

ControlState

Label

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

public string Label { get; set; }

Property Value

string

NormalState

The look of the text box in its normal state.

public ControlState NormalState { get; set; }

Property Value

ControlState

RestrictToNumbers

Whether only numeric characters can be typed.

public bool RestrictToNumbers { get; set; }

Property Value

bool

Size

The size of the text box in pixels.

[Required]
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 initial text. A "{Localize key}" shows that key's text in the current language.

public string Text { get; set; }

Property Value

string