Class WizardControl

Namespace

SharpConsoleUI.Controls

Assembly

SharpConsoleUI.dll

A discoverable, wizard-shaped FlowControl: an embeddable control that runs a multi-step Wizard<TState>() inline inside an existing window's layout (banner + scrollable body + button toolbar), rather than opening a modal window per step.

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

Inheritance

object

BaseControl

GridControl

FlowControl

WizardControl

Implements

IDOMPaintable

INotifyPropertyChanged

IContainer

IContainerControl

IControlHost

IColorRoleableControl

IGridSource

IFillReportsMinimumHeight

IInteractiveControl

IFocusableControl

IMouseAwareControl

IWindowControl

IDisposable

IFocusScope

ILogicalCursorProvider

ICursorShapeProvider

Inherited Members

FlowControl.Placeholder

FlowControl.AsHost()

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

FlowControl.Run(Func<FlowContext, Task>)

FlowControl.Run<TState>(FlowWizardBuilder<TState>)

FlowControl.Container

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

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

Remarks

It IS a FlowControl. WizardControl subclasses FlowControl the same way PanelControl subclasses CollapsiblePanel — a presetted, honestly-named specialization, not a wrapper. It inherits the entire inline-flow surface (rendering, focus/child hosting, AsHost(), the Run<TState>(FlowWizardBuilder<TState>) path, the idle Placeholder). It adds only a wizard-flavoured identity: a discoverable type name (reach for new WizardControl() when you want a wizard) and a wizard-friendly default placeholder. It does not re-implement the wizard loop or re-declare Run — the inherited Run<TState>(FlowWizardBuilder<TState>) is the entry point, unchanged.

Generics live on the builder, not the control. The control is non-generic (so it drops cleanly into the control tree and collections like every other control); the wizard's state type stays on Wizard<TState>() (the builder), where it is used to author strongly typed steps and surfaces as FlowResult<T>.

Scope. WizardControl runs a wizard inline (it is a FlowControl). To run a wizard as a modal instead, use Flow.Wizard<TState>()...Run(ws, parent) directly.

var wiz = new WizardControl();
panel.AddControl(wiz);
var result = await wiz.Run(Flow.Wizard<InstallState>()
    .WithStepIndicator()
    .Step((ctx, s) => ...)
    .Step((ctx, s) => ...));

Constructors

WizardControl()

Initializes a new WizardControl with a wizard-friendly idle placeholder. The placeholder is replaced by the wizard's steps while a wizard is running and restored when it ends; assign Placeholder to override it.

public WizardControl()