This documentation is archived and is not being maintained.

Application.MailMergeDataSourceLoad Event

Office 2007
Occurs when the data source is loaded for a mail merge.



expression   A variable that represents an Application object.


NameRequired/OptionalData TypeDescription
DocRequiredDocumentThe mail merge main document.


To access the Application object events, declare an Application object variable in the General Declarations section of a code module. Then set the variable equal to the Application object for which you want to access events. For information about using events with the Microsoft Office Publisher Application object, see Using Events with the Application Object.


This example displays a message with the data source file name when the data source starts loading.

Visual Basic for Applications
Private Sub MailMergeApp_MailMergeDataSourceLoad(ByVal Doc As Document)
    Dim strDSName As String
    Dim intDSLength As Integer
    Dim intDSStart As Integer

    'Pull out of the Name property (which includes path and file name)
    'only the file name using Visual Basic commands Len, InStrRev, and Right
    intDSLength = Len(ActiveDocument.MailMerge.DataSource.Name)
    intDSStart = InStrRev(ActiveDocument.MailMerge.DataSource.Name, "\")
    intDSStart = intDSLength - intDSStart
    strDSName = Right(ActiveDocument.MailMerge.DataSource.Name, intDSStart)

    'Deliver a message to user when data source is loading
    MsgBox "Your data source, " & strDSName & ", is now loading."
End Sub

For this event to occur, you must place the following line of code in the General Declarations section of your module and run the following initialization routine.

Visual Basic for Applications
Private WithEvents MailMergeApp As Application

Sub InitializeMailMergeApp()
    Set MailMergeApp = Publisher.Application
End Sub