Class WizardStep

Namespace

Terminal.Gui.Views

Assembly

Terminal.Gui.dll

A single step in a Wizard. Can contain arbitrary Views and display help text in the right Padding.

public class WizardStep : View, IDisposable, ISupportInitializeNotification, ISupportInitialize, IDesignable

Inheritance

object

View

WizardStep

Implements

IDisposable

ISupportInitializeNotification

ISupportInitialize

IDesignable

Inherited Members

View.Margin

View.ShadowStyle

View.Border

View.BorderStyle

View.OnBorderStyleChanged()

View.BorderStyleChanged

View.Padding

View.GetAdornmentsThickness()

View.Arrangement

View.RaiseCommandNotBound(ICommandContext)

View.OnCommandNotBound(CommandEventArgs)

View.CommandNotBound

View.RaiseAccepting(ICommandContext)

View.OnAccepting(CommandEventArgs)

View.Accepting

View.RaiseAccepted(ICommandContext)

View.OnAccepted(CommandEventArgs)

View.Accepted

View.RaiseActivating(ICommandContext)

View.OnActivating(CommandEventArgs)

View.Activating

View.RaiseHandlingHotKey(ICommandContext)

View.OnHandlingHotKey(CommandEventArgs)

View.HandlingHotKey

View.AddCommand(Command, View.CommandImplementation)

View.AddCommand(Command, Func<bool?>)

View.GetSupportedCommands()

View.InvokeCommands<TBindingType>(Command[], TBindingType)

View.InvokeCommand<TBindingType>(Command, TBindingType)

View.InvokeCommand(Command, ICommandContext)

View.InvokeCommand(Command)

View.SetContentSize(Size?)

View.GetContentSize()

View.GetWidthRequiredForSubViews()

View.GetHeightRequiredForSubViews()

View.ContentSizeTracksViewport

View.OnContentSizeChanging(ValueChangingEventArgs<Size?>)

View.OnContentSizeChanged(ValueChangedEventArgs<Size?>)

View.ContentSizeChanging

View.ContentSizeChanged

View.ContentToScreen(in Point)

View.ScreenToContent(in Point)

View.ViewportSettings

View.Viewport

View.ViewportChanged

View.OnViewportChanged(DrawEventArgs)

View.ViewportToScreen(in Rectangle)

View.ViewportToScreen(in Point)

View.ViewportToScreen()

View.ScreenToViewport(in Point)

View.GetViewportOffsetFromFrame()

View.ScrollVertical(int)

View.ScrollHorizontal(int)

View.Dispose()

View.Disposing

View.ToString()

View.Dispose(bool)

View.Data

View.Id

View.App

View.GetApp()

View.GetDriver()

View.ScreenContents

View.Initialized

View.IsInitialized

View.BeginInit()

View.Enabled

View.EnabledChanged

View.OnEnabledChanged()

View.Visible

View.OnVisibleChanging()

View.VisibleChanging

View.OnVisibleChanged()

View.VisibleChanged

View.Title

View.OnTitleChanging(ref string)

View.TitleChanging

View.OnTitleChanged()

View.TitleChanged

View.CursorVisibility

View.PositionCursor()

View.Diagnostics

View.GetCurrentAttribute()

View.GetAttributeForRole(VisualRole)

View.OnGettingAttributeForRole(in VisualRole, ref Attribute)

View.GettingAttributeForRole

View.SetAttribute(Attribute)

View.SetAttributeForRole(VisualRole)

View.GetClip()

View.SetClip(Region)

View.SetClipToScreen()

View.ExcludeFromClip(Rectangle)

View.ExcludeFromClip(Region)

View.AddViewportToClip()

View.Draw(DrawContext)

View.DrawAdornments()

View.OnDrawingAdornments()

View.OnClearingViewport()

View.ClearingViewport

View.OnClearedViewport()

View.ClearedViewport

View.ClearViewport(DrawContext)

View.OnDrawingText(DrawContext)

View.OnDrawingText()

View.DrawingText

View.DrawText(DrawContext)

View.OnDrewText()

View.DrewText

View.OnDrawingContent(DrawContext)

View.DrawingContent

View.OnDrawingSubViews(DrawContext)

View.OnDrawingSubViews()

View.DrawingSubViews

View.DrawSubViews(DrawContext)

View.OnRenderingLineCanvas()

View.LineCanvas

View.SuperViewRendersLineCanvas

View.RenderLineCanvas(DrawContext)

View.OnDrawComplete(DrawContext)

View.DrawComplete

View.Move(int, int)

View.AddRune(Rune)

View.AddRune(char)

View.AddRune(int, int, Rune)

View.AddStr(string)

View.AddStr(int, int, string)

View.DrawHotString(string, Attribute, Attribute)

View.DrawHotString(string, bool)

View.FillRect(Rectangle, Color?)

View.FillRect(Rectangle, Rune)

View.SchemeName

View.OnSchemeNameChanging(ValueChangingEventArgs<string>)

View.OnSchemeNameChanged(ValueChangedEventArgs<string>)

View.SchemeNameChanging

View.SchemeNameChanged

View.HasScheme

View.GetScheme()

View.OnGettingScheme(out Scheme)

View.GettingScheme

View.SetScheme(Scheme)

View.OnSettingScheme(ValueChangingEventArgs<Scheme>)

View.OnSchemeChanged(ValueChangedEventArgs<Scheme>)

