Class CanvasControlBuilder

Namespace

SharpConsoleUI.Builders

Assembly

SharpConsoleUI.dll

Fluent builder for creating CanvasControl instances.

public sealed class CanvasControlBuilder : IControlBuilder<CanvasControl>

Inheritance

object

CanvasControlBuilder

Implements

IControlBuilder<CanvasControl>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Extension Methods

BindingExtensions.BindTwoWay<TBuilder, TControl, TSource, TValue>(TBuilder, TSource, Expression<Func<TSource, TValue>>, Expression<Func<TControl, TValue>>)

BindingExtensions.BindTwoWay<TBuilder, TControl, TSource, TSrc, TTgt>(TBuilder, TSource, Expression<Func<TSource, TSrc>>, Expression<Func<TControl, TTgt>>, Func<TSrc, TTgt>, Func<TTgt, TSrc>)

BindingExtensions.Bind<TBuilder, TControl, TSource, TValue>(TBuilder, TSource, Expression<Func<TSource, TValue>>, Expression<Func<TControl, TValue>>)

BindingExtensions.Bind<TBuilder, TControl, TSource, TSrc, TTgt>(TBuilder, TSource, Expression<Func<TSource, TSrc>>, Expression<Func<TControl, TTgt>>, Func<TSrc, TTgt>)

Methods

AutoClear(bool)

Enables auto-clear mode where the buffer is cleared each frame.

public CanvasControlBuilder AutoClear(bool autoClear = true)

Parameters

autoClear bool

Returns

CanvasControlBuilder

AutoSize(bool)

Enables auto-size mode where the canvas resizes to match layout bounds.

public CanvasControlBuilder AutoSize(bool autoSize = true)

Parameters

autoSize bool

Returns

CanvasControlBuilder

Build()

Builds the CanvasControl instance.

public CanvasControl Build()

Returns

CanvasControl

Enabled(bool)

Sets whether the control is enabled.

public CanvasControlBuilder Enabled(bool enabled = true)

Parameters

enabled bool

Returns

CanvasControlBuilder

OnGotFocus(EventHandler)

Sets the GotFocus event handler.

public CanvasControlBuilder OnGotFocus(EventHandler handler)

Parameters

handler EventHandler

Returns

CanvasControlBuilder

OnKeyPressed(EventHandler<ConsoleKeyInfo>)

Sets the key pressed event handler.

public CanvasControlBuilder OnKeyPressed(EventHandler<ConsoleKeyInfo> handler)

Parameters

handler EventHandler<ConsoleKeyInfo>

Returns

CanvasControlBuilder

OnLostFocus(EventHandler)

Sets the LostFocus event handler.

public CanvasControlBuilder OnLostFocus(EventHandler handler)

Parameters

handler EventHandler

Returns

CanvasControlBuilder

OnMouseClick(EventHandler<CanvasMouseEventArgs>)

Sets the mouse click event handler with canvas-local coordinates.

public CanvasControlBuilder OnMouseClick(EventHandler<CanvasMouseEventArgs> handler)

Parameters

handler EventHandler<CanvasMouseEventArgs>

Returns

CanvasControlBuilder

OnMouseMove(EventHandler<CanvasMouseEventArgs>)

Sets the mouse move event handler with canvas-local coordinates.

public CanvasControlBuilder OnMouseMove(EventHandler<CanvasMouseEventArgs> handler)

Parameters

handler EventHandler<CanvasMouseEventArgs>

Returns

CanvasControlBuilder

OnMouseRightClick(EventHandler<CanvasMouseEventArgs>)

Sets the mouse right-click event handler with canvas-local coordinates.

public CanvasControlBuilder OnMouseRightClick(EventHandler<CanvasMouseEventArgs> handler)

Parameters

handler EventHandler<CanvasMouseEventArgs>

Returns

CanvasControlBuilder

OnPaint(EventHandler<CanvasPaintEventArgs>)

Sets the Paint event handler fired during each render cycle.

public CanvasControlBuilder OnPaint(EventHandler<CanvasPaintEventArgs> handler)

Parameters

handler EventHandler<CanvasPaintEventArgs>

Returns

CanvasControlBuilder

StickyBottom()

Makes the control stick to the bottom of the window.

public CanvasControlBuilder StickyBottom()

Returns

CanvasControlBuilder

StickyTop()

Makes the control stick to the top of the window.

public CanvasControlBuilder StickyTop()

Returns

CanvasControlBuilder

Visible(bool)

Sets the visibility.

public CanvasControlBuilder Visible(bool visible = true)

Parameters

visible bool

Returns

CanvasControlBuilder

WithAlignment(HorizontalAlignment)

Sets the horizontal alignment.

public CanvasControlBuilder WithAlignment(HorizontalAlignment alignment)

Parameters

alignment HorizontalAlignment

Returns

CanvasControlBuilder

WithBackgroundColor(Color)

Sets the background color.

public CanvasControlBuilder WithBackgroundColor(Color color)

Parameters

color Color

Returns

CanvasControlBuilder

WithCanvasHeight(int)

Sets the canvas height in characters.

public CanvasControlBuilder WithCanvasHeight(int height)

Parameters

height int

Returns

CanvasControlBuilder

WithCanvasWidth(int)

Sets the canvas width in characters.

public CanvasControlBuilder WithCanvasWidth(int width)

Parameters

width int

Returns

CanvasControlBuilder

WithColors(Color, Color)

Sets both foreground and background colors.

public CanvasControlBuilder WithColors(Color foreground, Color background)

Parameters

foreground Color

background Color

Returns

CanvasControlBuilder

WithForegroundColor(Color)

Sets the foreground color.

public CanvasControlBuilder WithForegroundColor(Color color)

Parameters

color Color

Returns

CanvasControlBuilder

WithMargin(int)

Sets uniform margin on all sides.

public CanvasControlBuilder WithMargin(int margin)

Parameters

margin int

Returns

CanvasControlBuilder

WithMargin(int, int, int, int)

Sets the margin.

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

Parameters

left int

top int

right int

bottom int

Returns

CanvasControlBuilder

WithName(string)

Sets the control name for lookup.

public CanvasControlBuilder WithName(string name)

Parameters

name string

Returns

CanvasControlBuilder

WithSize(int, int)

Sets the canvas size in characters.

public CanvasControlBuilder WithSize(int width, int height)

Parameters

width int

height int

Returns

CanvasControlBuilder

WithStickyPosition(StickyPosition)

Sets the sticky position.

public CanvasControlBuilder WithStickyPosition(StickyPosition position)

Parameters

position StickyPosition

Returns

CanvasControlBuilder

WithTag(object)

Sets a tag object.

public CanvasControlBuilder WithTag(object tag)

Parameters

tag object

Returns

CanvasControlBuilder

WithVerticalAlignment(VerticalAlignment)

Sets the vertical alignment.

public CanvasControlBuilder WithVerticalAlignment(VerticalAlignment alignment)

Parameters

alignment VerticalAlignment

Returns

CanvasControlBuilder

Operators

implicit operator CanvasControl(CanvasControlBuilder)

Implicit conversion to CanvasControl.

public static implicit operator CanvasControl(CanvasControlBuilder builder)

Parameters

builder CanvasControlBuilder

Returns

CanvasControl