Class Wizard.WizardStep

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.
Inheritance
System.Object
Responder
View
FrameView
Wizard.WizardStep
Implements
System.IDisposable
System.ComponentModel.ISupportInitializeNotification
System.ComponentModel.ISupportInitialize
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.
Inherited Members
Namespace: Terminal.Gui
Assembly: Terminal.Gui.dll
Syntax
public class WizardStep : FrameView

Constructors

WizardStep(ustring)

Initializes a new instance of the Wizard class using Computed positioning.
Declaration
public WizardStep(ustring title)
Parameters
Type Name Description
NStack.ustring title Title for the Step. Will be appended to the containing Wizard's title as "Wizard Title - Wizard Step Title" when this step is active.

Properties

BackButtonText

Sets or gets the text for the back button. The back button will only be visible on steps after the first step.
Declaration
public ustring BackButtonText { get; set; }
Property Value
Type Description
NStack.ustring

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.
Declaration
public ustring HelpText { get; set; }
Property Value
Type Description
NStack.ustring

NextButtonText

Sets or gets the text for the next/finish button.
Declaration
public ustring NextButtonText { get; set; }
Property Value
Type Description
NStack.ustring

Title

The title of the Wizard.WizardStep.
Declaration
public ustring Title { get; set; }
Property Value
Type Description
NStack.ustring

Methods

Add(View)

Add the specified View to the Wizard.WizardStep.
Declaration
public override void Add(View view)
Parameters
Type Name Description
View view View to add to this container
Overrides

OnTitleChanged(ustring, ustring)

Called when the Title has been changed. Invokes the TitleChanged event.
Declaration
public virtual void OnTitleChanged(ustring oldTitle, ustring newTitle)
Parameters
Type Name Description
NStack.ustring oldTitle The Title that is/has been replaced.
NStack.ustring newTitle The new Title to be replaced.

OnTitleChanging(ustring, ustring)

Called before the Title changes. Invokes the TitleChanging event, which can be cancelled.
Declaration
public virtual bool OnTitleChanging(ustring oldTitle, ustring newTitle)
Parameters
Type Name Description
NStack.ustring oldTitle The Title that is/has been replaced.
NStack.ustring newTitle The new Title to be replaced.
Returns
Type Description
System.Boolean true if an event handler cancelled the Title change.

Remove(View)

Removes a View from Wizard.WizardStep.
Declaration
public override void Remove(View view)
Parameters
Type Name Description
View view
Overrides

RemoveAll()

Removes all Views from the Wizard.WizardStep.
Declaration
public override void RemoveAll()
Overrides

Events

TitleChanged

Event fired after the Title has been changed.
Declaration
public event Action<Wizard.WizardStep.TitleEventArgs> TitleChanged
Event Type
Type Description
System.Action<Wizard.WizardStep.TitleEventArgs>

TitleChanging

Event fired when the Title is changing. Set Cancel to true to cancel the Title change.
Declaration
public event Action<Wizard.WizardStep.TitleEventArgs> TitleChanging
Event Type
Type Description
System.Action<Wizard.WizardStep.TitleEventArgs>

Implements

System.IDisposable
System.ComponentModel.ISupportInitializeNotification
System.ComponentModel.ISupportInitialize