Skip to content
ConsoleMonster

API Reference

Class

PanelFluent

Namespace ConsoleMonster.Layout
Assembly ConsoleMonster
Modifiers static
Attributes
GeneratedCode("ConsoleMonster.Generators", "1.0.0")

The fluent methods of Panel, generated from its public properties: With... sets a property and Add... adds to a collection, both returning the same instance.

Inheritance

  • Object
  • PanelFluent

Methods

public static Panel WithBorder(Panel panel, BoxStyle value) #
Returns: Panel

Sets Panel.Border: The border style (default rounded).

Parameters

panel ConsoleMonster.Layout.Panel requiredposition: 0
The instance.
value ConsoleMonster.Glyphs.BoxStyle requiredposition: 1
The value.

Returns

The same instance.

public static Panel WithBorderToken(Panel panel, ThemeToken value) #
Returns: Panel

Sets Panel.BorderToken: The theme token for the border (default ThemeToken.Border).

Parameters

panel ConsoleMonster.Layout.Panel requiredposition: 0
The instance.
value ConsoleMonster.Styling.ThemeToken requiredposition: 1
The value.

Returns

The same instance.

public static Panel WithCaption(Panel panel, String? value) #
Returns: Panel

Sets Panel.Caption: Text on the right of the top edge (markup), for example a count or a clock.

Parameters

panel ConsoleMonster.Layout.Panel requiredposition: 0
The instance.
value System.String? requiredposition: 1
The value.

Returns

The same instance.

public static Panel WithExpand(Panel panel, Boolean value = true) #
Returns: Panel

Sets Panel.Expand: Whether the panel takes the full available width (default true).

Parameters

panel ConsoleMonster.Layout.Panel requiredposition: 0
The instance.
value System.Boolean = true optionalposition: 1
The value (default true).

Returns

The same instance.

public static Panel WithFooter(Panel panel, String? value) #
Returns: Panel

Sets Panel.Footer: Text on the right of the bottom edge (markup), for example "+12 more".

Parameters

panel ConsoleMonster.Layout.Panel requiredposition: 0
The instance.
value System.String? requiredposition: 1
The value.

Returns

The same instance.

public static Panel WithHeight(Panel panel, Int32? value) #
Returns: Panel

Sets Panel.Height: A fixed total height including borders, or null to fit the content.

Parameters

panel ConsoleMonster.Layout.Panel requiredposition: 0
The instance.
value System.Int32? requiredposition: 1
The value.

Returns

The same instance.

public static Panel WithPaddingBottom(Panel panel, Int32 value) #
Returns: Panel

Sets Panel.PaddingBottom: Rows between the content and the bottom border (default 0).

Parameters

panel ConsoleMonster.Layout.Panel requiredposition: 0
The instance.
value System.Int32 requiredposition: 1
The value.

Returns

The same instance.

public static Panel WithPaddingLeft(Panel panel, Int32 value) #
Returns: Panel

Sets Panel.PaddingLeft: Cells between the left border and the content (default 1).

Parameters

panel ConsoleMonster.Layout.Panel requiredposition: 0
The instance.
value System.Int32 requiredposition: 1
The value.

Returns

The same instance.

public static Panel WithPaddingRight(Panel panel, Int32 value) #
Returns: Panel

Sets Panel.PaddingRight: Cells between the content and the right border (default 1).

Parameters

panel ConsoleMonster.Layout.Panel requiredposition: 0
The instance.
value System.Int32 requiredposition: 1
The value.

Returns

The same instance.

public static Panel WithPaddingTop(Panel panel, Int32 value) #
Returns: Panel

Sets Panel.PaddingTop: Rows between the top border and the content (default 0).

Parameters

panel ConsoleMonster.Layout.Panel requiredposition: 0
The instance.
value System.Int32 requiredposition: 1
The value.

Returns

The same instance.

public static Panel WithTitle(Panel panel, String? value) #
Returns: Panel

Sets Panel.Title: The title shown in the top edge (markup).

Parameters

panel ConsoleMonster.Layout.Panel requiredposition: 0
The instance.
value System.String? requiredposition: 1
The value.

Returns

The same instance.