Table of Contents

Class MultilineEditControlBuilder

Namespace
SharpConsoleUI.Builders
Assembly
SharpConsoleUI.dll

Fluent builder for multiline edit controls

public sealed class MultilineEditControlBuilder
Inheritance
MultilineEditControlBuilder
Inherited Members

Methods

AsReadOnly(bool)

Sets the read-only state

public MultilineEditControlBuilder AsReadOnly(bool readOnly = true)

Parameters

readOnly bool

Whether the control is read-only

Returns

MultilineEditControlBuilder

The builder for chaining

Build()

Builds the multiline edit control

public MultilineEditControl Build()

Returns

MultilineEditControl

The configured multiline edit control

Centered()

Centers the control horizontally

public MultilineEditControlBuilder Centered()

Returns

MultilineEditControlBuilder

The builder for chaining

Disabled()

Disables the control

public MultilineEditControlBuilder Disabled()

Returns

MultilineEditControlBuilder

The builder for chaining

Enabled(bool)

Sets the enabled state

public MultilineEditControlBuilder Enabled(bool enabled = true)

Parameters

enabled bool

Whether the control is enabled

Returns

MultilineEditControlBuilder

The builder for chaining

IsEditing(bool)

Sets the editing state

public MultilineEditControlBuilder IsEditing(bool isEditing = true)

Parameters

isEditing bool

Whether the control is in editing mode

Returns

MultilineEditControlBuilder

The builder for chaining

NoWrap()

Disables text wrapping

public MultilineEditControlBuilder NoWrap()

Returns

MultilineEditControlBuilder

The builder for chaining

OnContentChanged(WindowEventHandler<string>)

Sets the content changed event handler with window access

public MultilineEditControlBuilder OnContentChanged(WindowEventHandler<string> handler)

Parameters

handler WindowEventHandler<string>

Handler that receives sender, content, and window

Returns

MultilineEditControlBuilder

The builder for chaining

OnContentChanged(EventHandler<string>)

Sets the content changed event handler

public MultilineEditControlBuilder OnContentChanged(EventHandler<string> handler)

Parameters

handler EventHandler<string>

The event handler

Returns

MultilineEditControlBuilder

The builder for chaining

OnGotFocus(WindowEventHandler<EventArgs>)

Sets the got focus event handler with window access

public MultilineEditControlBuilder OnGotFocus(WindowEventHandler<EventArgs> handler)

Parameters

handler WindowEventHandler<EventArgs>

Handler that receives sender, event data, and window

Returns

MultilineEditControlBuilder

The builder for chaining

OnGotFocus(EventHandler)

Sets the got focus event handler

public MultilineEditControlBuilder OnGotFocus(EventHandler handler)

Parameters

handler EventHandler

The event handler

Returns

MultilineEditControlBuilder

The builder for chaining

OnLostFocus(WindowEventHandler<EventArgs>)

Sets the lost focus event handler with window access

public MultilineEditControlBuilder OnLostFocus(WindowEventHandler<EventArgs> handler)

Parameters

handler WindowEventHandler<EventArgs>

Handler that receives sender, event data, and window

Returns

MultilineEditControlBuilder

The builder for chaining

OnLostFocus(EventHandler)

Sets the lost focus event handler

public MultilineEditControlBuilder OnLostFocus(EventHandler handler)

Parameters

handler EventHandler

The event handler

Returns

MultilineEditControlBuilder

The builder for chaining

Visible(bool)

Sets the visibility

public MultilineEditControlBuilder Visible(bool visible = true)

Parameters

visible bool

Whether the control is visible

Returns

MultilineEditControlBuilder

The builder for chaining

WithAlignment(HorizontalAlignment)

Sets the horizontal alignment

public MultilineEditControlBuilder WithAlignment(HorizontalAlignment alignment)

Parameters

alignment HorizontalAlignment

The horizontal alignment

Returns

MultilineEditControlBuilder

The builder for chaining

WithBackgroundColor(Color)

Sets the background color

public MultilineEditControlBuilder WithBackgroundColor(Color color)

Parameters

color Color

The background color

Returns

MultilineEditControlBuilder

The builder for chaining

WithBorderColor(Color)

Sets the border color

public MultilineEditControlBuilder WithBorderColor(Color color)

Parameters

color Color

The border color

Returns

MultilineEditControlBuilder

The builder for chaining

WithColors(Color, Color)

Sets the background and foreground colors

public MultilineEditControlBuilder WithColors(Color foreground, Color background)

Parameters

foreground Color

The foreground color

background Color

The background color

Returns

MultilineEditControlBuilder

The builder for chaining

WithContent(string)

Sets the initial content

public MultilineEditControlBuilder WithContent(string content)

Parameters

content string

The text content

Returns

MultilineEditControlBuilder

The builder for chaining

WithContentLines(IEnumerable<string>)

Sets the initial content from multiple lines

