Class PromptControl

Namespace

SharpConsoleUI.Controls

Assembly

SharpConsoleUI.dll

A single-line text input control with optional prompt text. Supports text editing, cursor navigation, and horizontal scrolling for overflow text.

public class PromptControl : BaseControl, IDOMPaintable, INotifyPropertyChanged, IInteractiveControl, IFocusableControl, IMouseAwareControl, IWindowControl, IDisposable, ILogicalCursorProvider, ICursorShapeProvider

Inheritance

object

BaseControl

PromptControl

Implements

IDOMPaintable

INotifyPropertyChanged

IInteractiveControl

IFocusableControl

IMouseAwareControl

IWindowControl

IDisposable

ILogicalCursorProvider

ICursorShapeProvider

Inherited Members

BaseControl.PropertyChanged

BaseControl.GotFocus

BaseControl.LostFocus

BaseControl.Bindings

BaseControl.OnPropertyChanged(string)

BaseControl.SubscribeToFocusManager()

BaseControl.SetProperty<T>(ref T, T, string)

BaseControl.SetProperty<T>(ref T, T, Func<T, T>, string)

BaseControl.ActualX

BaseControl.ActualY

BaseControl.ActualWidth

BaseControl.ActualHeight

BaseControl.HorizontalAlignment

BaseControl.VerticalAlignment

BaseControl.Container

BaseControl.Margin

BaseControl.StickyPosition

BaseControl.Name

BaseControl.Tag

BaseControl.Visible

BaseControl.Width

BaseControl.Height

BaseControl.Invalidate()

BaseControl.SetActualBounds(LayoutRect)

BaseControl.Dispose()

BaseControl.ComputeHasFocus()

BaseControl.ComputeIsInFocusPath()

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Extension Methods

WindowControlExtensions.RequestFocus(IFocusableControl, FocusReason)

WindowControlExtensions.GetParentWindow(IWindowControl)

WindowControlExtensions.GetPortalAncestor(IWindowControl)

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

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

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<TControl, TSource, TValue>(TControl, TSource, Expression<Func<TSource, TValue>>, Expression<Func<TControl, TValue>>)

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

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>)

Properties

CanFocusWithMouse

Whether this control can receive focus via mouse clicks

public bool CanFocusWithMouse { get; }

Property Value

bool

CanReceiveFocus

Whether this control can receive focus

public bool CanReceiveFocus { get; }

Property Value

bool

ContentWidth

Gets the actual rendered width of the control content in characters.

public override int? ContentWidth { get; }

Property Value

int?

HasFocus

public bool HasFocus { get; }

Property Value

bool

HasSelection

Gets whether there is an active text selection.

public bool HasSelection { get; }

Property Value

bool

HistoryEnabled

Gets or sets whether command history is enabled (Up/Down arrow recall).

public bool HistoryEnabled { get; set; }

Property Value

bool

Input

Gets or sets the current input text entered by the user.

public string Input { get; set; }

Property Value

string

InputBackgroundColor

Gets or sets the background color of the input area when not focused.

public Color? InputBackgroundColor { get; set; }

Property Value

Color?

InputFocusedBackgroundColor

Gets or sets the background color of the input area when focused.

public Color? InputFocusedBackgroundColor { get; set; }

Property Value

Color?

InputFocusedForegroundColor

Gets or sets the foreground color of the input text when focused.

public Color? InputFocusedForegroundColor { get; set; }

Property Value

Color?

InputForegroundColor

Gets or sets the foreground color of the input text when not focused.

public Color? InputForegroundColor { get; set; }

Property Value

Color?

InputWidth

Gets or sets the width of the input area in characters. When set, enables horizontal scrolling.

public int? InputWidth { get; set; }

Property Value

int?

IsEnabled

Gets or sets whether this control is enabled and can receive input.

public bool IsEnabled { get; set; }

Property Value

bool

MaskCharacter

Gets or sets a character to display instead of the actual input (for password fields). When null, the actual input is displayed.

public char? MaskCharacter { get; set; }

Property Value

char?

PreferredCursorShape

Gets the preferred cursor shape - always VerticalBar for text input

public CursorShape? PreferredCursorShape { get; }

Property Value

CursorShape?

Prompt

Gets or sets the prompt text displayed before the input area.

public string? Prompt { get; set; }

Property Value

string

SelectedText

Gets the selected text, or null if no selection.

public string? SelectedText { get; }

Property Value

string

TabCompleter

