Compartilhar via


WizardForm Classe

Definição

Fornece a classe base para formulários de assistente, que contêm WizardPage objetos.

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
Herança

Exemplos

O exemplo a seguir implementa vários dos métodos e propriedades da WizardForm classe . O formulário do assistente no exemplo contém três WizardPage objetos. A primeira página do assistente exibe caixas de texto de nome de usuário e senha que têm um botão Enviar para permitir que o usuário envie as credenciais para validação antes de passar para a próxima página do assistente.

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;
        }
    }
}

Comentários

Como essa classe é abstrata, você não pode criar uma instância dela diretamente.

Um WizardForm objeto contém uma ou mais páginas do assistente, que criam uma interface do usuário (interface do usuário) para coletar dados relacionados em várias etapas.

Notas aos Implementadores

Ao herdar de WizardForm, você deve substituir os seguintes membros: CompleteWizard() e GetWizardPages().

Construtores

WizardForm(IServiceProvider)

Inicializa uma nova instância da classe WizardForm.

Propriedades

BackgroundJobRunning

Obtém um valor que indica se o thread de trabalho em segundo plano está ocupado.

(Herdado de BaseTaskForm)
BorderMargin

Obtém a largura das margens ao redor da página do assistente no formulário do assistente.

CanCancel

Quando substituído em uma classe derivada, obtém um valor que indica se o assistente pode ser cancelado.

CanComplete

Quando substituído em uma classe derivada, obtém um valor que indica se o assistente pode ser concluído.

CanShowHelp

Obtém um valor que indica se o usuário pode exibir o arquivo de Ajuda.

CurrentPage

Obtém a página atual exibida no formulário do assistente.

IsCancellable

Quando substituído em uma classe derivada, obtém um valor que indica se o assistente pode ser cancelado.

Pages

Obtém a IList interface que contém a coleção de páginas no assistente.

ServiceProvider

Obtém o objeto de serviço da classe .

(Herdado de BaseForm)
StartPageIndex

Quando substituído em uma classe derivada, obtém o índice de página da primeira página que o assistente exibe quando é carregado pela primeira vez.

TaskCaption

Obtém ou define o legenda de uma tarefa, formulário do assistente ou outro objeto.

TaskCaptionBorderStyle

Obtém ou define o estilo de borda para a tarefa legenda.

TaskDescription

Obtém ou define a descrição de uma tarefa, formulário do assistente ou outro objeto.

TaskGlyph

Obtém ou define a imagem do formulário.

TaskProgressEndColor

Obtém ou define a cor final do gradiente da barra de progresso.

TaskProgressGradientSpeed

Obtém ou define o número de ciclos de gradiente de cor que a barra de progresso exibirá a qualquer momento.

TaskProgressScrollSpeed

Obtém ou define a velocidade de rolagem da barra de progresso.

TaskProgressStartColor

Obtém ou define a cor inicial do gradiente da barra de progresso.

WizardData

Quando substituído em uma classe derivada, obtém as informações do assistente.

Métodos

CancelAsyncTask()

Fornece um método para o usuário cancelar a tarefa atual.

(Herdado de BaseTaskForm)
CancelWizard()

Quando substituído em uma classe derivada, indica que o usuário cancelou o formulário do assistente.

CompleteWizard()

Quando substituído em uma classe derivada, permite que o usuário feche o assistente clicando no botão Concluir .

DisplayErrorMessage(Exception, ResourceManager)

Exibe uma caixa de diálogo modal com uma mensagem de erro, com base na exceção especificada e no gerenciador de recursos.

(Herdado de BaseTaskForm)
Dispose(Boolean)

Libera os recursos não gerenciados usados pelo BaseForm e opcionalmente libera os recursos gerenciados.

(Herdado de BaseForm)
GetService(Type)

Recupera o serviço solicitado.

(Herdado de BaseForm)
GetWizardPages()

Quando substituído em uma classe derivada, retorna uma coleção de páginas do assistente que o formulário do assistente contém.

InvalidateTask(Boolean)

Invalida a barra de progresso e faz com que o controle seja redesenhado.

(Herdado de BaseTaskForm)
NavigateToNextPage()

Fornece um mecanismo para passar para a próxima página do assistente do formulário do assistente.

NavigateToPreviousPage()

Fornece um mecanismo para mover para a página anterior do assistente do formulário do assistente.

OnActivated(EventArgs)

Ocorre quando o formulário base é ativado.

(Herdado de BaseForm)
OnClosing(CancelEventArgs)

Indica que o formulário está fechando e aciona o Closing evento.

OnHelpRequested(HelpEventArgs)

Ocorre quando um controle de Ajuda é ativado.

(Herdado de BaseForm)
OnInitialActivated(EventArgs)

Indica que o formulário foi carregado pela primeira vez e aciona o Activated evento.

OnLoad(EventArgs)

Indica que o formulário do assistente é carregado e aciona o Load evento.

OnPageChanged(EventArgs)

Indica que o usuário passou da página atual para a página anterior ou próxima do formulário do assistente.

OnPageChanging(EventArgs)

Quando substituído em uma classe derivada, indica que o usuário está se movendo da página atual para a página anterior ou próxima do formulário do assistente.

OnPaint(PaintEventArgs)

Indica que o formulário do assistente está sendo redesenhado e aciona o Paint evento.

SetButtonsPanel(Control)

Adiciona um botão ao painel de botões.

(Herdado de BaseTaskForm)
SetContent(Control)

Define os controles para a página Exibição de Conteúdo no Gerenciador do IIS.

(Herdado de BaseTaskForm)
ShouldShowPage(WizardPage)

Quando substituído em uma classe derivada, determina quais páginas do assistente podem ser mostradas no formulário do assistente.

ShowError(Exception, String, Boolean)

Exibe a exceção especificada e informações sobre a exceção em uma caixa de mensagem.

(Herdado de BaseForm)
ShowHelp()

Fornece um mecanismo para exibir o arquivo de Ajuda do assistente.

ShowMessage(String)

Exibe uma caixa de mensagem que usa o texto especificado.

(Herdado de BaseForm)
ShowMessage(String, MessageBoxButtons, MessageBoxIcon, MessageBoxDefaultButton)

Exibe uma caixa de mensagem que usa o texto, o conjunto de botões, o símbolo e o botão padrão especificados.

(Herdado de BaseForm)
StartAsyncTask(DoWorkEventHandler, RunWorkerCompletedEventHandler)

Inicia uma tarefa usando um thread de trabalho e configura o manipulador de eventos concluído pelo trabalho.

(Herdado de BaseTaskForm)
StartAsyncTask(DoWorkEventHandler, RunWorkerCompletedEventHandler, MethodInvoker)

Inicia uma tarefa usando um thread de trabalho e configura os manipuladores de eventos de tarefa de trabalho concluídos e cancelados.

(Herdado de BaseTaskForm)
StartAsyncTask(DoWorkEventHandler, RunWorkerCompletedEventHandler, MethodInvoker, Object)

Inicia uma tarefa usando um thread de trabalho, configura os manipuladores de eventos de trabalho concluídos e cancel-tarefa e passa um objeto para o manipulador de eventos de tarefa.

(Herdado de BaseTaskForm)
StartTaskProgress()

Inicia a barra de progresso.

StopTaskProgress()

Interrompe a barra de progresso.

Update()

Atualizações a exibição do formulário do assistente.

UpdateWizard()

Atualizações a exibição do formulário do assistente.

WndProc(Message)

Redireciona os eventos de botão de Ajuda contextuais para o ShowHelp() método .

(Herdado de BaseForm)

Aplica-se a