GN Wizard Framework

• Download demo project and source - 367 Kb

Introduction

This article will help you give your application a common wizard interface. One of the main reasons wizards were invented was to make common tasks easier to work with.

Background

The idea for my wizard came soon after I realized I was reproducing code to do the same thing again and again! As working with database applications is my main job, the need for wizard based procedures kept arising more and more. I felt the need to create a common wizard interface to suit my needs.

Implementation

Just drop the WizardTemplate control on a form, and you are ready to go.

Usage

• Add the control to the toolbox (GNWizardFrameWork.dll).
• Drop the WizardTemplate on a WinForm.
• Add the pages
• You are done!

Points of interest

The wizard component is written in VB.NET and inherits from UserControl. Attached to the wizard is a 3DLine control.

Page Layouts

Wizards usually have two different page layouts, one for exterior pages (the main/welcome page), and one for interior pages (the individual steps within the first and last pages).

Exterior Pages

Exterior pages usually have a sidebar graphic with a boxed logo. The GNWizardFramework doesn't support this; instead, I have made the exterior page as a blank canvas so the developer can set the complete layout, and not be limited to having a sidebar they might not want.

Interior Pages

The interior pages are pretty much the same as the exterior pages except for a few minor alterations. Firstly, as exterior pages fill the whole wizard except for the button bar based at the bottom of the wizard, the interior pages have a header panel, and the working panel locations is compensated by a header.

PageStyle enum

• eWPS_Interior

  The wizard and page should be formatted as an interior page.

• eWPS_Exterior

  The wizard and page should be formatted as an exterior page.

How the code is brought together

The wizard consists of three classes and two controls:

Handling buttons

All pages (interior and exterior) have their own button handlers. Buttons can be accessed by the page you want to change or set:

WelcomePage.HasNextButton = True
WelcomePage.HasPreviousButton = False
WelcomePage.HasCancelButton =True
WelcomePage.HasFinishButton = False

Main Features

• Easy to use: Simple design-time interface.
• GUI: An easy to use GUI, what you see at design-time is what you see at runtime.
• PC Support: Works under (tested so far) Win95/98, WinXP, Win2000, and Win2003 Server

Other Features

• Runtime customization: You can change any part of the wizard at runtime.
• Attach/add pages at runtime:

  'Inserting a custom page At runtime:
  
  '-- Inserts A New Page after the Current Page
  WizardTemplate.Pages.Insert(_
    WizardTemplate.Pages.IndexOf(CurrentWizPanel) + 1, _
    NewWizardPage)
  
  'Adding a custom page At runtime:
  '-- Adds A New Page To The End Of The wizard
  WizardTemplate.Pages.Add(NewWizardPage)

Conclusion

Not much here to learn from, but hopefully the library will be of some use. As this is my first article, please be lenient. I hope all of you at least enjoyed reading the article, and maybe you'll find the framework useful.

Licence (LGPL)

The GNWizardFramework library is copyright 2005-2006 to Gary Noble, but its source code and the binaries are free for commercial and non commercial use.

Only vote for this article if you like the library.

• 1.01 (21-Dec-2006)
  • Updated the 'Previous Button' disabled issue pointed out by Bill Reinhold (Thanks Bill).
  • Updated the 'Toolbox bitmap' - Toolbox bitmaps are now handled properly.
• 1.0 (21-Mar-2006) - Initial release.

This article, along with any associated source code and files, is licensed under The Code Project Open License (CPOL)