Gets or sets the tab completion delegate. When set, Tab key triggers completion. The delegate receives (input, cursorPosition) and returns completion candidates. When no completions match, Tab passes through to focus traversal.

public Func<string, int, IEnumerable<string>?>? TabCompleter { get; set; }

Property Value

Func<string, int, IEnumerable<string>>

UnfocusOnEnter

Gets or sets whether the control loses focus when Enter is pressed.

public bool UnfocusOnEnter { get; set; }

Property Value

bool

WantsMouseEvents

Whether this control wants to receive mouse events

public bool WantsMouseEvents { get; }

Property Value

bool

WantsTabKey

Whether this control wants Tab key events (for tab completion).

public bool WantsTabKey { get; }

Property Value

bool

Methods

ClearHistory()

Clears the command history.

public void ClearHistory()

GetLogicalContentSize()

Gets the logical size of the control's content without rendering.

public override Size GetLogicalContentSize()

Returns

Size

The size representing the content's natural dimensions.

GetLogicalCursorPosition()

Gets the logical cursor position within the control's content coordinate system. This should be the raw position without any visual adjustments for margins, scrolling, etc.

public Point? GetLogicalCursorPosition()

Returns

Point?

Logical cursor position or null if no cursor.

MeasureDOM(LayoutConstraints)

Measures the control's desired size given the available constraints.

public override LayoutSize MeasureDOM(LayoutConstraints constraints)

Parameters

constraints LayoutConstraints

The layout constraints (min/max width/height).

Returns

LayoutSize

The desired size of the control.

OnDisposing()

Called during Dispose() before Container is set to null. Override to perform control-specific cleanup (null events, close portals, clear data, etc.).

protected override void OnDisposing()

PaintDOM(CharacterBuffer, LayoutRect, LayoutRect, Color, Color)

Paints the control's content directly to a CharacterBuffer.

public override void PaintDOM(CharacterBuffer buffer, LayoutRect bounds, LayoutRect clipRect, Color defaultFg, Color defaultBg)

Parameters

buffer CharacterBuffer

The buffer to paint to.

bounds LayoutRect

The absolute bounds where the control should paint.

clipRect LayoutRect

The clipping rectangle (visible area).

defaultFg Color

defaultBg Color

ProcessKey(ConsoleKeyInfo)

Processes a keyboard input event.

public bool ProcessKey(ConsoleKeyInfo key)

Parameters

key ConsoleKeyInfo

The key information for the pressed key.

Returns

bool

True if the key was handled by this control; otherwise, false.

ProcessMouseEvent(MouseEventArgs)

Processes a mouse event for this control

public bool ProcessMouseEvent(MouseEventArgs args)

Parameters

args MouseEventArgs

Mouse event arguments with control-relative coordinates

Returns

bool

True if the event was handled and should not propagate further

SetInput(string?)

Sets the input text and positions the cursor at the end.

public void SetInput(string? input)

Parameters

input string

The text to set as input.

SetLogicalCursorPosition(Point)

Sets the logical cursor position within the control's content coordinate system.

public void SetLogicalCursorPosition(Point position)

Parameters

position Point

Events

Entered

Event fired when Enter is pressed (modern standardized event)

public event EventHandler<string>? Entered

Event Type

EventHandler<string>

InputChanged

Event fired when input text changes (modern standardized event)

public event EventHandler<string>? InputChanged

Event Type

EventHandler<string>

MouseClick

Event fired when the control is clicked

public event EventHandler<MouseEventArgs>? MouseClick

Event Type

EventHandler<MouseEventArgs>

MouseDoubleClick

Event fired when the control is double-clicked

public event EventHandler<MouseEventArgs>? MouseDoubleClick

Event Type

EventHandler<MouseEventArgs>

MouseEnter

Event fired when the mouse enters the control area

public event EventHandler<MouseEventArgs>? MouseEnter

Event Type

EventHandler<MouseEventArgs>

MouseLeave

Event fired when the mouse leaves the control area

public event EventHandler<MouseEventArgs>? MouseLeave

Event Type

EventHandler<MouseEventArgs>

MouseMove

Event fired when the mouse moves over the control

public event EventHandler<MouseEventArgs>? MouseMove

Event Type

EventHandler<MouseEventArgs>

MouseRightClick

Event fired when the control is right-clicked (Button3)

public event EventHandler<MouseEventArgs>? MouseRightClick

Event Type

EventHandler<MouseEventArgs>