Interface IDockLayoutBuilder

Namespace

BSGameLib.UI.Builder

Assembly

BSGameLib.UI.dll

A dock layout, the DockLayout element of a view file, built in C#.

public interface IDockLayoutBuilder : IContainerBuilder<IDockLayoutBuilder>, IControlBuilder<IDockLayoutBuilder>

Inherited Members

IContainerBuilder<IDockLayoutBuilder>.WithBackgroundColor(string)

IContainerBuilder<IDockLayoutBuilder>.WithFillColor(string)

IContainerBuilder<IDockLayoutBuilder>.WithFillGradient(string)

IContainerBuilder<IDockLayoutBuilder>.WithBorderColor(string)

IContainerBuilder<IDockLayoutBuilder>.WithBorderThickness(int)

IContainerBuilder<IDockLayoutBuilder>.WithShadowColor(string)

IContainerBuilder<IDockLayoutBuilder>.WithShadowOffset(int, int)

IContainerBuilder<IDockLayoutBuilder>.WithShadowBlur(int)

IContainerBuilder<IDockLayoutBuilder>.WithShadowSpread(int)

IContainerBuilder<IDockLayoutBuilder>.WithBackgroundTexture(string, string)

IContainerBuilder<IDockLayoutBuilder>.WithBackgroundTextureRegionAtlas(string, string, string, int, int, int, int)

IContainerBuilder<IDockLayoutBuilder>.WithBackgroundTextureIndexAtlas(string, int, string, int, int)

IContainerBuilder<IDockLayoutBuilder>.WithBackgroundTextureRegionReference(string, string)

IContainerBuilder<IDockLayoutBuilder>.WithBackgroundTextureIndexReference(string, int)

IContainerBuilder<IDockLayoutBuilder>.WithBackgroundNinePatchTextureReference(string)

IContainerBuilder<IDockLayoutBuilder>.WithBackgroundHorizontalThreePatchTextureReference(string)

IContainerBuilder<IDockLayoutBuilder>.WithBackgroundTextureReference(string)

IControlBuilder<IDockLayoutBuilder>.WithId(string)

IControlBuilder<IDockLayoutBuilder>.WithPosition(int, int)

IControlBuilder<IDockLayoutBuilder>.WithVisibility(bool)

IControlBuilder<IDockLayoutBuilder>.BindVisibility(string)

IControlBuilder<IDockLayoutBuilder>.WithEnabledState(bool)

IControlBuilder<IDockLayoutBuilder>.BindDisabled(string)

IControlBuilder<IDockLayoutBuilder>.WithHoverKey(string)

IControlBuilder<IDockLayoutBuilder>.BindHoverKey(string)

IControlBuilder<IDockLayoutBuilder>.WithStyle(string)

IControlBuilder<IDockLayoutBuilder>.WithMargin(Spacing)

IControlBuilder<IDockLayoutBuilder>.WithMargin(int)

IControlBuilder<IDockLayoutBuilder>.WithMargin(int, int)

IControlBuilder<IDockLayoutBuilder>.WithMargin(int, int, int, int)

IControlBuilder<IDockLayoutBuilder>.WithIsInitialFocus(bool)

IControlBuilder<IDockLayoutBuilder>.WithPanelTitle(bool)

Methods

AddButton(DockPosition, Action<IButtonBuilder>)

Adds a button docked to dock.

IDockLayoutBuilder AddButton(DockPosition dock, Action<IButtonBuilder> configure)

Parameters

dock DockPosition

configure Action<IButtonBuilder>

Returns

IDockLayoutBuilder

AddButton(Action<IButtonBuilder>)

Adds a button that fills the space left after the other children are docked.

IDockLayoutBuilder AddButton(Action<IButtonBuilder> configure)

Parameters

configure Action<IButtonBuilder>

Returns

IDockLayoutBuilder

AddButton(string, DockPosition, Action<IButtonBuilder>)

Adds a button with the id id, docked to dock.

IDockLayoutBuilder AddButton(string id, DockPosition dock, Action<IButtonBuilder> configure)

Parameters

id string

dock DockPosition

configure Action<IButtonBuilder>

Returns

IDockLayoutBuilder

AddCheckBox(DockPosition, Action<ICheckBoxBuilder>)

Adds a check box docked to dock.

IDockLayoutBuilder AddCheckBox(DockPosition dock, Action<ICheckBoxBuilder> configure)

Parameters

dock DockPosition

configure Action<ICheckBoxBuilder>

Returns

IDockLayoutBuilder

