Table of Contents

Class CheckBox

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

The CheckBox element of a view file.

[KnownType(typeof(RadioButton))]
public class CheckBox : Control
Inheritance
CheckBox
Derived
Inherited Members

Properties

BoxSize

The side length of the box in pixels. The box sits to the left of the text. Used only by a flat-themed check box.

[Range(0, 2147483647)]
public float BoxSize { get; set; }

Property Value

float

CheckMarkColor

The color of the check mark. Used only by a flat-themed check box, not one drawn from textures.

public string CheckMarkColor { get; set; }

Property Value

string

Checked

Whether the check box starts checked.

public bool Checked { get; set; }

Property Value

bool

CheckedBinding

The view model property the checked state is bound to, when the Checked attribute was a binding; otherwise null.

public string CheckedBinding { get; set; }

Property Value

string

CheckedState

The look of the box while checked.

public ControlState CheckedState { get; set; }

Property Value

ControlState

CheckedValue

The Checked attribute's text: a literal, or a binding. Use Checked in code.

public string CheckedValue { get; set; }

Property Value

string

Font

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

public string Font { get; set; }

Property Value

string

FontSize

The point size of the label text. Zero keeps the font's own size.

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

Property Value

float

Size

Not used: a check box sizes itself from BoxSize and its text.

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

public string Text { get; set; }

Property Value

string

UncheckedState

The look of the box while unchecked.

public ControlState UncheckedState { get; set; }

Property Value

ControlState