C# Class Nexus.UI.Controls.WizardControl

Inheritance: VerticalTabControl

Show file Open project: NexusMods/NexusModManager-4.5 Class Usage Examples

Private Properties

Property	Type	Description
Cancel_Click	void
Next_Click	void
Previous_Click	void

Public Methods

Method	Description
WizardControl ( ) : System	The default constructor.

Protected Methods

Method	Description
MovePage ( Int32 p_intJumpSize ) : void	This navigates to the page whose index is p_intJumpSize away from the current page's index. This makes sure that the selected index resulting from the jump is never out of bounds. It also enables/disables buttons and changes button text as appropriate.
OnControlAdded ( System.Windows.Forms.ControlEventArgs e ) : void	Raises the Control.ControlAdded event. This ensures that the wizard buttons are enabled/disabled correctly.
OnControlRemoved ( System.Windows.Forms.ControlEventArgs e ) : void	Raises the Control.ControlRemoved event. This ensures that the wizard buttons are enabled/disabled correctly.

Private Methods

Method	Description
Cancel_Click ( object sender, EventArgs e ) : void	Handles the Control.Click event of the cancel button. This raises the Cancelled event.
Next_Click ( object sender, EventArgs e ) : void	Handles the Control.Click event of the next button. This navigates to the next page, if there is one.
Previous_Click ( object sender, EventArgs e ) : void	Handles the Control.Click event of the previous button. This navigates to the previous page, if there is one.

Method Details

MovePage() protected method

This navigates to the page whose index is p_intJumpSize away from the current page's index.

This makes sure that the selected index resulting from the jump is never out of bounds. It also enables/disables buttons and changes button text as appropriate.

protected MovePage ( Int32 p_intJumpSize ) : void
p_intJumpSize	System.Int32	The number of pages to jump.
return	void

OnControlAdded() protected method

Raises the Control.ControlAdded event.

This ensures that the wizard buttons are enabled/disabled correctly.

protected OnControlAdded ( System.Windows.Forms.ControlEventArgs e ) : void
e	System.Windows.Forms.ControlEventArgs	A describing the event arguments.
return	void

OnControlRemoved() protected method

Raises the Control.ControlRemoved event.

This ensures that the wizard buttons are enabled/disabled correctly.

protected OnControlRemoved ( System.Windows.Forms.ControlEventArgs e ) : void
e	System.Windows.Forms.ControlEventArgs	A describing the event arguments.
return	void

WizardControl() public method

The default constructor.

public WizardControl ( ) : System
return	System