Skip to content
ConsoleMonster

API Reference

Class

ColumnsBuilder

Edit on GitHub
Namespace ConsoleMonster.Building
Assembly ConsoleMonster
Source ColumnsBuilder.cs:7
Modifiers sealed

Fluent composition of side-by-side columns (used through RowsBuilder.Columns).

Inheritance

  • Object
  • ColumnsBuilder

Usage

Explore 8 API references to this type

This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.

Returned or exposed by 5

Accepted by parameters 3

Constructors

public ColumnsBuilder() #
ColumnsBuilder.cs:7

Methods

public ColumnsBuilder Add(IWidget widget, Double weight = 1) #
ColumnsBuilder.cs:22
Returns: ColumnsBuilder

Adds a widget with a share of the width.

Parameters

widget ConsoleMonster.Layout.IWidget requiredposition: 0
The widget.
weight System.Double = 1 optionalposition: 1
Relative width (default 1).

Returns

This builder.

public ColumnsBuilder AddFixed(IWidget widget, Int32 cells) #
ColumnsBuilder.cs:31
Returns: ColumnsBuilder

Adds a widget with a fixed width.

Parameters

widget ConsoleMonster.Layout.IWidget requiredposition: 0
The widget.
cells System.Int32 requiredposition: 1
The width in cells.

Returns

This builder.

public Columns Build() #
ColumnsBuilder.cs:60
Returns: Columns

Builds the layout.

Returns

The columns container.

public ColumnsBuilder Gap(Int32 gap) #
ColumnsBuilder.cs:13
Returns: ColumnsBuilder

Blank columns between children.

Parameters

gap System.Int32 requiredposition: 0
The gap.

Returns

This builder.

public ColumnsBuilder Panel(String title, IWidget content, Double weight = 1, String? caption = null) #
ColumnsBuilder.cs:55
Returns: ColumnsBuilder

Adds a panel around any content (for example a Rows of several widgets).

Parameters

title System.String requiredposition: 0
The panel title (markup).
content ConsoleMonster.Layout.IWidget requiredposition: 1
The content.
weight System.Double = 1 optionalposition: 2
Relative width.
caption System.String? = null optionalposition: 3
Text on the right of the top edge.

Returns

This builder.

public ColumnsBuilder Panel<T>(String title, T widget, out T added, Double weight = 1, String? caption = null) #
ColumnsBuilder.cs:44
Returns: ColumnsBuilder

Adds a widget inside a titled panel with a share of the width.

Type Parameters

T
The widget type.

Parameters

title System.String requiredposition: 0
The panel title (markup).
widget T requiredposition: 1
The content.
added T requiredposition: 2
The content, typed.
weight System.Double = 1 optionalposition: 3
Relative width (default 1).
caption System.String? = null optionalposition: 4
Text on the right of the top edge.

Returns

This builder.