AddCheckBox(Action<ICheckBoxBuilder>)

Adds a check box that fills the space left after the other children are docked.

IDockLayoutBuilder AddCheckBox(Action<ICheckBoxBuilder> configure)

Parameters

configure Action<ICheckBoxBuilder>

Returns

IDockLayoutBuilder

AddCheckBox(string, DockPosition, Action<ICheckBoxBuilder>)

Adds a check box with the id id, docked to dock.

IDockLayoutBuilder AddCheckBox(string id, DockPosition dock, Action<ICheckBoxBuilder> configure)

Parameters

id string

dock DockPosition

configure Action<ICheckBoxBuilder>

Returns

IDockLayoutBuilder

AddComboBox(DockPosition, Action<IComboBoxBuilder>)

Adds a combo box docked to dock.

IDockLayoutBuilder AddComboBox(DockPosition dock, Action<IComboBoxBuilder> configure)

Parameters

dock DockPosition

configure Action<IComboBoxBuilder>

Returns

IDockLayoutBuilder

AddComboBox(Action<IComboBoxBuilder>)

Adds a combo box that fills the space left after the other children are docked.

IDockLayoutBuilder AddComboBox(Action<IComboBoxBuilder> configure)

Parameters

configure Action<IComboBoxBuilder>

Returns

IDockLayoutBuilder

AddComboBox(string, DockPosition, Action<IComboBoxBuilder>)

Adds a combo box with the id id, docked to dock.

IDockLayoutBuilder AddComboBox(string id, DockPosition dock, Action<IComboBoxBuilder> configure)

Parameters

id string

dock DockPosition

configure Action<IComboBoxBuilder>

Returns

IDockLayoutBuilder

AddDockLayout(DockPosition, Action<IDockLayoutBuilder>)

Adds a dock layout docked to dock.

IDockLayoutBuilder AddDockLayout(DockPosition dock, Action<IDockLayoutBuilder> configure)

Parameters

dock DockPosition

configure Action<IDockLayoutBuilder>

Returns

IDockLayoutBuilder

AddDockLayout(Action<IDockLayoutBuilder>)

Adds a dock layout that fills the space left after the other children are docked.

IDockLayoutBuilder AddDockLayout(Action<IDockLayoutBuilder> configure)

Parameters

configure Action<IDockLayoutBuilder>

Returns

IDockLayoutBuilder

AddDockLayout(string, DockPosition, Action<IDockLayoutBuilder>)

Adds a dock layout with the id id, docked to dock.

IDockLayoutBuilder AddDockLayout(string id, DockPosition dock, Action<IDockLayoutBuilder> configure)

Parameters

id string

dock DockPosition

configure Action<IDockLayoutBuilder>

Returns

IDockLayoutBuilder

AddGridLayout(DockPosition, Action<IGridLayoutBuilder>)

Adds a grid layout docked to dock.

IDockLayoutBuilder AddGridLayout(DockPosition dock, Action<IGridLayoutBuilder> configure)

Parameters

dock DockPosition

configure Action<IGridLayoutBuilder>

Returns

IDockLayoutBuilder

AddGridLayout(Action<IGridLayoutBuilder>)

Adds a grid layout that fills the space left after the other children are docked.

IDockLayoutBuilder AddGridLayout(Action<IGridLayoutBuilder> configure)

Parameters

configure Action<IGridLayoutBuilder>

Returns

IDockLayoutBuilder

AddGridLayout(string, DockPosition, Action<IGridLayoutBuilder>)

Adds a grid layout with the id id, docked to dock.

IDockLayoutBuilder AddGridLayout(string id, DockPosition dock, Action<IGridLayoutBuilder> configure)

Parameters

id string

dock DockPosition

configure Action<IGridLayoutBuilder>

Returns

IDockLayoutBuilder

AddImage(DockPosition, Action<IImageBuilder>)

Adds an image docked to dock.

IDockLayoutBuilder AddImage(DockPosition dock, Action<IImageBuilder> configure)

Parameters

dock DockPosition

configure Action<IImageBuilder>

Returns

IDockLayoutBuilder

AddImage(Action<IImageBuilder>)

Adds an image that fills the space left after the other children are docked.

IDockLayoutBuilder AddImage(Action<IImageBuilder> configure)

Parameters

configure Action<IImageBuilder>

Returns

IDockLayoutBuilder

AddImage(string, DockPosition, Action<IImageBuilder>)

Adds an image with the id id, docked to dock.

IDockLayoutBuilder AddImage(string id, DockPosition dock, Action<IImageBuilder> configure)

