WizardForm Class

Definition

public ref class WizardForm abstract : Microsoft::Web::Management::Client::Win32::BaseTaskForm

public abstract class WizardForm : Microsoft.Web.Management.Client.Win32.BaseTaskForm

type WizardForm = class
    inherit BaseTaskForm

Public MustInherit Class WizardForm
Inherits BaseTaskForm

Inheritance

Form

BaseForm

DialogForm

BaseTaskForm

WizardForm

Examples

The following example implements several of the methods and properties of the WizardForm class. The wizard form in the example contains three WizardPage objects. The first wizard page displays user name and password text boxes that have a Submit button to enable the user to submit the credentials for validation before moving to the next wizard page.

using System;
using System.Collections;
using System.Collections.Generic;
//using System.ComponentModel;
using System.Data;
using System.Drawing;
//using System.Text;
using System.Windows.Forms;
using Microsoft.Web.Management.Client;
using Microsoft.Web.Management.Client.Win32;

namespace ExtensibilityDemo
{
    public partial class DemoModuleWizardForm : WizardForm
    {
        public DemoModuleWizardForm(IServiceProvider serviceProvider)
            : base(serviceProvider)
        {
            InitializeComponent();
            // Upon initial load, the StartPageIndex page is loaded.
            // Get the Pages for this Form;
            int pageCount = Pages.Count;
            TaskCaptionBorderStyle = BorderStyle.None;
            StartTaskProgress();
        }
        private void InitializeComponent()
        {
            this.LoginPage = new ExtensibilityDemo.
                DemoModuleWizardLoginPage();
            this.ModificationPage = new ExtensibilityDemo.
                DemoModuleWizardModificationPage();
            this.LabelPage = new ExtensibilityDemo.
                DemoModuleWizardLabelPage();
            this.SuspendLayout();
            //
            // demomModuleWizardLoginPage
            // 
            this.LoginPage.AutoSize = true;
            this.LoginPage.BackColor = System.Drawing.Color.Silver;
            this.LoginPage.Location = new System.Drawing.Point(25, 25);
            this.LoginPage.Name = "LoginPage";
            this.LoginPage.RightToLeftLayout = false;
            this.LoginPage.Size = new System.Drawing.Size(250, 200);
            this.LoginPage.TabIndex = 1;
            // 
            // demomModuleWizardModificationPage
            // 
            this.ModificationPage.AutoSize = true;
            this.ModificationPage.BackColor = System.Drawing.Color.Silver;
            this.ModificationPage.Location = new System.Drawing.Point(25, 25);
            this.ModificationPage.Name = "ModificationPage";
            //this.ModificationPage.RightToLeftLayout = false;
            this.ModificationPage.Size = new System.Drawing.Size(250, 200);
            this.ModificationPage.TabIndex = 2;
            // 
            // 
            // demomModuleWizardLabelPage
            // 
            this.LabelPage.AutoSize = true;
            this.LabelPage.BackColor = System.Drawing.Color.Silver;
            this.LabelPage.Location = new System.Drawing.Point(25, 25);
            this.LabelPage.Name = "LabelPage";
            this.LabelPage.RightToLeftLayout = false;
            this.LabelPage.Size = new System.Drawing.Size(250, 200);
            this.LabelPage.TabIndex = 3;
            // 
            // demoModuleWizardForm
            // 
            this.AutoScaleDimensions = new System.Drawing.SizeF(6F, 13F);
            this.AutoScaleMode = System.Windows.Forms.AutoScaleMode.Font;
            this.ClientSize = new System.Drawing.Size(400, 400);
            this.Name = "demoModuleWizardForm";
            this.Padding = new System.Windows.Forms.Padding(0, 64, 0, 0);
            //           
            // Establish Task Information
            //
            this.Text = "Wizard";
            this.Name = "Wizard";
            this.TaskCaption = "Wizard Form";
            this.TaskDescription = "Build Wizard Form and Wizard Pages.";
            this.ResumeLayout(false); 
        }

