RunWizard(IntPtr,IPropertyWizard,WizardInitializeArgs,IServiceProvider,Boolean,String,WizardHostDisplayStates) Method

SourceCode.Framework Namespace > IWizardService Interface > RunWizard Method : RunWizard(IntPtr,IPropertyWizard,WizardInitializeArgs,IServiceProvider,Boolean,String,WizardHostDisplayStates) Method

Executes a wizard. If the wizard contains pages, the wizard host will be launched

Syntax

Visual Basic (Declaration)

Overloads Function RunWizard( _
   ByVal parentHandle As IntPtr, _
   ByVal wizard As IPropertyWizard, _
   ByVal args As WizardInitializeArgs, _
   ByVal serviceProvider As IServiceProvider, _
   ByVal createTransaction As Boolean, _
   ByVal transactionDescription As String, _
   ByVal states As WizardHostDisplayStates _
) As WizardHostResults

Visual Basic (Usage)

Dim instance As IWizardService
Dim parentHandle As IntPtr
Dim wizard As IPropertyWizard
Dim args As WizardInitializeArgs
Dim serviceProvider As IServiceProvider
Dim createTransaction As Boolean
Dim transactionDescription As String
Dim states As WizardHostDisplayStates
Dim value As WizardHostResults
 
value = instance.RunWizard(parentHandle, wizard, args, serviceProvider, createTransaction, transactionDescription, states)

C#

WizardHostResults RunWizard( 
   IntPtr parentHandle,
   IPropertyWizard wizard,
   WizardInitializeArgs args,
   IServiceProvider serviceProvider,
   bool createTransaction,
   string transactionDescription,
   WizardHostDisplayStates states
)

C++/CLI

WizardHostResults RunWizard( 
   IntPtr parentHandle,
   IPropertyWizard^ wizard,
   WizardInitializeArgs^ args,
   IServiceProvider^ serviceProvider,
   bool createTransaction,
   String^ transactionDescription,
   WizardHostDisplayStates states
) 

Parameters

parentHandle

Handle of the container object

wizard

The wizard to execute

args

The initialization arguments of the wizard

serviceProvider

A service provider object. This is an object that implements the IServiceProvider interface

createTransaction

Creates a new transaction for the undo manager

transactionDescription

A description for the transaction being created. Passing a null value will create a default message

states

A flag whereby certain apsects of the WizardHost UI can be controlled by

Requirements

Target Platforms: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2