RunMiniWizard Method

SourceCode.Framework Namespace > IWizardService Interface : RunMiniWizard Method

Creates aand executes mini-wizard using the IModalWindow

Syntax

Visual Basic (Declaration)

Function RunMiniWizard( _
   ByVal parentHandle As IntPtr, _
   ByVal wizardPages As List(Of IWizardPage), _
   ByVal context As Object, _
   ByVal serviceProvider As IServiceProvider, _
   ByVal title As String, _
   ByVal createTransaction As Boolean, _
   ByVal transactionDescription As String _
) As IModalWindow

Visual Basic (Usage)

Dim instance As IWizardService
Dim parentHandle As IntPtr
Dim wizardPages As List(Of IWizardPage)
Dim context As Object
Dim serviceProvider As IServiceProvider
Dim title As String
Dim createTransaction As Boolean
Dim transactionDescription As String
Dim value As IModalWindow
 
value = instance.RunMiniWizard(parentHandle, wizardPages, context, serviceProvider, title, createTransaction, transactionDescription)

C#

IModalWindow RunMiniWizard( 
   IntPtr parentHandle,
   List<IWizardPage> wizardPages,
   object context,
   IServiceProvider serviceProvider,
   string title,
   bool createTransaction,
   string transactionDescription
)

C++/CLI

IModalWindow^ RunMiniWizard( 
   IntPtr parentHandle,
   List<IWizardPage^>^ wizardPages,
   Object^ context,
   IServiceProvider^ serviceProvider,
   String^ title,
   bool createTransaction,
   String^ transactionDescription
) 

Parameters

parentHandle

Handle of the container

wizardPages

A list of pages that configures the mini-wizard

context

The context object for the mini-wizard

serviceProvider

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

title

The title for the IModalWindow

createTransaction

If true, will create a transaction for the undo manager

transactionDescription

A description for the transaction. If null or empty, a default value will be supplied

Return Value

An instance of a IModalWindow

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