Document.MailMergeWizardStateChange Event (2007 System)

Occurs when a user changes from a specified step to a specified step in the Mail Merge Wizard.

Namespace:  Microsoft.Office.Tools.Word
Assembly:  Microsoft.Office.Tools.Word.v9.0 (in Microsoft.Office.Tools.Word.v9.0.dll)

Syntax

'Declaration
Public Event MailMergeWizardStateChange As MailMergeWizardStateChangeEventHandler

'Usage
Dim instance As Document 
Dim handler As MailMergeWizardStateChangeEventHandler 

AddHandler instance.MailMergeWizardStateChange, handler

public event MailMergeWizardStateChangeEventHandler MailMergeWizardStateChange

public:
 event MailMergeWizardStateChangeEventHandler^ MailMergeWizardStateChange {
    void add (MailMergeWizardStateChangeEventHandler^ value);
    void remove (MailMergeWizardStateChangeEventHandler^ value);
}

JScript does not support events.

Remarks

Set the Handled property of the provided MailMergeWizardStateChangeEventArgs to false to have the user remain at the current step.

Examples

The following code example displays a message each time you advance to the next step in the Mail Merge Wizard.

This version is for a document-level customization.

Private Sub DocumentMailMergeWizardStateChange()
    AddHandler Me.MailMergeWizardStateChange, AddressOf ThisDocument_MailMergeWizardStateChange
End Sub 

Private Sub ThisDocument_MailMergeWizardStateChange(ByVal sender As Object, ByVal e As Microsoft.Office.Tools.Word.MailMergeWizardStateChangeEventArgs)
    MessageBox.Show("Wizard has moved to next step.")
End Sub

private void DocumentMailMergeWizardStateChange()
{
    this.MailMergeWizardStateChange += new Microsoft.Office.Tools.Word.MailMergeWizardStateChangeEventHandler(ThisDocument_MailMergeWizardStateChange);
}

void ThisDocument_MailMergeWizardStateChange(object sender, Microsoft.Office.Tools.Word.MailMergeWizardStateChangeEventArgs e)
{
    MessageBox.Show("Wizard has moved to next step.");
}

This version is for an application-level add-in.

Private Sub DocumentMailMergeWizardStateChange()
    Dim vstoDoc As Document = Me.Application.ActiveDocument.GetVstoObject()
    AddHandler vstoDoc.MailMergeWizardStateChange, AddressOf ThisDocument_MailMergeWizardStateChange
End Sub 

Private Sub ThisDocument_MailMergeWizardStateChange(ByVal sender As Object, ByVal e As Microsoft.Office.Tools.Word.MailMergeWizardStateChangeEventArgs)
    System.Windows.Forms.MessageBox.Show("Wizard has moved to next step.")
End Sub

private void DocumentMailMergeWizardStateChange()
{
    Document vstoDoc = this.Application.ActiveDocument.GetVstoObject();
    vstoDoc.MailMergeWizardStateChange += new Microsoft.Office.Tools.Word.MailMergeWizardStateChangeEventHandler(ThisDocument_MailMergeWizardStateChange);
}

void ThisDocument_MailMergeWizardStateChange(object sender, Microsoft.Office.Tools.Word.MailMergeWizardStateChangeEventArgs e)
{
    System.Windows.Forms.MessageBox.Show("Wizard has moved to next step.");
}

.NET Framework Security

• Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.

See Also

Reference

Document Class

Document Members

Microsoft.Office.Tools.Word Namespace

Change History