Class SpectreRenderableBuilder

Namespace

SharpConsoleUI.Builders

Assembly

SharpConsoleUI.dll

Fluent builder for Spectre.Console renderable controls

public sealed class SpectreRenderableBuilder

Inheritance

object

SpectreRenderableBuilder

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Methods

Build()

Builds the Spectre renderable control

public SpectreRenderableControl Build()

Returns

SpectreRenderableControl

The configured control

CanFocusWithMouse(bool)

Configures whether the control can receive focus via mouse clicks

public SpectreRenderableBuilder CanFocusWithMouse(bool canFocus = true)

Parameters

canFocus bool

True to enable mouse focus, false to disable (default)

Returns

SpectreRenderableBuilder

The builder for chaining

Centered()

Centers the control horizontally

public SpectreRenderableBuilder Centered()

Returns

SpectreRenderableBuilder

The builder for chaining

Hidden()

Hides the control

public SpectreRenderableBuilder Hidden()

Returns

SpectreRenderableBuilder

The builder for chaining

OnClick(EventHandler<MouseEventArgs>)

Sets the handler for mouse click events

public SpectreRenderableBuilder OnClick(EventHandler<MouseEventArgs> handler)

Parameters

handler EventHandler<MouseEventArgs>

The event handler

Returns

SpectreRenderableBuilder

The builder for chaining

OnDoubleClick(EventHandler<MouseEventArgs>)

Sets the handler for mouse double-click events

public SpectreRenderableBuilder OnDoubleClick(EventHandler<MouseEventArgs> handler)

Parameters

handler EventHandler<MouseEventArgs>

The event handler

Returns

SpectreRenderableBuilder

The builder for chaining

OnMouseEnter(EventHandler<MouseEventArgs>)

Sets the handler for mouse enter events

public SpectreRenderableBuilder OnMouseEnter(EventHandler<MouseEventArgs> handler)

Parameters

handler EventHandler<MouseEventArgs>

The event handler

Returns

SpectreRenderableBuilder

The builder for chaining

OnMouseLeave(EventHandler<MouseEventArgs>)

Sets the handler for mouse leave events

public SpectreRenderableBuilder OnMouseLeave(EventHandler<MouseEventArgs> handler)

Parameters

handler EventHandler<MouseEventArgs>

The event handler

Returns

SpectreRenderableBuilder

The builder for chaining

OnMouseMove(EventHandler<MouseEventArgs>)

Sets the handler for mouse move events

public SpectreRenderableBuilder OnMouseMove(EventHandler<MouseEventArgs> handler)

Parameters

handler EventHandler<MouseEventArgs>

The event handler

Returns

SpectreRenderableBuilder

The builder for chaining

StickyBottom()

Makes the control stick to the bottom of the window

public SpectreRenderableBuilder StickyBottom()

Returns

SpectreRenderableBuilder

The builder for chaining

StickyTop()

Makes the control stick to the top of the window

public SpectreRenderableBuilder StickyTop()

Returns

SpectreRenderableBuilder

The builder for chaining

Visible(bool)

Sets the visibility

public SpectreRenderableBuilder Visible(bool visible = true)

Parameters

visible bool

True if visible

Returns

SpectreRenderableBuilder

The builder for chaining

WithAlignment(HorizontalAlignment)

Sets the horizontal alignment

public SpectreRenderableBuilder WithAlignment(HorizontalAlignment alignment)

Parameters

alignment HorizontalAlignment

The alignment

Returns

SpectreRenderableBuilder

The builder for chaining

WithBackgroundColor(Color)

Sets the background color

public SpectreRenderableBuilder WithBackgroundColor(Color color)

Parameters

color Color

The background color

Returns

SpectreRenderableBuilder

The builder for chaining

WithColors(Color, Color)

Sets both background and foreground colors

public SpectreRenderableBuilder WithColors(Color background, Color foreground)

Parameters

background Color

The background color

foreground Color

The foreground color

Returns

SpectreRenderableBuilder

The builder for chaining

WithForegroundColor(Color)

Sets the foreground color

public SpectreRenderableBuilder WithForegroundColor(Color color)

Parameters

color Color

The foreground color

Returns

SpectreRenderableBuilder

The builder for chaining

WithMargin(Margin)

Sets the margin

public SpectreRenderableBuilder WithMargin(Margin margin)

Parameters

margin Margin

The margin

Returns

SpectreRenderableBuilder

The builder for chaining

WithMargin(int)

Sets uniform margin on all sides

public SpectreRenderableBuilder WithMargin(int margin)

Parameters

margin int

The margin value

Returns

SpectreRenderableBuilder

The builder for chaining

WithMargin(int, int, int, int)

Sets the margin

public SpectreRenderableBuilder WithMargin(int left, int top, int right, int bottom)

Parameters

left int

Left margin

top int

Top margin

right int

Right margin

bottom int

Bottom margin

Returns

SpectreRenderableBuilder

The builder for chaining

WithMouseEvents(bool)

Configures whether the control wants to receive mouse events

public SpectreRenderableBuilder WithMouseEvents(bool wants = true)

Parameters

wants bool

True to enable mouse events (default), false to disable

Returns

SpectreRenderableBuilder

The builder for chaining

WithName(string)

Sets the control name for FindControl queries

public SpectreRenderableBuilder WithName(string name)

Parameters

name string

The control name

Returns

SpectreRenderableBuilder

The builder for chaining

WithRenderable(IRenderable)

Sets the renderable to display

public SpectreRenderableBuilder WithRenderable(IRenderable renderable)

Parameters

renderable IRenderable

The Spectre.Console renderable

Returns

SpectreRenderableBuilder

The builder for chaining

WithStickyPosition(StickyPosition)

Sets the sticky position

public SpectreRenderableBuilder WithStickyPosition(StickyPosition position)

Parameters

position StickyPosition

The sticky position

Returns

SpectreRenderableBuilder

The builder for chaining

WithTag(object)

Sets the control tag for custom data storage

public SpectreRenderableBuilder WithTag(object tag)

Parameters

tag object

The tag object

Returns

SpectreRenderableBuilder

The builder for chaining

WithVerticalAlignment(VerticalAlignment)

Sets the vertical alignment

public SpectreRenderableBuilder WithVerticalAlignment(VerticalAlignment alignment)

Parameters

alignment VerticalAlignment

The vertical alignment

Returns

SpectreRenderableBuilder

The builder for chaining

WithWidth(int)

Sets the width

public SpectreRenderableBuilder WithWidth(int width)

Parameters

width int

The width

Returns

SpectreRenderableBuilder

The builder for chaining

Operators

implicit operator SpectreRenderableControl(SpectreRenderableBuilder)

Implicit conversion to SpectreRenderableControl

public static implicit operator SpectreRenderableControl(SpectreRenderableBuilder builder)

Parameters

builder SpectreRenderableBuilder

Returns

SpectreRenderableControl