Edit

Share via


Assistant.StartWizard Method

Definition

Starts the Office Assistant and returns an Integer value that identifies the session.

public int StartWizard (bool On, string Callback, int PrivateX, object Animation, object CustomTeaser, object Top, object Left, object Bottom, object Right);
abstract member StartWizard : bool * string * int * obj * obj * obj * obj * obj * obj -> int
Public Function StartWizard (On As Boolean, Callback As String, PrivateX As Integer, Optional Animation As Object, Optional CustomTeaser As Object, Optional Top As Object, Optional Left As Object, Optional Bottom As Object, Optional Right As Object) As Integer

Parameters

On
Boolean

True to display the Office decision balloon. The Office decision balloon asks the user whether he or she wants help with the active custom wizard. It isn't necessary to use the Visible property to display the Office Assistant if you specify True for this argument.

Callback
String

The name of the callback procedure run by the Office decision balloon and the branch balloon. The branch balloon allows the user to choose between custom Help you've provided for the wizard and standard Office Help.

PrivateX
Int32

A number that identifies the balloon that initiated the callback procedure.

Animation
Object

The animation the Office Assistant performs when this method is used. The default value is msoAnimationGetWizardy.

CustomTeaser
Object

False to display the Office decision balloon.

Top
Object

The position of the corners (in points and relative to the screen) of the custom wizard form the Office Assistant will avoid when the Office Assistant appears.

Left
Object

The position of the corners (in points and relative to the screen) of the custom wizard form the Office Assistant will avoid when the Office Assistant appears.

Bottom
Object

The position of the corners (in points and relative to the screen) of the custom wizard form the Office Assistant will avoid when the Office Assistant appears.

Right
Object

The position of the corners (in points and relative to the screen) of the custom wizard form the Office Assistant will avoid when the Office Assistant appears.

Returns

Remarks

You should use this method only to run the Office Assistant in a custom wizard.

Applies to