API Wizards

← Developer Center

Wizard Engine

Description

This engine provides API for writing wizards that consist of XML Element that defines appearance settings and a chain of steps (based on UserControls) for user's input. Each wizard includes two pre-defined steps:

• Progress step executes pipeline with the same name

• Final step with optional final actions, it is shown when all the processors of the Progress step are processed successfully

// TODO: extend this

WizardPipelineManager

Type: SIM.Tool.Wizards.WizardPipelineManager, SIM.Tool.Wizards

// TODO: Expand this

WizardPipelines.config

<configuration>
  <wizardPipelines>
...
    <install title="Installing new instance" startButton="Install" finishText="The installation was successfully completed">
      <args type="SIM.Tool.Base.Pipelines.InstallWizardArgs, SIM.Tool.Base" />
      <steps>
        <step name="Instance details" type="SIM.Tool.UserControls.Install.InstanceDetails, SIM.Tool" />
        <step name="Modules list" type="SIM.Tool.UserControls.Install.Modules.ModulesDetails, SIM.Tool"/>
        <step name="Custom Packages" type="SIM.Tool.UserControls.Install.Modules.FilePackages, SIM.Tool" />
      </steps>
      <finish>
        <action text="Open in Browser" type="SIM.Tool.Pipelines.Install.InstallActions, SIM.Tool" method="OpenBrowser" />
        <action text="Open in Browser (Sitecore Client)" type="SIM.Tool.Pipelines.Install.InstallActions, SIM.Tool" method="OpenSitecoreClient" />
        <action text="Open folder" type="SIM.Tool.Pipelines.Install.InstallActions, SIM.Tool" method="OpenWebsiteFolder" />
      </finish>
    </install>
...
  </wizardPipelines>
</configuration>