How to automate Word to perform a mail merge from Visual Basic .NET

This article was previously published under Q301656
This article demonstrates how to use Microsoft Office Word to create a mail-merged document by using Automation from Microsoft Visual Basic .NET.
Automation is a process that allows applications that are written in languages such as Visual Basic .NET to programmatically control other applications. Automation to Word allows you to perform actions such as creating new documents, adding text to documents, and formatting documents. With Word and other Microsoft Office applications, virtually all of the actions that you can perform manually through the user interface can also be performed programmatically by using Automation.

Word exposes this programmatic functionality through an object model. The object model is a collection of classes and methods that serve as counterparts to the logical components of Word. For example, there is an Application object, a Document object, and a Paragraph object, each of which contain the functionality of those components in Word. To access the object model from Visual Basic .NET, you can set a project reference to the type library.

This article demonstrates how to set the proper project reference to the Word type library for Visual Basic .NET and provides sample code to automate Word.

Create an Automation client for Word

  1. Start Microsoft Visual Studio .NET.
  2. On the File menu, click New, and then click Project. Select Windows Application from the Visual Basic Project types. Form1 is created by default.
  3. Add a reference to Microsoft Word Object Library. To do this, follow these steps:
    1. On the Project menu, click Add Reference.
    2. On the COM tab, locate Microsoft Word Object Library, and then click Select.

      Note Microsoft Office 2003 includes Primary Interop Assemblies (PIAs). Microsoft Office XP does not include PIAs, but they can be downloaded. For more information about Office XP PIAs, click the following article number to view the article in the Microsoft Knowledge Base:
      328912 Microsoft Office XP primary interop assemblies (PIAs) are available for download
    3. Click OK in the Add References dialog box to accept your selections.
  4. On the View menu, select Toolbox to display the toolbox, and then add a button to Form1.
  5. Double-click Button1. The code window for the form appears.
  6. In the code window, replace the following code.
        Private Sub Button1_Click(ByVal sender As System.Object, _       ByVal e As System.EventArgs) Handles Button1.Click    End Sub					
    Use the following code.
        Dim wrdApp As Word.Application    Dim wrdDoc As Word._Document    Private Sub InsertLines(ByVal LineNum As Integer)        Dim iCount As Integer        ' Insert "LineNum" blank lines.        For iCount = 1 To LineNum            wrdApp.Selection.TypeParagraph()        Next iCount    End Sub    Private Sub FillRow(ByVal Doc As Word.Document, ByVal Row As Integer, _    ByVal Text1 As String, ByVal Text2 As String, _    ByVal Text3 As String, ByVal Text4 As String)        With Doc.Tables.Item(1)            ' Insert the data in the specific cell.            .Cell(Row, 1).Range.InsertAfter(Text1)            .Cell(Row, 2).Range.InsertAfter(Text2)            .Cell(Row, 3).Range.InsertAfter(Text3)            .Cell(Row, 4).Range.InsertAfter(Text4)        End With    End Sub    Private Sub CreateMailMergeDataFile()        Dim wrdDataDoc As Word._Document        Dim iCount As Integer        ' Create a data source at C:\DataDoc.doc containing the field data.        wrdDoc.MailMerge.CreateDataSource(Name:="C:\DataDoc.doc", _              HeaderRecord:="FirstName, LastName, Address, CityStateZip")        ' Open the file to insert data.        wrdDataDoc = wrdApp.Documents.Open("C:\DataDoc.doc")        For iCount = 1 To 2            wrdDataDoc.Tables.Item(1).Rows.Add()        Next iCount        ' Fill in the data.        FillRow(wrdDataDoc, 2, "Steve", "DeBroux", _              "4567 Main Street", "Buffalo, NY  98052")        FillRow(wrdDataDoc, 3, "Jan", "Miksovsky", _              "1234 5th Street", "Charlotte, NC  98765")        FillRow(wrdDataDoc, 4, "Brian", "Valentine", _              "12348 78th Street  Apt. 214", "Lubbock, TX  25874")        ' Save and close the file.        wrdDataDoc.Save()        wrdDataDoc.Close(False)    End Sub    Private Sub Button1_Click(ByVal sender As System.Object, _       ByVal e As System.EventArgs) Handles Button1.Click        Dim wrdSelection As Word.Selection        Dim wrdMailMerge As Word.MailMerge        Dim wrdMergeFields As Word.MailMergeFields        Dim StrToAdd As String        ' Create an instance of Word  and make it visible.        wrdApp = CreateObject("Word.Application")        wrdApp.Visible = True        ' Add a new document.        wrdDoc = wrdApp.Documents.Add()        wrdDoc.Select()        wrdSelection = wrdApp.Selection()        wrdMailMerge = wrdDoc.MailMerge()        ' Create MailMerge Data file.        CreateMailMergeDataFile()        ' Create a string and insert it in the document.        StrToAdd = "State University" & vbCr & _                    "Electrical Engineering Department"        wrdSelection.ParagraphFormat.Alignment = _                    Word.WdParagraphAlignment.wdAlignParagraphCenter        wrdSelection.TypeText(StrToAdd)        InsertLines(4)        ' Insert merge data.        wrdSelection.ParagraphFormat.Alignment = _                    Word.WdParagraphAlignment.wdAlignParagraphLeft        wrdMergeFields = wrdMailMerge.Fields()        wrdMergeFields.Add(wrdSelection.Range, "FirstName")        wrdSelection.TypeText(" ")        wrdMergeFields.Add(wrdSelection.Range, "LastName")        wrdSelection.TypeParagraph()        wrdMergeFields.Add(wrdSelection.Range, "Address")        wrdSelection.TypeParagraph()        wrdMergeFields.Add(wrdSelection.Range, "CityStateZip")        InsertLines(2)        ' Right justify the line and insert a date field        ' with the current date.        wrdSelection.ParagraphFormat.Alignment = _               Word.WdParagraphAlignment.wdAlignParagraphRight        wrdSelection.InsertDateTime( _              DateTimeFormat:="dddd, MMMM dd, yyyy", _              InsertAsField:=False)        InsertLines(2)        ' Justify the rest of the document.        wrdSelection.ParagraphFormat.Alignment = _               Word.WdParagraphAlignment.wdAlignParagraphJustify        wrdSelection.TypeText("Dear ")        wrdMergeFields.Add(wrdSelection.Range, "FirstName")        wrdSelection.TypeText(",")        InsertLines(2)        ' Create a string and insert it into the document.        StrToAdd = "Thank you for your recent request for next " & _            "semester's class schedule for the Electrical " & _            "Engineering Department. Enclosed with this " & _            "letter is a booklet containing all the classes " & _            "offered next semester at State University.  " & _            "Several new classes will be offered in the " & _            "Electrical Engineering Department next semester.  " & _            "These classes are listed below."        wrdSelection.TypeText(StrToAdd)        InsertLines(2)        ' Insert a new table with 9 rows and 4 columns.        wrdDoc.Tables.Add(wrdSelection.Range, NumRows:=9, _             NumColumns:=4)        With wrdDoc.Tables.Item(1)            ' Set the column widths.            .Columns.Item(1).SetWidth(51, Word.WdRulerStyle.wdAdjustNone)            .Columns.Item(2).SetWidth(170, Word.WdRulerStyle.wdAdjustNone)            .Columns.Item(3).SetWidth(100, Word.WdRulerStyle.wdAdjustNone)            .Columns.Item(4).SetWidth(111, Word.WdRulerStyle.wdAdjustNone)            ' Set the shading on the first row to light gray.            .Rows.Item(1).Cells.Shading.BackgroundPatternColorIndex = _             Word.WdColorIndex.wdGray25            ' Bold the first row.            .Rows.Item(1).Range.Bold = True            ' Center the text in Cell (1,1).            .Cell(1, 1).Range.Paragraphs.Alignment = _                      Word.WdParagraphAlignment.wdAlignParagraphCenter            ' Fill each row of the table with data.            FillRow(wrdDoc, 1, "Class Number", "Class Name", "Class Time", _               "Instructor")            FillRow(wrdDoc, 2, "EE220", "Introduction to Electronics II", _                      "1:00-2:00 M,W,F", "Dr. Jensen")            FillRow(wrdDoc, 3, "EE230", "Electromagnetic Field Theory I", _                      "10:00-11:30 T,T", "Dr. Crump")            FillRow(wrdDoc, 4, "EE300", "Feedback Control Systems", _                      "9:00-10:00 M,W,F", "Dr. Murdy")            FillRow(wrdDoc, 5, "EE325", "Advanced Digital Design", _                      "9:00-10:30 T,T", "Dr. Alley")            FillRow(wrdDoc, 6, "EE350", "Advanced Communication Systems", _                      "9:00-10:30 T,T", "Dr. Taylor")            FillRow(wrdDoc, 7, "EE400", "Advanced Microwave Theory", _                      "1:00-2:30 T,T", "Dr. Lee")            FillRow(wrdDoc, 8, "EE450", "Plasma Theory", _                      "1:00-2:00 M,W,F", "Dr. Davis")            FillRow(wrdDoc, 9, "EE500", "Principles of VLSI Design", _                      "3:00-4:00 M,W,F", "Dr. Ellison")        End With        ' Go to the end of the document.        wrdApp.Selection.GoTo(Word.WdGoToItem.wdGoToLine, _                   Word.WdGoToDirection.wdGoToLast)        InsertLines(2)        ' Create a string and insert it into the document.        StrToAdd = "For additional information regarding the " & _                   "Department of Electrical Engineering, " & _                   "you can visit our Web site at "        wrdSelection.TypeText(StrToAdd)        ' Insert a hyperlink to the Web page.        wrdSelection.Hyperlinks.Add(Anchor:=wrdSelection.Range, _           Address:="")        ' Create a string and insert it in the document.        StrToAdd = ".  Thank you for your interest in the classes " & _                   "offered in the Department of Electrical " & _                   "Engineering.  If you have any other questions, " & _                   "please feel free to give us a call at " & _                   "555-1212." & vbCr & vbCr & _                   "Sincerely," & vbCr & vbCr & _                   "Kathryn M. Hinsch" & vbCr & _                   "Department of Electrical Engineering" & vbCr        wrdSelection.TypeText(StrToAdd)        ' Perform mail merge.        wrdMailMerge.Destination = _                   Word.WdMailMergeDestination.wdSendToNewDocument        wrdMailMerge.Execute(False)        ' Close the original form document.        wrdDoc.Saved = True        wrdDoc.Close(False)        ' Release References.        wrdSelection = Nothing        wrdMailMerge = Nothing        wrdMergeFields = Nothing        wrdDoc = Nothing        wrdApp = Nothing        ' Clean up temp file.        System.IO.File.Delete("C:\DataDoc.doc")    End Sub					
  7. Add the following to the top of Form1.vb.
    Imports Microsoft.Office.Interop					
  8. Press F5 to build and to run the program.
  9. Click Button1 to start Word Automation and to perform the mail merge.
For more information, visit the following Microsoft Developer Network (MSDN) Web site:
Microsoft Office Development with Visual Studio
For more information about automating Word with Microsoft Visual Basic 5.0 or 6.0, click the following article numbers to view the articles in the Microsoft Knowledge Base:
285332 How to automate Word with Visual Basic to create a Mail Merge
220607 How to automate Microsoft Word to perform Mail Merge from Visual Basic
wd2003 wd2002 WD2007

Article ID: 301656 - Last Review: 05/11/2007 22:28:34 - Revision: 8.2

Microsoft Visual Basic .NET 2003 Standard Edition, Microsoft Visual Basic .NET 2002 Standard Edition, Microsoft Office Word 2007, Microsoft Office Word 2003, Microsoft Word 2002

  • kbpia kbautomation kbhowto KB301656