Class FlowControl

Namespace

SharpConsoleUI.Controls

Assembly

SharpConsoleUI.dll

A container control that renders a single flow step inline — a banner band on top, a scrollable body in the middle, and a button toolbar at the bottom — instead of opening a modal window per step. It is the in-control counterpart to ModalWindowHost / SwapContentHost: drive it via AsHost() to present flow steps that live inside an existing window's layout.

public class FlowControl : GridControl, IDOMPaintable, INotifyPropertyChanged, IContainer, IContainerControl, IControlHost, IColorRoleableControl, IGridSource, IFillReportsMinimumHeight, IInteractiveControl, IFocusableControl, IMouseAwareControl, IWindowControl, IDisposable, IFocusScope, ILogicalCursorProvider, ICursorShapeProvider

Inheritance

object

BaseControl

GridControl

FlowControl

Implements

IDOMPaintable

INotifyPropertyChanged

IContainer

IContainerControl

IControlHost

IColorRoleableControl

IGridSource

IFillReportsMinimumHeight

IInteractiveControl

IFocusableControl

IMouseAwareControl

IWindowControl

IDisposable

IFocusScope

ILogicalCursorProvider

ICursorShapeProvider

Derived

WizardControl

Inherited Members

GridControl.AnimateColumnWidth(int, int, TimeSpan, EasingFunction)

GridControl.AnimateRowHeight(int, int, TimeSpan, EasingFunction)

GridControl.GetColumnArrangedWidth(int)

GridControl.GetRowArrangedHeight(int)

GridControl.ColorRole

GridControl.ColorRoleMode

GridControl.Outline

GridControl.BackgroundColor

GridControl.ForegroundColor

GridControl.RowDefinitions

GridControl.ColumnDefinitions

GridControl.RowGap

GridControl.ColumnGap

GridControl.Padding

GridControl.ContentSizedStars

GridControl.StarTracksSelfSizeToContentInMeasure

GridControl.OrderedCells

GridControl.Place(IWindowControl, int, int, int, int)

GridControl.this[int, int]

GridControl.Cell(int, int)

GridControl.AddControl(IWindowControl)

GridControl.RemoveControl(IWindowControl)

GridControl.ClearControls()

GridControl.ReplaceControl(IWindowControl, IWindowControl)

GridControl.RemoveAt(int, int)

GridControl.Children

GridControl.GetChildren()

GridControl.ContentWidth

GridControl.MeasureDOM(LayoutConstraints)

GridControl.PaintDOM(CharacterBuffer, LayoutRect, LayoutRect, Color, Color)

GridControl.GetConsoleWindowSystem

GridControl.Invalidate(Invalidation, IWindowControl)

GridControl.GetVisibleHeightForControl(IWindowControl)

GridControl.OnDisposing()

GridControl.MouseClick

GridControl.MouseDoubleClick

GridControl.MouseRightClick

GridControl.MouseEnter

GridControl.MouseLeave

GridControl.MouseMove

GridControl.IsEnabled

GridControl.HasFocus

GridControl.CanReceiveFocus

GridControl.PreferredCursorShape

GridControl.GetFocusedChildFromCoordinator()

GridControl.ProcessKey(ConsoleKeyInfo)

GridControl.GetLogicalCursorPosition()

GridControl.SetLogicalCursorPosition(Point)

GridControl.WantsMouseEvents

GridControl.CanFocusWithMouse

GridControl.ProcessMouseEvent(MouseEventArgs)

GridControl.SavedFocus

GridControl.GetInitialFocus(bool)

GridControl.GetNextFocus(IFocusableControl, bool)

GridControl.GetFocusableChildren()

GridControl.ShowColumnGridlines

GridControl.ShowRowGridlines

GridControl.GridlineStyle

GridControl.GridlineColor

GridControl.AddGridlineAfterColumn(int)

GridControl.AddGridlineAfterRow(int)

GridControl.RemoveGridlineAfterColumn(int)

GridControl.RemoveGridlineAfterRow(int)

GridControl.HasGridlineAfterColumn(int)

GridControl.HasGridlineAfterRow(int)

GridControl.ClearGridlines()

GridControl.AddColumnSplitterAfter(int)

GridControl.AddRowSplitterAfter(int)

GridControl.HasColumnSplitterAfter(int)

GridControl.HasRowSplitterAfter(int)

GridControl.RemoveColumnSplitterAfter(int)

GridControl.RemoveRowSplitterAfter(int)

GridControl.ClearSplitters()

GridControl.FocusColumnSplitter(int)

GridControl.FocusRowSplitter(int)

GridControl.ClearActiveSplitter()

GridControl.SplitterColor

GridControl.SplitterFocusedBackground

