Table of Contents

Class HorizontalGridBuilder

Namespace
SharpConsoleUI.Builders
Assembly
SharpConsoleUI.dll

Fluent builder for constructing HorizontalGridControl instances with a concise, chainable API.

public class HorizontalGridBuilder
Inheritance
HorizontalGridBuilder
Inherited Members

Examples

var grid = HorizontalGridControl.Create()
    .Column(col => col.Width(48).Add(control1))
    .Column(col => col.Flex(2.0).Add(control2))
    .WithSplitterAfter(0)
    .WithAlignment(HorizontalAlignment.Stretch)
    .Build();

Methods

Build()

Builds the HorizontalGridControl with all configured columns and splitters.

public HorizontalGridControl Build()

Returns

HorizontalGridControl

The configured HorizontalGridControl.

Column(Action<ColumnBuilder>)

Adds a column to the grid using a fluent configuration.

public HorizontalGridBuilder Column(Action<ColumnBuilder> configure)

Parameters

configure Action<ColumnBuilder>

Action to configure the column.

Returns

HorizontalGridBuilder

This builder for method chaining.

StickyBottom()

Makes the control stick to the bottom of the window.

public HorizontalGridBuilder StickyBottom()

Returns

HorizontalGridBuilder

This builder for method chaining.

StickyTop()

Makes the control stick to the top of the window.

public HorizontalGridBuilder StickyTop()

Returns

HorizontalGridBuilder

This builder for method chaining.

Visible(bool)

Sets the visibility.

public HorizontalGridBuilder Visible(bool visible = true)

Parameters

visible bool

True if visible.

Returns

HorizontalGridBuilder

This builder for method chaining.

WithAlignment(HorizontalAlignment)

Sets the horizontal alignment of the grid.

public HorizontalGridBuilder WithAlignment(HorizontalAlignment alignment)

Parameters

alignment HorizontalAlignment

The horizontal alignment.

Returns

HorizontalGridBuilder

This builder for method chaining.

WithMargin(Margin)

Sets the margin.

public HorizontalGridBuilder WithMargin(Margin margin)

Parameters

margin Margin

The margin.

Returns

HorizontalGridBuilder

This builder for method chaining.

WithMargin(int)

Sets uniform margin on all sides.

public HorizontalGridBuilder WithMargin(int margin)

Parameters

margin int

The margin value.

Returns

HorizontalGridBuilder

This builder for method chaining.

WithMargin(int, int, int, int)

Sets the margin.

public HorizontalGridBuilder 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

HorizontalGridBuilder

This builder for method chaining.

WithName(string)

Sets the control name for FindControl queries.

public HorizontalGridBuilder WithName(string name)

Parameters

name string

The control name.

Returns

HorizontalGridBuilder

This builder for method chaining.

WithSplitterAfter(int)

Adds a splitter after the column at the specified index.

public HorizontalGridBuilder WithSplitterAfter(int columnIndex)

Parameters

columnIndex int

The index of the column after which to add a splitter.

Returns

HorizontalGridBuilder

This builder for method chaining.

WithStickyPosition(StickyPosition)

Sets the sticky position.

public HorizontalGridBuilder WithStickyPosition(StickyPosition position)

Parameters

position StickyPosition

The sticky position.

Returns

HorizontalGridBuilder

This builder for method chaining.

WithTag(object)

Sets the control tag for custom data storage.

public HorizontalGridBuilder WithTag(object tag)

Parameters

tag object

The tag object.

Returns

HorizontalGridBuilder

This builder for method chaining.

WithVerticalAlignment(VerticalAlignment)

Sets the vertical alignment of the grid.

public HorizontalGridBuilder WithVerticalAlignment(VerticalAlignment alignment)

Parameters

alignment VerticalAlignment

The vertical alignment.

Returns

HorizontalGridBuilder

This builder for method chaining.

Edit this page