Table of Contents

Interface IContainerBuilder<TBuilder>

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

What every layout (stack, dock, grid) takes on top of IControlBuilder<TBuilder>: the LayoutControl appearance attributes, which paint behind or around the children.

public interface IContainerBuilder<out TBuilder> : IControlBuilder<TBuilder>

Type Parameters

TBuilder
Inherited Members

Methods

WithBackgroundColor(string)

Sets the color that tints the background texture, as the BackgroundColor attribute does.

TBuilder WithBackgroundColor(string colorHex)

Parameters

colorHex string

Returns

TBuilder

WithBackgroundHorizontalThreePatchTextureReference(string)

Uses a horizontal three-patch texture declared in the view's resources as the background.

TBuilder WithBackgroundHorizontalThreePatchTextureReference(string id)

Parameters

id string

Returns

TBuilder

WithBackgroundNinePatchTextureReference(string)

Uses a nine-patch texture declared in the view's resources as the background.

TBuilder WithBackgroundNinePatchTextureReference(string id)

Parameters

id string

Returns

TBuilder

WithBackgroundTexture(string, string)

Sets a texture drawn behind the children, from a file under the id id.

TBuilder WithBackgroundTexture(string id, string sourceFile)

Parameters

id string
sourceFile string

Returns

TBuilder

WithBackgroundTextureIndexAtlas(string, int, string, int, int)

Sets the background to one indexed texture of an atlas file.

TBuilder WithBackgroundTextureIndexAtlas(string id, int index, string sourceFile, int eachTextureWidth, int eachTextureHeight)

Parameters

id string
index int
sourceFile string
eachTextureWidth int
eachTextureHeight int

Returns

TBuilder

WithBackgroundTextureIndexReference(string, int)

Uses one indexed texture of an atlas declared in the view's resources as the background.

TBuilder WithBackgroundTextureIndexReference(string id, int index)

Parameters

id string
index int

Returns

TBuilder

WithBackgroundTextureReference(string)

Uses a texture declared in the view's resources as the background.

TBuilder WithBackgroundTextureReference(string id)

Parameters

id string

Returns

TBuilder

WithBackgroundTextureRegionAtlas(string, string, string, int, int, int, int)

Sets the background to one named region of a texture atlas file.

TBuilder WithBackgroundTextureRegionAtlas(string id, string sourceFile, string regionId, int x, int y, int width, int height)

Parameters

id string
sourceFile string
regionId string
x int
y int
width int
height int

Returns

TBuilder

WithBackgroundTextureRegionReference(string, string)

Uses one named region of an atlas declared in the view's resources as the background.

TBuilder WithBackgroundTextureRegionReference(string id, string regionName)

Parameters

id string
regionName string

Returns

TBuilder

WithBorderColor(string)

Sets the color of a border drawn around the layout.

TBuilder WithBorderColor(string colorHex)

Parameters

colorHex string

Returns

TBuilder

WithBorderThickness(int)

Sets the border's width in pixels. Has no effect without a border color.

TBuilder WithBorderThickness(int thickness)

Parameters

thickness int

Returns

TBuilder

WithFillColor(string)

Sets a flat fill drawn behind the children.

TBuilder WithFillColor(string colorHex)

Parameters

colorHex string

Returns

TBuilder

WithFillGradient(string)

Sets a gradient fill drawn behind the children, naming a Gradient resource. Drawn in place of the fill color when both are set.

TBuilder WithFillGradient(string gradientId)

Parameters

gradientId string

Returns

TBuilder

WithShadowBlur(int)

Sets the shadow's blur in pixels.

TBuilder WithShadowBlur(int blur)

Parameters

blur int

Returns

TBuilder

WithShadowColor(string)

Sets the color of a soft drop shadow behind the layout. Nothing is drawn without it.

TBuilder WithShadowColor(string colorHex)

Parameters

colorHex string

Returns

TBuilder

WithShadowOffset(int, int)

Sets how far the shadow is moved from the layout, in pixels.

TBuilder WithShadowOffset(int x, int y)

Parameters

x int
y int

Returns

TBuilder

WithShadowSpread(int)

Sets how much larger than the layout the shadow is, in pixels. Negative values pull it in.

TBuilder WithShadowSpread(int spread)

Parameters

spread int

Returns

TBuilder