Parameters

id string

dock DockPosition

configure Action<IImageBuilder>

Returns

IDockLayoutBuilder

AddLabel(DockPosition, Action<ILabelBuilder>)

Adds a label docked to dock.

IDockLayoutBuilder AddLabel(DockPosition dock, Action<ILabelBuilder> configure)

Parameters

dock DockPosition

configure Action<ILabelBuilder>

Returns

IDockLayoutBuilder

AddLabel(Action<ILabelBuilder>)

Adds a label that fills the space left after the other children are docked.

IDockLayoutBuilder AddLabel(Action<ILabelBuilder> configure)

Parameters

configure Action<ILabelBuilder>

Returns

IDockLayoutBuilder

AddLabel(string, DockPosition, Action<ILabelBuilder>)

Adds a label with the id id, docked to dock.

IDockLayoutBuilder AddLabel(string id, DockPosition dock, Action<ILabelBuilder> configure)

Parameters

id string

dock DockPosition

configure Action<ILabelBuilder>

Returns

IDockLayoutBuilder

AddPasswordBox(DockPosition, Action<IPasswordBoxBuilder>)

Adds a password box docked to dock.

IDockLayoutBuilder AddPasswordBox(DockPosition dock, Action<IPasswordBoxBuilder> configure)

Parameters

dock DockPosition

configure Action<IPasswordBoxBuilder>

Returns

IDockLayoutBuilder

AddPasswordBox(Action<IPasswordBoxBuilder>)

Adds a password box that fills the space left after the other children are docked.

IDockLayoutBuilder AddPasswordBox(Action<IPasswordBoxBuilder> configure)

Parameters

configure Action<IPasswordBoxBuilder>

Returns

IDockLayoutBuilder

AddPasswordBox(string, DockPosition, Action<IPasswordBoxBuilder>)

Adds a password box with the id id, docked to dock.

IDockLayoutBuilder AddPasswordBox(string id, DockPosition dock, Action<IPasswordBoxBuilder> configure)

Parameters

id string

dock DockPosition

configure Action<IPasswordBoxBuilder>

Returns

IDockLayoutBuilder

AddProgressBar(DockPosition, Action<IProgressBarBuilder>)

Adds a progress bar docked to dock.

IDockLayoutBuilder AddProgressBar(DockPosition dock, Action<IProgressBarBuilder> configure)

Parameters

dock DockPosition

configure Action<IProgressBarBuilder>

Returns

IDockLayoutBuilder

AddProgressBar(Action<IProgressBarBuilder>)

Adds a progress bar that fills the space left after the other children are docked.

IDockLayoutBuilder AddProgressBar(Action<IProgressBarBuilder> configure)

Parameters

configure Action<IProgressBarBuilder>

Returns

IDockLayoutBuilder

AddProgressBar(string, DockPosition, Action<IProgressBarBuilder>)

Adds a progress bar with the id id, docked to dock.

IDockLayoutBuilder AddProgressBar(string id, DockPosition dock, Action<IProgressBarBuilder> configure)

Parameters

id string

dock DockPosition

configure Action<IProgressBarBuilder>

Returns

IDockLayoutBuilder

AddRadioButton(DockPosition, Action<IRadioButtonBuilder>)

Adds a radio button docked to dock.

IDockLayoutBuilder AddRadioButton(DockPosition dock, Action<IRadioButtonBuilder> configure)

Parameters

dock DockPosition

configure Action<IRadioButtonBuilder>

Returns

IDockLayoutBuilder

AddRadioButton(Action<IRadioButtonBuilder>)

Adds a radio button that fills the space left after the other children are docked.

IDockLayoutBuilder AddRadioButton(Action<IRadioButtonBuilder> configure)

Parameters

configure Action<IRadioButtonBuilder>

Returns

IDockLayoutBuilder

AddRadioButton(string, DockPosition, Action<IRadioButtonBuilder>)

Adds a radio button with the id id, docked to dock.

IDockLayoutBuilder AddRadioButton(string id, DockPosition dock, Action<IRadioButtonBuilder> configure)

Parameters

id string

dock DockPosition

configure Action<IRadioButtonBuilder>

Returns

IDockLayoutBuilder

AddRepeater(DockPosition, Action<IRepeaterBuilder>)

Adds a repeater docked to dock.

IDockLayoutBuilder AddRepeater(DockPosition dock, Action<IRepeaterBuilder> configure)

Parameters

dock DockPosition

configure Action<IRepeaterBuilder>

Returns

IDockLayoutBuilder