        private ExtensibilityDemo.DemoModuleWizardLoginPage LoginPage;
        private ExtensibilityDemo.DemoModuleWizardLabelPage LabelPage;
        private ExtensibilityDemo.DemoModuleWizardModificationPage ModificationPage;
        // Customize the abstract CompleteWizard();
        protected override void CompleteWizard()
        {
            Close();
        }
        // Customize the abstract GetWizardPages.
        protected override WizardPage[] GetWizardPages()
        {
            return new WizardPage[]
            {
                // Create each wizard page.
                new DemoModuleWizardLoginPage(),
                new DemoModuleWizardLabelPage(),
                new DemoModuleWizardModificationPage()
            };
        }
        protected new IList Pages
        {
            get
            {
                // Get a wizard page collection.
                WizardPage[] wizardPages = GetWizardPages();
                ShowMessage("There are " + wizardPages.Length + " wizard pages.");
                return wizardPages;
            }
        }
        // Customize the StartTaskProgressMethod.
        protected override void StartTaskProgress()
        {
            TaskProgressStartColor = Color.Red;
            TaskProgressEndColor = Color.Yellow;
            // Default TaskProgressScrollSpeed is a value of 6.
            TaskProgressScrollSpeed = 2;
            // Default TaskProgressGradientSpeed is a value of 1;
            TaskProgressGradientSpeed = 3;
            //Set the task Glyph.
            TaskGlyph = Icon.FromHandle(Cursors.Arrow.Handle).ToBitmap();
            TaskGlyph.RotateFlip(RotateFlipType.Rotate90FlipNone);
            // Implement the StartTaskProgress from the base class.
            base.StartTaskProgress();
        }
        // Customize the IsCancellable property. Default is true;
        protected override bool IsCancellable
        {
            get
            {
                return true;
            }
        }
        // Customize the CancelWizard method.
        protected override void CancelWizard()
        {
            //Check the IsCancellable property before performing a cancel.
            if (IsCancellable)
            {
                // Verify that the user wants to cancel the wizard.
                DialogResult result = ShowMessage("Are you sure you want to exit?",
                    MessageBoxButtons.YesNo,
                    MessageBoxIcon.Question,
                    MessageBoxDefaultButton.Button2);
                if (result == DialogResult.Yes)
                {
                    base.StopTaskProgress();
                    base.CancelWizard();
                }
            }
        }
        // Customize the OnPageChanged method
        protected override void  OnPageChanged(EventArgs e)
        {
            // To get to the LabelPage the user has been validated.
            if (this.CurrentPage.Name == "demoModuleWizardLabelPage")
            {
                this.TaskCaption = "User is signed in";
            }
            base.OnPageChanged(e);
        }
        // Customize the Border Margin. The default is 14 pixels;
        protected override int BorderMargin
        {
            get
            {
                return 25;
            }
        }
        // Customize the OnLoad method, with the user's name.
        protected override void OnLoad(EventArgs e)
        {
            base.OnLoad(e);
            Controls[0].Controls["_pageContainer"].
                Controls["demoModuleWizardLoginPage"].
                Controls["textBox1"].Text =
                System.Environment.UserName;
        }
    }
}

using System;
using System.Collections;
using System.Collections.Generic;
//using System.ComponentModel;
using System.Data;
using System.Drawing;
//using System.Text;
using System.Windows.Forms;
using Microsoft.Web.Management.Client;
using Microsoft.Web.Management.Client.Win32;

namespace ExtensibilityDemo
{
    public partial class DemoModuleWizardForm : WizardForm
    {
        public DemoModuleWizardForm(IServiceProvider serviceProvider)
            : base(serviceProvider)
        {
            InitializeComponent();
            // Upon initial load, the StartPageIndex page is loaded.
            // Get the Pages for this Form;
            int pageCount = Pages.Count;
            TaskCaptionBorderStyle = BorderStyle.None;
            StartTaskProgress();
        }
        private void InitializeComponent()
        {
            this.LoginPage = new ExtensibilityDemo.
                DemoModuleWizardLoginPage();
            this.ModificationPage = new ExtensibilityDemo.
                DemoModuleWizardModificationPage();
            this.LabelPage = new ExtensibilityDemo.
                DemoModuleWizardLabelPage();
            this.SuspendLayout();
            //
            // demomModuleWizardLoginPage
            // 
            this.LoginPage.AutoSize = true;
            this.LoginPage.BackColor = System.Drawing.Color.Silver;
            this.LoginPage.Location = new System.Drawing.Point(25, 25);
            this.LoginPage.Name = "LoginPage";
            this.LoginPage.RightToLeftLayout = false;
            this.LoginPage.Size = new System.Drawing.Size(250, 200);
            this.LoginPage.TabIndex = 1;
            // 
            // demomModuleWizardModificationPage
            // 
            this.ModificationPage.AutoSize = true;
            this.ModificationPage.BackColor = System.Drawing.Color.Silver;
            this.ModificationPage.Location = new System.Drawing.Point(25, 25);
            this.ModificationPage.Name = "ModificationPage";
            //this.ModificationPage.RightToLeftLayout = false;
            this.ModificationPage.Size = new System.Drawing.Size(250, 200);
            this.ModificationPage.TabIndex = 2;
            // 
            // 
            // demomModuleWizardLabelPage
            // 
            this.LabelPage.AutoSize = true;
            this.LabelPage.BackColor = System.Drawing.Color.Silver;
            this.LabelPage.Location = new System.Drawing.Point(25, 25);
            this.LabelPage.Name = "LabelPage";
            this.LabelPage.RightToLeftLayout = false;
            this.LabelPage.Size = new System.Drawing.Size(250, 200);
            this.LabelPage.TabIndex = 3;
            // 
            // demoModuleWizardForm
            // 
            this.AutoScaleDimensions = new System.Drawing.SizeF(6F, 13F);
            this.AutoScaleMode = System.Windows.Forms.AutoScaleMode.Font;
            this.ClientSize = new System.Drawing.Size(400, 400);
            this.Name = "demoModuleWizardForm";
            this.Padding = new System.Windows.Forms.Padding(0, 64, 0, 0);
            //           
            // Establish Task Information
            //
            this.Text = "Wizard";
            this.Name = "Wizard";
            this.TaskCaption = "Wizard Form";
            this.TaskDescription = "Build Wizard Form and Wizard Pages.";
            this.ResumeLayout(false); 
        }

