Class Wizard.WizardStep

Namespace: Terminal.Gui

Assembly: Terminal.Gui.dll

Represents a basic step that is displayed in a Wizard. The Wizard.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 Wizard.WizardStep : FrameView, IDisposable, ISupportInitializeNotification, ISupportInitialize

Inheritance: object

Responder

View

FrameView

Wizard.WizardStep

Implements: IDisposable

ISupportInitializeNotification

ISupportInitialize

Inherited Members: FrameView.Border

FrameView.Redraw(Rect)

FrameView.Text

FrameView.TextAlignment

FrameView.OnEnter(View)

FrameView.OnCanFocusChanged()

View.Added

View.Removed

View.Enter

View.Leave

View.MouseEnter

View.MouseLeave

View.MouseClick

View.CanFocusChanged

View.EnabledChanged

View.VisibleChanged

View.HotKeyChanged

View.HotKey

View.HotKeySpecifier

View.Shortcut

View.ShortcutTag

View.ShortcutAction

View.Data

View.Driver

View.Subviews

View.TabIndexes

View.TabIndex

View.TabStop

View.CanFocus

View.Id

View.IsCurrentTop

View.WantMousePositionReports

View.WantContinuousButtonPressed

View.Frame

View.LayoutStyle

View.Bounds

View.X

View.Y

View.Width

View.Height

View.ForceValidatePosDim

View.GetMinWidthHeight(out Size)

View.SetMinWidthHeight()

View.TextFormatter

View.SuperView

View.UpdateTextFormatterText()

View.ProcessResizeView()

View.SetNeedsDisplay()

View.ClearLayoutNeeded()

View.SetNeedsDisplay(Rect)

View.SetChildNeedsDisplay()

View.Add(params View[])

View.BringSubviewToFront(View)

View.SendSubviewToBack(View)

View.SendSubviewBackwards(View)

View.BringSubviewForward(View)

View.Clear()

View.Clear(Rect)

View.ScreenToView(int, int)

View.ClipToBounds()

View.SetClip(Rect)

View.DrawFrame(Rect, int, bool)

View.DrawHotString(ustring, Attribute, Attribute)

View.DrawHotString(ustring, bool, ColorScheme)

View.Move(int, int, bool)

View.PositionCursor()

View.HasFocus

View.OnAdded(View)

View.OnRemoved(View)

View.OnLeave(View)

View.Focused

View.MostFocused

View.ColorScheme

View.AddRune(int, int, Rune)

View.ClearNeedsDisplay()

View.DrawContent

View.OnDrawContent(Rect)

View.DrawContentComplete

View.OnDrawContentComplete(Rect)

View.SetFocus()

View.KeyPress

View.ProcessKey(KeyEvent)

View.InvokeKeybindings(KeyEvent)

View.AddKeyBinding(Key, params Command[])

View.ReplaceKeyBinding(Key, Key)

View.ContainsKeyBinding(Key)

View.ClearKeybindings()

View.ClearKeybinding(Key)

View.ClearKeybinding(params Command[])

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

View.GetSupportedCommands()

View.GetKeyFromCommand(params Command[])

View.ProcessHotKey(KeyEvent)

View.ProcessColdKey(KeyEvent)

View.KeyDown

View.OnKeyDown(KeyEvent)

View.KeyUp

View.OnKeyUp(KeyEvent)

View.EnsureFocus()

View.FocusFirst()

View.FocusLast()

View.FocusPrev()

View.FocusNext()

View.LayoutStarted

View.LayoutComplete

View.Initialized

View.LayoutSubviews()

View.AutoSize

View.PreserveTrailingSpaces

View.VerticalTextAlignment

View.TextDirection

View.IsInitialized

View.IsAdded

View.Enabled

View.ClearOnVisibleFalse

View.Visible

View.IgnoreBorderPropertyOnRedraw

View.ToString()

View.GetAutoSize()

View.GetHotKeySpecifierLength(bool)

View.GetTextFormatterBoundsSize()

View.GetBoundsTextFormatterSize()

View.OnMouseEnter(MouseEvent)

View.OnMouseLeave(MouseEvent)

View.OnMouseEvent(MouseEvent)

View.OnMouseClick(View.MouseEventArgs)

View.OnEnabledChanged()

View.OnVisibleChanged()

View.Dispose(bool)

View.BeginInit()

View.EndInit()

View.SetWidth(int, out int)

View.SetHeight(int, out int)

View.GetCurrentWidth(out int)

View.GetCurrentHeight(out int)

View.GetNormalColor()

View.GetFocusColor()

View.GetHotNormalColor()

View.GetTopSuperView()

Responder.MouseEvent(MouseEvent)

Responder.Dispose()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

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(ustring): Initializes a new instance of the Wizard class using Computed positioning.

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

Title: The title of the Wizard.WizardStep.

Methods

Add(View): Add the specified View to the Wizard.WizardStep.

OnTitleChanged(ustring, ustring): Called when the Title has been changed. Invokes the TitleChanged event.

OnTitleChanging(ustring, ustring): Called before the Title changes. Invokes the TitleChanging event, which can be cancelled.

Remove(View): Removes a View from Wizard.WizardStep.

RemoveAll(): Removes all Views from the Wizard.WizardStep.

Events

TitleChanged: Event fired after the Title has been changed.