View.SchemeChanging

View.SchemeChanged

View.SubViews

View.GetSubViews(bool, bool, bool)

View.SuperView

View.OnSuperViewChanging(ValueChangingEventArgs<View>)

View.SuperViewChanging

View.OnSuperViewChanged(ValueChangedEventArgs<View>)

View.SuperViewChanged

View.Add(View)

View.Add(params View[])

View.OnSubViewAdded(View)

View.SubViewAdded

View.Remove(View)

View.OnSubViewRemoved(View)

View.SubViewRemoved

View.RemoveAll()

View.RemoveAll<TView>()

View.Removed

View.IsInHierarchy(View, View, bool)

View.MoveSubViewTowardsEnd(View)

View.MoveSubViewToEnd(View)

View.MoveSubViewTowardsStart(View)

View.MoveSubViewToStart(View)

View.HotKeyChanged

View.HotKey

View.AddKeyBindingsForHotKey(Key, Key, object)

View.HotKeySpecifier

View.AssignHotKeys

View.UsedHotKeys

View.AssignHotKeysToSubViews()

View.AssignHotKeyToView(View)

View.NewKeyDownEvent(Key)

View.OnKeyDown(Key)

View.KeyDown

View.OnKeyDownNotHandled(Key)

View.KeyDownNotHandled

View.KeyBindings

View.HotKeyBindings

View.Contains(in Point)

View.Frame

View.FrameChanged

View.FrameToScreen()

View.ScreenToFrame(in Point)

View.X

View.Y

View.Height

View.OnHeightChanging(ValueChangingEventArgs<Dim>)

View.OnHeightChanged(ValueChangedEventArgs<Dim>)

View.HeightChanging

View.HeightChanged

View.Width

View.OnWidthChanging(ValueChangingEventArgs<Dim>)

View.OnWidthChanged(ValueChangedEventArgs<Dim>)

View.WidthChanging

View.WidthChanged

View.Layout(Size)

View.Layout()

View.SetRelativeLayout(Size)

View.OnSubViewLayout(LayoutEventArgs)

View.SubViewLayout

View.OnSubViewsLaidOut(LayoutEventArgs)

View.SubViewsLaidOut

View.NeedsLayout

View.SetNeedsLayout()

View.GetContainerSize()

View.GetViewsUnderLocation(in Point, ViewportSettingsFlags)

View.ValidatePosDim

View.MouseBindings

View.OnMouseEnter(CancelEventArgs)

View.MouseEnter

View.OnMouseLeave()

View.MouseLeave

View.MouseHoldRepeat

View.OnMouseHoldRepeatChanging(ValueChangingEventArgs<MouseFlags?>)

View.MouseHoldRepeatChanging

View.OnMouseHoldRepeatChanged(ValueChangedEventArgs<MouseFlags?>)

View.MouseHoldRepeatChanged

View.MousePositionTracking

View.NewMouseEvent(Mouse)

View.RaiseMouseEvent(Mouse)

View.OnMouseEvent(Mouse)

View.MouseEvent

View.RaiseCommandsBoundToButtonFlags(Mouse)

View.RaiseCommandsBoundToWheelFlags(Mouse)

View.InvokeCommandsBoundToMouse(Mouse)

View.MouseState

View.MouseHighlightStates

View.OnMouseStateChanged(EventArgs<MouseState>)

View.MouseStateChanged

View.AdvanceFocus(NavigationDirection, TabBehavior?)

View.OnAdvancingFocus(NavigationDirection, TabBehavior?)

View.AdvancingFocus

View.CanFocus

View.CanFocusChanged

View.FocusDeepest(NavigationDirection, TabBehavior?)

View.Focused

View.OnFocusedChanged(View, View)

View.FocusedChanged

View.IsCurrentTop

View.MostFocused

View.OnCanFocusChanged()

View.ClearFocus()

View.HasFocus

View.SetFocus()

View.OnHasFocusChanging(bool, bool, View, View)

View.HasFocusChanging

View.OnHasFocusChanged(bool, View, View)

View.HasFocusChanged

View.TabStop

View.NeedsDraw

View.SetNeedsDraw()

View.SetNeedsDraw(Rectangle)

View.HorizontalScrollBar

View.VerticalScrollBar

View.OnTextChanged()

View.PreserveTrailingSpaces

View.Text

View.TextAlignment

View.TextChanged

View.TextDirection

View.TextFormatter

View.VerticalTextAlignment

View.UpdateTextFormatterText()

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

Extension Methods

ViewRunnableExtensions.AsRunnable<TView>(TView)

ViewRunnableExtensions.AsRunnable<TView, TResult>(TView, Func<TView, TResult?>)

Remarks

Do not set IsDefault on added buttons (conflicts with Wizard navigation). Use VisibleChanged or StepChanged to detect when this step becomes active. Set Enabled to control whether the step is shown.

Constructors

WizardStep()

Initializes a new instance of the WizardStep class.

Properties

BackButtonText

The text for the Back button. Defaults to "Back".

HelpText

The help text displayed in the right Padding. If empty, the right padding is hidden and content fills the entire step.

NextButtonText

The text for the Next/Finish button. Defaults to "Next..." or "Finish" based on position.

Methods

EndInit()

Signals the View that initialization is ending. See ISupportInitialize.

OnFrameChanged(in Rectangle)

Called when Frame changes.