        private ExtensibilityDemo.DemoModuleWizardLoginPage LoginPage;
        private ExtensibilityDemo.DemoModuleWizardLabelPage LabelPage;
        private ExtensibilityDemo.DemoModuleWizardModificationPage ModificationPage;
        // Customize the abstract CompleteWizard();
        protected override void CompleteWizard()
        {
            Close();
        }
        // Customize the abstract GetWizardPages.
        protected override WizardPage[] GetWizardPages()
        {
            return new WizardPage[]
            {
                // Create each wizard page.
                new DemoModuleWizardLoginPage(),
                new DemoModuleWizardLabelPage(),
                new DemoModuleWizardModificationPage()
            };
        }
        protected new IList Pages
        {
            get
            {
                // Get a wizard page collection.
                WizardPage[] wizardPages = GetWizardPages();
                ShowMessage("There are " + wizardPages.Length + " wizard pages.");
                return wizardPages;
            }
        }
        // Customize the StartTaskProgressMethod.
        protected override void StartTaskProgress()
        {
            TaskProgressStartColor = Color.Red;
            TaskProgressEndColor = Color.Yellow;
            // Default TaskProgressScrollSpeed is a value of 6.
            TaskProgressScrollSpeed = 2;
            // Default TaskProgressGradientSpeed is a value of 1;
            TaskProgressGradientSpeed = 3;
            //Set the task Glyph.
            TaskGlyph = Icon.FromHandle(Cursors.Arrow.Handle).ToBitmap();
            TaskGlyph.RotateFlip(RotateFlipType.Rotate90FlipNone);
            // Implement the StartTaskProgress from the base class.
            base.StartTaskProgress();
        }
        // Customize the IsCancellable property. Default is true;
        protected override bool IsCancellable
        {
            get
            {
                return true;
            }
        }
        // Customize the CancelWizard method.
        protected override void CancelWizard()
        {
            //Check the IsCancellable property before performing a cancel.
            if (IsCancellable)
            {
                // Verify that the user wants to cancel the wizard.
                DialogResult result = ShowMessage("Are you sure you want to exit?",
                    MessageBoxButtons.YesNo,
                    MessageBoxIcon.Question,
                    MessageBoxDefaultButton.Button2);
                if (result == DialogResult.Yes)
                {
                    base.StopTaskProgress();
                    base.CancelWizard();
                }
            }
        }
        // Customize the OnPageChanged method
        protected override void  OnPageChanged(EventArgs e)
        {
            // To get to the LabelPage the user has been validated.
            if (this.CurrentPage.Name == "demoModuleWizardLabelPage")
            {
                this.TaskCaption = "User is signed in";
            }
            base.OnPageChanged(e);
        }
        // Customize the Border Margin. The default is 14 pixels;
        protected override int BorderMargin
        {
            get
            {
                return 25;
            }
        }
        // Customize the OnLoad method, with the user's name.
        protected override void OnLoad(EventArgs e)
        {
            base.OnLoad(e);
            Controls[0].Controls["_pageContainer"].
                Controls["demoModuleWizardLoginPage"].
                Controls["textBox1"].Text =
                System.Environment.UserName;
        }
    }
}

Remarks

Because this class is abstract, you cannot create an instance of it directly.

A WizardForm object contains one or more wizard pages, which create a user interface (UI) to collect related data across multiple steps.

Notes to Implementers

When you inherit from WizardForm, you must override the following members: CompleteWizard() and GetWizardPages().

Constructors

Properties

Methods

Applies to