Share via


Assistant.StartWizard Method

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

Namespace:  Microsoft.Office.Core
Assembly:  office (in office.dll)

Syntax

'Declaration
Function StartWizard ( _
    On As Boolean, _
    Callback As String, _
    PrivateX As Integer, _
    Animation As Object, _
    CustomTeaser As Object, _
    Top As Object, _
    Left As Object, _
    Bottom As Object, _
    Right As Object _
) As Integer
'Usage
Dim instance As Assistant
Dim On As Boolean
Dim Callback As String
Dim PrivateX As Integer
Dim Animation As Object
Dim CustomTeaser As Object
Dim Top As Object
Dim Left As Object
Dim Bottom As Object
Dim Right As Object
Dim returnValue As Integer

returnValue = instance.StartWizard(On, _
    Callback, PrivateX, Animation, CustomTeaser, _
    Top, Left, Bottom, Right)
int StartWizard(
    bool On,
    string Callback,
    int PrivateX,
    Object Animation,
    Object CustomTeaser,
    Object Top,
    Object Left,
    Object Bottom,
    Object Right
)

Parameters

  • On
    Type: System.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
    Type: System.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
    Type: System.Int32

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

  • Animation
    Type: System.Object

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

  • CustomTeaser
    Type: System.Object

    False to display the Office decision balloon.

  • Top
    Type: System.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
    Type: System.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
    Type: System.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
    Type: System.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.

Return Value

Type: System.Int32

Remarks

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

See Also

Reference

Assistant Interface

Assistant Members

Microsoft.Office.Core Namespace