DocumentBase.MailMergeBeforeRecordMerge Event

Occurs as a merge is executed for the individual records in a merge.

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

Syntax

'Declaration
Public Event MailMergeBeforeRecordMerge As CancelEventHandler
public event CancelEventHandler MailMergeBeforeRecordMerge

Remarks

To stop the mail merge process for the current record, set the Cancel argument of the provided CancelEventArgs to true.

Examples

The following code example displays a message before the first record is merged. To use this example, run it from the ThisDocument class in a document-level project.

Private Sub DocumentMailMergeBeforeRecordMerge()
    AddHandler Me.MailMergeBeforeRecordMerge, AddressOf ThisDocument_MailMergeBeforeRecordMerge
End Sub

Private Sub ThisDocument_MailMergeBeforeRecordMerge(ByVal sender As Object, ByVal e As System.ComponentModel.CancelEventArgs)
    Dim index As Object = 1
    MessageBox.Show(Me.MailMerge.DataSource.DataFields.Item(index).Value & _
      " is now merging.")
End Sub
private void DocumentMailMergeBeforeRecordMerge()
{
    this.MailMergeBeforeRecordMerge += new System.ComponentModel.CancelEventHandler(ThisDocument_MailMergeBeforeRecordMerge);
}

void ThisDocument_MailMergeBeforeRecordMerge(object sender, System.ComponentModel.CancelEventArgs e)
{
    string message = this.MailMerge.DataSource.DataFields[1].Value + " is now merging.";
    MessageBox.Show(message);
}

.NET Framework Security

See Also

Reference

DocumentBase Class

Microsoft.Office.Tools.Word Namespace