How to mail merge Word document in ASP.NET

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 ASP.NET Web Forms.

Steps to Mail merge Word document programmatically:

Create a new ASP.NET Web application project.
Install the Syncfusion.DocIO.AspNet NuGet package as a reference to your project from NuGet.org.
Add a new Web Form in your project. Right click on the project and select Add > New Item and add a Web Form from the list. Name it as MainPage.

Add a new button in the MainPage.aspx as shown below.

<html xmlns="http://www.w3.org/1999/xhtml">
<head runat="server">
    <title></title>
</head>
<body>
    <form id="form1" runat="server">
    <div>
    <asp:Button ID="Button1" runat="server" Text="Create Document" OnClick="OnButtonClicked" />
    </div>
    </form>
</body>
</html>

Include the following namespace in your MainPage.aspx.cs file.

using Syncfusion.DocIO;
using Syncfusion.DocIO.DLS;

Imports Syncfusion.DocIOImports Syncfusion.DocIO.DLS

Include the below code in the click event of the button in MainPage.aspx.cs, to mail merge Word document and download it.

//Opens the Word template document
using (WordDocument document = new WordDocument(ResolveApplicationDataPath("/") + "/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 document to disk in DOCX format
    document.Save("Result.docx", FormatType.Docx, HttpContext.Current.Response, HttpContentDisposition.Attachment);
}
//Get the path for Word template document
protected string ResolveApplicationDataPath(string fileName)
 {
        //Data folder path is resolved from requested page physical path.
        string dataPath = new System.IO.DirectoryInfo(Request.PhysicalPath + "..\\..\\Data\\").FullName;
        return string.Format("{0}\\{1}", dataPath, fileName);
}

VB:

'Opens the Word template document
Using document As WordDocument = New WordDocument(ResolveApplicationDataPath("/") + "/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 document to disk in DOCX format
    document.Save("Result.docx", FormatType.Docx, HttpContext.Current.Response, HttpContentDisposition.Attachment)
End Using
'Get the path for Word template document
Protected Function ResolveApplicationDataPath(fileName As String) As String
        Dim dataPath As String = New System.IO.DirectoryInfo(Request.PhysicalPath + "..\..\Data\").FullName
        Return String.Format("{0}\{1}", dataPath, fileName)
End Function

A complete working example of mail merge Word document in ASP.NET Web 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 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 ASP.NET

Steps to Mail merge Word document programmatically:

Access denied