StartWizard Method

Some of the content in this topic may not be applicable to some languages.

Starts the Office Assistant and returns a Long value that identifies the session. You should use this method only to run the Office Assistant in a custom wizard.

Note   The number returned by StartWizard method is used by the ActivateWizard and EndWizard methods.

expression    Required. An expression that returns an Assistant object.

On   Required 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   Required 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   Required Long. A number that identifies the balloon that initiated the callback procedure.

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

CustomTeaser   Optional Variant. False to display the Office decision balloon.

Top, Left, Bottom, Right   Optional Variant. 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.

Remarks

Unlike callback procedures used by standard modeless balloons, the callback procedure called by the modeless decision and branch balloons displayed during an Office Assistant wizard session takes only two arguments: an MsoWizardMsgType constant, and the unique value specified by the PrivateX argument of the StartWizard method.

If the user clicks the left button in the decision or branch balloon, the constant msoWizardMsgShowHelp is passed to the first argument of the callback procedure. If the user clicks the right button, the constant msoWizardLocalStateOff is passed. (The other MsoWizardMsgType constants are passed by the ActivateWizard method if you’ve specified msoWizardActResume or msoWizardActSuspend for the Act argument.) In the case of msoWizardMsgShowHelp, the callback procedure should display the appropriate balloon for the current panel of the custom wizard. And in the case of msoWizardLocalStateOff, the callback procedure should hide the visible balloon.

Example

This example starts the Office Assistant as part of a process to provide information while a custom wizard is running. The variable lHelpForWiz is set to the return value of the StartWizard method, which is Long.

lHelpForWiz = Assistant.StartWizard(On:=True, _
    Callback:="myCallback", PrivateX:=23)