AddRepeater(Action<IRepeaterBuilder>)

Adds a repeater that fills the space left after the other children are docked.

IDockLayoutBuilder AddRepeater(Action<IRepeaterBuilder> configure)

Parameters

configure Action<IRepeaterBuilder>

Returns

IDockLayoutBuilder

AddRepeater(string, DockPosition, Action<IRepeaterBuilder>)

Adds a repeater with the id id, docked to dock.

IDockLayoutBuilder AddRepeater(string id, DockPosition dock, Action<IRepeaterBuilder> configure)

Parameters

id string

dock DockPosition

configure Action<IRepeaterBuilder>

Returns

IDockLayoutBuilder

AddSlider(DockPosition, Action<ISliderBuilder>)

Adds a slider docked to dock.

IDockLayoutBuilder AddSlider(DockPosition dock, Action<ISliderBuilder> configure)

Parameters

dock DockPosition

configure Action<ISliderBuilder>

Returns

IDockLayoutBuilder

AddSlider(Action<ISliderBuilder>)

Adds a slider that fills the space left after the other children are docked.

IDockLayoutBuilder AddSlider(Action<ISliderBuilder> configure)

Parameters

configure Action<ISliderBuilder>

Returns

IDockLayoutBuilder

AddSlider(string, DockPosition, Action<ISliderBuilder>)

Adds a slider with the id id, docked to dock.

IDockLayoutBuilder AddSlider(string id, DockPosition dock, Action<ISliderBuilder> configure)

Parameters

id string

dock DockPosition

configure Action<ISliderBuilder>

Returns

IDockLayoutBuilder

AddStackLayout(DockPosition, Action<IStackLayoutBuilder>)

Adds a stack layout docked to dock.

IDockLayoutBuilder AddStackLayout(DockPosition dock, Action<IStackLayoutBuilder> configure)

Parameters

dock DockPosition

configure Action<IStackLayoutBuilder>

Returns

IDockLayoutBuilder

AddStackLayout(Action<IStackLayoutBuilder>)

Adds a stack layout that fills the space left after the other children are docked.

IDockLayoutBuilder AddStackLayout(Action<IStackLayoutBuilder> configure)

Parameters

configure Action<IStackLayoutBuilder>

Returns

IDockLayoutBuilder

AddStackLayout(string, DockPosition, Action<IStackLayoutBuilder>)

Adds a stack layout with the id id, docked to dock.

IDockLayoutBuilder AddStackLayout(string id, DockPosition dock, Action<IStackLayoutBuilder> configure)

Parameters

id string

dock DockPosition

configure Action<IStackLayoutBuilder>

Returns

IDockLayoutBuilder

AddTextBox(DockPosition, Action<ITextBoxBuilder>)

Adds a text box docked to dock.

IDockLayoutBuilder AddTextBox(DockPosition dock, Action<ITextBoxBuilder> configure)

Parameters

dock DockPosition

configure Action<ITextBoxBuilder>

Returns

IDockLayoutBuilder

AddTextBox(Action<ITextBoxBuilder>)

Adds a text box that fills the space left after the other children are docked.

IDockLayoutBuilder AddTextBox(Action<ITextBoxBuilder> configure)

Parameters

configure Action<ITextBoxBuilder>

Returns

IDockLayoutBuilder

AddTextBox(string, DockPosition, Action<ITextBoxBuilder>)

Adds a text box with the id id, docked to dock.

IDockLayoutBuilder AddTextBox(string id, DockPosition dock, Action<ITextBoxBuilder> configure)

Parameters

id string

dock DockPosition

configure Action<ITextBoxBuilder>

Returns

IDockLayoutBuilder

WithLastChildFill(bool)

Sets whether the last child fills the space left after the others are docked.

IDockLayoutBuilder WithLastChildFill(bool fill)

Parameters

fill bool

Returns

IDockLayoutBuilder

WithPadding(int)

Sets the same padding on all four sides, in pixels.

IDockLayoutBuilder WithPadding(int uniformPadding)

Parameters

uniformPadding int

Returns

IDockLayoutBuilder

WithPadding(int, int, int, int)

Sets the left, top, right and bottom padding inside the layout, in pixels.

IDockLayoutBuilder WithPadding(int left, int top, int right, int bottom)

Parameters

left int

top int

right int

bottom int

Returns

IDockLayoutBuilder

WithSize(int, int)

Sets the layout's size in pixels.

IDockLayoutBuilder WithSize(int width, int height)

Parameters

width int

height int

Returns

IDockLayoutBuilder