public MultilineEditControlBuilder WithContentLines(IEnumerable<string> lines)

Parameters

lines IEnumerable<string>

The content lines

Returns

MultilineEditControlBuilder

The builder for chaining

WithContentLines(params string[])

Sets the initial content from multiple lines

public MultilineEditControlBuilder WithContentLines(params string[] lines)

Parameters

lines string[]

The content lines

Returns

MultilineEditControlBuilder

The builder for chaining

WithFocusedColors(Color, Color)

Sets the focused background and foreground colors

public MultilineEditControlBuilder WithFocusedColors(Color foreground, Color background)

Parameters

foreground Color

The focused foreground color

background Color

The focused background color

Returns

MultilineEditControlBuilder

The builder for chaining

WithForegroundColor(Color)

Sets the foreground color

public MultilineEditControlBuilder WithForegroundColor(Color color)

Parameters

color Color

The foreground color

Returns

MultilineEditControlBuilder

The builder for chaining

WithHorizontalScrollbar(ScrollbarVisibility)

Sets the horizontal scrollbar visibility

public MultilineEditControlBuilder WithHorizontalScrollbar(ScrollbarVisibility visibility)

Parameters

visibility ScrollbarVisibility

The scrollbar visibility

Returns

MultilineEditControlBuilder

The builder for chaining

WithMargin(int)

Sets uniform margin

public MultilineEditControlBuilder WithMargin(int margin)

Parameters

margin int

The margin value for all sides

Returns

MultilineEditControlBuilder

The builder for chaining

WithMargin(int, int, int, int)

Sets the margin

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

MultilineEditControlBuilder

The builder for chaining

WithName(string)

Sets the control name for lookup

public MultilineEditControlBuilder WithName(string name)

Parameters

name string

The control name

Returns

MultilineEditControlBuilder

The builder for chaining

WithScrollbarColors(Color, Color)

Sets the scrollbar colors

public MultilineEditControlBuilder WithScrollbarColors(Color trackColor, Color thumbColor)

Parameters

trackColor Color

The scrollbar track color

thumbColor Color

The scrollbar thumb color

Returns

MultilineEditControlBuilder

The builder for chaining

WithSelectionColors(Color, Color)

Sets the selection background and foreground colors

public MultilineEditControlBuilder WithSelectionColors(Color foreground, Color background)

Parameters

foreground Color

The selection foreground color

background Color

The selection background color

Returns

MultilineEditControlBuilder

The builder for chaining

WithStickyPosition(StickyPosition)

Sets the sticky position

public MultilineEditControlBuilder WithStickyPosition(StickyPosition position)

Parameters

position StickyPosition

The sticky position

Returns

MultilineEditControlBuilder

The builder for chaining

WithTag(object)

Sets a tag object

public MultilineEditControlBuilder WithTag(object tag)

Parameters

tag object

The tag object

Returns

MultilineEditControlBuilder

The builder for chaining

WithVerticalAlignment(VerticalAlignment)

Sets the vertical alignment

public MultilineEditControlBuilder WithVerticalAlignment(VerticalAlignment alignment)

Parameters

alignment VerticalAlignment

The vertical alignment

Returns

MultilineEditControlBuilder

The builder for chaining

WithVerticalScrollbar(ScrollbarVisibility)

Sets the vertical scrollbar visibility

public MultilineEditControlBuilder WithVerticalScrollbar(ScrollbarVisibility visibility)

Parameters

visibility ScrollbarVisibility

The scrollbar visibility

Returns

MultilineEditControlBuilder

The builder for chaining

WithViewportHeight(int)

Sets the viewport height (number of visible lines)

public MultilineEditControlBuilder WithViewportHeight(int height)

Parameters

height int

The viewport height

Returns

MultilineEditControlBuilder

The builder for chaining

WithWidth(int)

Sets the width

public MultilineEditControlBuilder WithWidth(int width)

Parameters

width int

The control width

Returns

MultilineEditControlBuilder

The builder for chaining

WithWrapMode(WrapMode)

Sets the wrap mode

public MultilineEditControlBuilder WithWrapMode(WrapMode mode)

Parameters

mode WrapMode

The wrap mode

Returns

MultilineEditControlBuilder

The builder for chaining

WrapCharacters()

Enables character wrapping

public MultilineEditControlBuilder WrapCharacters()

Returns

MultilineEditControlBuilder

The builder for chaining

WrapWords()

Enables word wrapping

public MultilineEditControlBuilder WrapWords()

Returns

MultilineEditControlBuilder

The builder for chaining

Operators

implicit operator MultilineEditControl(MultilineEditControlBuilder)

Implicit conversion to MultilineEditControl

public static implicit operator MultilineEditControl(MultilineEditControlBuilder builder)

Parameters

builder MultilineEditControlBuilder

The builder

Returns

MultilineEditControl

The built multiline edit control

Edit this page