GridControl.SplitterFocusedForeground

GridControl.SplitterDraggingBackground

GridControl.SplitterDraggingForeground

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.Margin

BaseControl.StickyPosition

BaseControl.Name

BaseControl.Tag

BaseControl.Visible

BaseControl.Width

BaseControl.Height

BaseControl.GetLogicalContentSize()

BaseControl.Invalidate(Invalidation)

BaseControl.Invalidate()

BaseControl.Invalidate(bool)

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

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

WindowControlExtensions.RequestFocus(IFocusableControl, FocusReason)

WindowControlExtensions.GetParentWindow(IWindowControl)

WindowControlExtensions.GetPortalAncestor(IWindowControl)

Remarks

Composition. A FlowControl is a three-row GridControl (Auto top band / Star body / Auto bottom band) with a flow-presentation API. It subclasses GridControl rather than wrapping one, so it inherits — for free and without any change to the layout/focus/mouse core — full child hosting: cell children participate in the layout tree, take focus and Tab order, route mouse clicks, and report a cursor. This is why a button rendered into the bottom band is reachable and clickable inside the control.

Threading. ShowStep(IReadOnlyList<IWindowControl>, IWindowControl, IReadOnlyList<IWindowControl>, string) mutates the grid and so must run on the UI thread; the inline host marshals its call via ConsoleWindowSystem.EnqueueOnUIThread.

Constructors

FlowControl()

Initializes a new, empty FlowControl. The control shows nothing until a step is presented through AsHost() or one of the Run overloads.

public FlowControl()

Properties

Container

Overrides the Container setter to detect removal from the parent while a flow is running. When the control is detached (value is null) and a flow is in progress, the per-run cancellation token is cancelled so the flow observes OperationCanceledException and resolves as Cancelled instead of hanging indefinitely. The inline host's in-flight step is also resolved promptly (with Cancel) so the pending await unblocks immediately rather than only on the next token-observing await.

public override IContainer? Container { get; set; }

Property Value

IContainer

Placeholder

Gets or sets the control displayed when the FlowControl is idle (before any Run call) and after a flow has ended. When null the control renders empty in those states. Setting this property while the control is idle immediately updates the displayed content; setting it during a running flow stores the value for restoration when the flow ends.

public IWindowControl? Placeholder { get; set; }

Property Value

IWindowControl

Methods

AsHost()

Returns the IFlowHost that presents flow steps inside this control. The same host instance is returned on every call, so steps presented through it share this one control.

public IFlowHost AsHost()

Returns

IFlowHost

The control's inline flow host.

Run(Func<FlowContext, Task>)

Runs an imperative flow body that produces no payload inline inside this control. The returned FlowResult<T> carries bool with Value set to true on completion.

public Task<FlowResult<bool>> Run(Func<FlowContext, Task> body)

Parameters

body Func<FlowContext, Task>

The flow body; receives a FlowContext.

Returns

Task<FlowResult<bool>>

A FlowResult<T> of bool, with Value == true on completion.

Exceptions

InvalidOperationException

Thrown synchronously when a flow is already running on this control (re-entrancy guard), or when the control has not yet been added to a window in a ConsoleWindowSystem.

Run<TState>(FlowWizardBuilder<TState>)

Runs a declarative wizard inline inside this control. Every step is presented inside this control instead of opening a modal window per step.

public Task<FlowResult<TState>> Run<TState>(FlowWizardBuilder<TState> wizard) where TState : new()

Parameters

wizard FlowWizardBuilder<TState>

The configured FlowWizardBuilder<TState> to run.

Returns

Task<FlowResult<TState>>

The wizard outcome carrying the final state on completion.

Type Parameters

TState

The mutable wizard state type.

Exceptions

InvalidOperationException

Thrown synchronously when a flow is already running on this control (re-entrancy guard), or when the control has not yet been added to a window in a ConsoleWindowSystem.

Run<T>(Func<FlowContext, Task<T>>)

Runs an imperative flow body that produces a typed value inline inside this control. The body receives a FlowContext and returns the flow's value; each step is presented inside this control (no modal window is opened).

public Task<FlowResult<T>> Run<T>(Func<FlowContext, Task<T>> body)

Parameters

body Func<FlowContext, Task<T>>

The flow body; receives a FlowContext and returns the flow's value.

Returns

Task<FlowResult<T>>

A FlowResult<T> carrying the body's value on completion, cancelled when the body throws OperationCanceledException, or faulted for any other exception.

Type Parameters

T

The value type produced by the flow body on completion.

Exceptions

InvalidOperationException

Thrown synchronously when a flow is already running on this control (re-entrancy guard), or when the control has not yet been added to a window in a ConsoleWindowSystem.