MailMergeWizardStateChangeEventHandler Delegate

Reference

Definition

Namespace:: Microsoft.Office.Tools.Word

Assemblies:: Microsoft.Office.Tools.Word.dll, Microsoft.Office.Tools.Word.v4.0.Utilities.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Represents the method that handles the MailMergeWizardStateChange event of a Document.

public delegate void MailMergeWizardStateChangeEventHandler(System::Object ^ sender, MailMergeWizardStateChangeEventArgs ^ e);

public delegate void MailMergeWizardStateChangeEventHandler(object sender, MailMergeWizardStateChangeEventArgs e);

type MailMergeWizardStateChangeEventHandler = delegate of obj * MailMergeWizardStateChangeEventArgs -> unit

Public Delegate Sub MailMergeWizardStateChangeEventHandler(sender As Object, e As MailMergeWizardStateChangeEventArgs)

Parameters

sender: Object

The source of the event.

e: MailMergeWizardStateChangeEventArgs

A MailMergeWizardStateChangeEventArgs that contains the event data.

Examples

The following code example demonstrates an event handler for the MailMergeWizardStateChange event. The event handler displays a message each time the user advances to the next step in the Mail Merge wizard.

This example is for a document-level customization.

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.");
}

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

Remarks

When you create a MailMergeWizardStateChangeEventHandler delegate, you identify the method that will handle the event. To associate the event with your event handler, add an instance of the delegate to the event. The event handler is called whenever the event occurs, until you remove the delegate..

Applies to