Table of Contents

Namespace BSGameLib.UI.Builder.Models

Classes

Button

The Button element of a view file.

CheckBox

The CheckBox element of a view file.

ColorResource

A named color: a Color resource of a template.

ComboBox

The ComboBox element of a view file: a drop-down list of options.

ComboBoxOption

One option in a ComboBox's list.

ComboBoxParts

The separate parts of a ComboBox: its box, arrow and drop-down list.

ComboBoxParts.PartArrow

The arrow at the right of the box.

ComboBoxParts.PartBox

The box the selected option's text is shown in.

ComboBoxParts.PartDropDown

The open list of options.

Control

The attributes every control in a view file shares. Each control type derives from it.

ControlState

The look of a control in one state: its colors, texture, border and shadow.

Decoration

A decoration: a visual mark pinned to a corner or edge of the view, outside the layout.

DesignData

Sample values used to render a .view.xml in a designer/preview, standing in for the view model a real run would bind against. Loaded only by design-time tooling (the render host and the VS Code preview) - the runtime ViewManager never looks at these files, so they cost nothing in a shipped game.

Convention: a view at Foo.view.xml is paired with Foo.designdata.xml beside it.

Without this, a preview renders every "{Binding X}" as that literal string, which is actively misleading rather than merely unhelpful: long placeholders overflow columns that real values fit fine, and every Visible="{Binding X}" section renders at once, showing a combination of state the running app can never actually be in.

DesignDataItem

One sample item inside a DesignDataItems collection - a single row of a repeater, as the preview should draw it.

DesignDataItems

Sample rows for one bound collection, so a repeater renders with content in a preview instead of as an empty box.

DesignDataProperty

One name/value pair in a DesignData file.

DockLayout

The DockLayout element of a view file: children docked to its edges.

GradientResource

A named gradient: a Gradient resource of a template.

GradientStopResource

One color stop of a gradient.

GridCell

One cell of a grid layout: its row, column, span and the control in it.

GridLayout

The GridLayout element of a view file: children in rows and columns.

HorizontalThreePatchReference

A reference to a horizontal three-patch texture declared in the view's resources or a template.

HorizontalThreePatchTexture

A horizontal three-patch texture: a left cap, a stretched middle and a right cap, read from one image.

Image

The Image element of a view file.

IndexAtlasReference

A reference to one numbered texture of an atlas.

Label

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

LayoutControl

The base of the stack, dock and grid layouts: the appearance they paint behind and around their children.

NinePatchReference

A reference to a nine-patch texture declared in the view's resources or a template.

NinePatchSubsection

One subsection of a nine-patch texture: where it is in the texture, and its size and color.

NinePatchTexture

A nine-patch texture: eight edge and corner pieces around a middle, read from one image.

PasswordBox

The PasswordBox element of a view file: a text box that hides what is typed.

Point

A point in pixels, written as {x,y} in a view file.

ProgressBar

A horizontal bar filled in proportion to Value - a download's progress, a server's population, a health bar.

RadioButton

The RadioButton element of a view file.

Region

One named region of a texture atlas.

RegionAtlasReference

A reference to one named region of an atlas.

Repeater

Repeats an ItemTemplate once per item in a bound collection - a server list, a character roster, a download queue.

RepeaterItemTemplate

The control tree a Repeater builds once per item.

Resource

Base for everything a Template can declare - colors, strings, gradients and textures.

Size

A size in pixels, written as {width,height} in a view file.

Slider

A horizontal slider choosing a number between Minimum and Maximum - a volume, a scale. Value binds two-way, so the view model sees every change as the player drags.

Spacing

Four values in pixels, one for each side. Written as {left,top,right,bottom}, or as one number for all four sides.

StackLayout

The StackLayout element of a view file: children in a row or a column.

StringResource

A named string: a String resource of a template.

StyleResource

A named style: text settings and per-state looks that a control takes with Style="name".

Template

The resources a view or template file declares: colors, strings, gradients, styles and textures.

TemplateReference

A reference to a texture a template declares, by its name.

TextBox

The TextBox element of a view file.

Texture

A texture a template declares. The base of the texture kinds: image files, atlases and patched textures.

TextureAtlas

A texture file that holds several textures, each named by a region or numbered by an index.

TextureFile

A texture read from one image file.

TextureIndexAtlas

A texture atlas whose textures are numbered, each of the same size.

TextureIndexAtlasWithIndex

A texture atlas whose numbered textures are each the same size, with the one to use given in the same element.

TextureReference

A reference to a texture declared in the view's resources or a template.

TextureRegionAtlas

A texture atlas whose named regions are each placed within it.

TextureRegionAtlasWithRegion

A texture atlas with the one named region to use given in the same element.

View

The model of a view file: the View element and everything in it.

ViewTemplate

A References entry: a template file whose resources the view uses.

ViewTextureFile

A texture file a view declares in its own resources.

Enums

DockPosition

The edge of a dock layout a child docks to.

HorizontalAlignment

Where a control sits horizontally in the space it is given.

Orientation

The direction a stack or repeater lays its children out in.

VerticalAlignment

Where a control sits vertically in the space it is given.