How to mail merge Word document in Windows Forms

3 mins read

Mail merge is a process of merging data from a data source to a Word template document. Syncfusion Essential DocIO is a .NET Word library used to generate reports like invoice, payroll, letter, etc., by performing mail merge faster in a batch process without Microsoft Word or interop dependencies. Using this library, you can mail merge Word document in Windows Forms.

Steps to Mail merge Word document in Windows Forms:

Create a new Windows Forms application project.
Install Syncfusion.DocIO.WinForms NuGet package as a reference to your Windows Forms application from the NuGet.org.
Include the following namespaces in the Form1.Designer.cs file.

using Syncfusion.DocIO.DLS;
using System;
using System.ComponentModel;
using System.Windows.Forms;

Imports Syncfusion.DocIO.DLS
Imports System.ComponentModel
Imports System.Windows.Forms

Add a new button in Form1.Designer.cs to create Word document report using mail merge as follows.

private Button btnCreate;
private Label label;
private void InitializeComponent()
{
    label = new Label();
    btnCreate = new Button();
    //Label
    label.Location = new System.Drawing.Point(0, 40);
    label.Size = new System.Drawing.Size(426, 35);
    label.Text = "Click the button to view a mail merge Word document generated by Essential DocIO. Please note that Microsoft Word Viewer or Microsoft Word is required to view the resultant Word file";
    label.TextAlign = System.Drawing.ContentAlignment.MiddleCenter;
    //Button
    btnCreate.Location = new System.Drawing.Point(180, 110);
    btnCreate.Size = new System.Drawing.Size(85, 36);
    btnCreate.Text = "Create Document";
    btnCreate.Click += new EventHandler(btnCreate_Click);
    //Create Word
    ClientSize = new System.Drawing.Size(450, 150);
    Controls.Add(label);
    Controls.Add(btnCreate);
    Text = "Create Word";
}

Private label As Label
Private WithEvents btnCreate As Button
Private Sub InitializeComponent()
  label = New Label
  btnCreate = New Button
  'Label
  label.Location = New Drawing.Point(0, 40)
  label.Size = New Drawing.Size(426, 35)
  label.Text = ("Click the button to view a mail merge Word document generated by Essential DocIO. Please note that Microsoft Word Viewer or Microsoft Word is required to view the resultant Word file")
  label.TextAlign = Drawing.ContentAlignment.MiddleCenter
  'Button
  btnCreate.Location = New Drawing.Point(180, 110)
  btnCreate.Size = New Drawing.Size(85, 36)
  btnCreate.Text = "Create Document"
  AddHandler btnCreate.Click, AddressOf Me.btnCreate_Click
  'Create Word
  ClientSize = New Drawing.Size(450, 150)
  Controls.Add(label)
  Controls.Add(btnCreate)
  Text = "Create Word"
End Sub

Add the following code in btnCreate_Click to mail merge Word document.

//Opens the Word template document
using (WordDocument document = new WordDocument("Letter Formatting.docx"))
{
    string[] fieldNames = { "ContactName", "CompanyName", "Address", "City", "Country", "Phone"};
    string[] fieldValues = { "Nancy Davolio", "Syncfusion", "507 - 20th Ave. E.Apt. 2A", "Seattle, WA", "USA", "(206) 555-9857-x5467" };
    //Performs the mail merge
    document.MailMerge.Execute(fieldNames, fieldValues);
    //Saves the Word file
    document.Save("Result.docx");
}

'Opens the Word template document
Using document As WordDocument = New WordDocument ("Letter Formatting.docx")
    Dim fieldNames As String() = {"ContactName", "CompanyName", "Address", "City", "Country", "Phone"}
    Dim fieldValues As String() = {"Nancy Davolio", "Syncfusion", "507 - 20th Ave. E.Apt. 2A", "Seattle, WA", "USA", "(206) 555-9857-x5467" }
    'Performs the mail merge
    document.MailMerge.Execute(fieldNames, fieldValues)
    'Saves the Word file
    document.Save("Result.docx")
End Using

A complete working example of how to mail merge Word document in Windows Forms can be downloaded from mail merge Word document.zip

By executing the program, you will get the Word document as follows. Mail merge output Word document

Take a moment to peruse the documentation, where you can find basic Word document processing options along with features like mail merge, merge and split documents, find and replace text in the Word document, protect the Word documents, and most importantly PDF and Image conversions with code examples.

Explore more about the rich set of Syncfusion Word Framework features.

An online example to perform mail merge in Word document.

How to mail merge Word document in Windows Forms

Steps to Mail merge Word document in Windows Forms:

Access denied