Class WizardStep

Namespace

Terminal.Gui

Assembly

Terminal.Gui.dll

Represents a basic step that is displayed in a Wizard. The WizardStep view is divided horizontally in two. On the left is the content view where Views can be added, On the right is the help for the step. Set HelpText to set the help text. If the help text is empty the help pane will not be shown. If there are no Views added to the WizardStep the HelpText (if not empty) will fill the wizard step.

public class WizardStep : View, IDisposable, ISupportInitializeNotification, ISupportInitialize

Inheritance

object

View

WizardStep

Implements

IDisposable

ISupportInitializeNotification

ISupportInitialize

Inherited Members

View.Margin

View.ShadowStyle

View.Border

View.BorderStyle

View.OnBorderStyleChanging(CancelEventArgs<LineStyle>)

View.BorderStyleChanging

View.SetBorderStyle(LineStyle)

View.Padding

View.GetAdornmentsThickness()

View.Arrangement

View.ColorScheme

View.GetFocusColor()

View.GetHotFocusColor()

View.GetHotNormalColor()

View.GetNormalColor()

View.SetAttribute(Attribute)

View.GetAttribute()

View.RaiseAccepting(ICommandContext)

View.OnAccepting(CommandEventArgs)

View.Accepting

View.RaiseSelecting(ICommandContext)

View.OnSelecting(CommandEventArgs)

View.Selecting

View.RaiseHandlingHotKey()

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)

View.SetContentSize(Size?)

View.GetContentSize()

View.ContentSizeTracksViewport

View.OnContentSizeChanged(SizeChangedEventArgs)

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.ScreenToViewport(in Point)

View.GetViewportOffsetFromFrame()

View.ScrollVertical(int)

View.ScrollHorizontal(int)

View.Data

View.Id

View.Driver

View.Initialized

View.IsInitialized

View.BeginInit()

View.EndInit()

View.Enabled

View.EnabledChanged

View.OnEnabledChanged()

View.Visible

View.OnVisibleChanging()

View.VisibleChanging

View.OnVisibleChanged()

View.VisibleChanged

View.Title

View.OnTitleChanged()

View.OnTitleChanging(ref string)

View.TitleChanged

View.TitleChanging

View.ToString()

View.Dispose(bool)

View.Disposing

View.Dispose()

View.CursorVisibility

View.PositionCursor()

View.Diagnostics

View.GetClip()

View.SetClip(Region)

View.SetClipToScreen()

View.ExcludeFromClip(Rectangle)

View.ClipViewport()

View.Draw()

View.DrawBorderAndPadding()

View.OnDrawingBorderAndPadding()

View.OnSettingAttribute()

View.SettingAttribute

View.SetNormalAttribute()

View.OnClearingViewport()

View.ClearingViewport

View.ClearViewport()

View.OnDrawingText()

View.DrawingText

View.DrawText()

View.OnDrawingContent()

View.DrawingContent

View.OnDrawingSubviews()

View.DrawingSubviews

View.DrawSubviews()

View.OnRenderingLineCanvas()

View.LineCanvas

View.SuperViewRendersLineCanvas

View.RenderLineCanvas()

View.OnDrawComplete()

View.DrawComplete

View.NeedsDraw

View.SubViewNeedsDraw

View.SetNeedsDraw()

View.SetNeedsDraw(Rectangle)

View.SetSubViewNeedsDraw()

View.ClearNeedsDraw()

View.Move(int, int)

View.AddRune(Rune)

View.AddRune(char)

View.AddRune(int, int, Rune)

View.AddStr(string)

View.DrawHotString(string, Attribute, Attribute)

View.DrawHotString(string, bool)

View.FillRect(Rectangle, Color?)

View.FillRect(Rectangle, Rune)

View.Subviews

View.SuperView

View.IsAdded

View.Add(params View[])

View.Added

View.OnAdded(SuperViewChangedEventArgs)

View.OnRemoved(SuperViewChangedEventArgs)

View.Removed

View.GetTopSuperView(View, View)

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.NewKeyDownEvent(Key)

View.OnKeyDown(Key)

View.KeyDown

View.OnKeyDownNotHandled(Key)

View.KeyDownNotHandled

View.NewKeyUpEvent(Key)

View.OnKeyUp(Key)

View.KeyUp

View.KeyBindings

View.HotKeyBindings

View.DoInvokeCommands(Key)

View.InvokeCommandsBoundToHotKey(Key)

View.Contains(in Point)

View.Frame

View.OnFrameChanged(in Rectangle)

View.FrameChanged

View.FrameToScreen()

View.ScreenToFrame(in Point)

View.X

View.Y

View.Height

View.Width

View.Layout(Size)

View.Layout()

View.SetRelativeLayout(Size)

View.OnSubviewLayout(LayoutEventArgs)

View.SubviewLayout

View.OnSubviewsLaidOut(LayoutEventArgs)

View.SubviewsLaidOut

View.NeedsLayout

View.SetNeedsLayout()

View.ValidatePosDim

View.MouseBindings

View.InvokeCommandsBoundToMouse(MouseEventArgs)

View.OnMouseEnter(CancelEventArgs)

View.MouseEnter

View.OnMouseLeave()

View.MouseLeave

View.WantContinuousButtonPressed

View.WantMousePositionReports

View.NewMouseEvent(MouseEventArgs)

View.RaiseMouseEvent(MouseEventArgs)

View.OnMouseEvent(MouseEventArgs)

View.MouseEvent

View.RaiseMouseClickEvent(MouseEventArgs)

View.OnMouseClick(MouseEventArgs)

View.MouseClick

View.RaiseMouseWheelEvent(MouseEventArgs)

View.OnMouseWheel(MouseEventArgs)

View.MouseWheel

View.HighlightStyle

View.OnHighlight(CancelEventArgs<HighlightStyle>)

View.Highlight

View.AdvanceFocus(NavigationDirection, TabBehavior?)

View.OnAdvancingFocus(NavigationDirection, TabBehavior?)

View.AdvancingFocus

View.CanFocus

View.CanFocusChanged

View.FocusDeepest(NavigationDirection, TabBehavior?)

View.Focused

View.IsCurrentTop

View.MostFocused

View.OnCanFocusChanged()

View.HasFocus

View.SetFocus()

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

View.HasFocusChanging

View.OnHasFocusChanged(bool, View, View)

View.HasFocusChanged

View.TabStop

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)

Remarks

If Buttons are added, do not set IsDefault to true as this will conflict with the Next button of the Wizard. Subscribe to the VisibleChanged event to be notified when the step is active; see also: StepChanged. To enable or disable a step from being shown to the user, set Enabled.

Constructors

WizardStep()

Initializes a new instance of the Wizard class.

Properties

BackButtonText

Sets or gets the text for the back button. The back button will only be visible on steps after the first step.

HelpText

Sets or gets help text for the WizardStep.If HelpText is empty the help pane will not be visible and the content will fill the entire WizardStep.

NextButtonText

Sets or gets the text for the next/finish button.

Methods

Add(View)

Add the specified View to the WizardStep.

Remove(View)

Removes a View from WizardStep.

RemoveAll()

Removes all Views from the WizardStep.