How to mail merge Word document in ASP.NET MVC?

4 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 MVC.

Steps to Mail merge Word document programmatically:

Create a new ASP.NET MVC application project.
Install the Syncfusion.DocIO.AspNet.Mvc5 NuGet package as a reference to your project from NuGet.org.
Include the following namespace in that HomeController.cs file.

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

Imports Syncfusion.DocIO
Imports Syncfusion.DocIO.DLS

A default action method named Index will be present in HomeController.cs. Right click on this action method and select Go To View where you will be directed to its associated view page Index.cshtml.
Add a new button in the Index.cshtml as shown below.

CSHTML

@{Html.BeginForm("CreateDocument", "Home", FormMethod.Get);
{
<div>
    <input type="submit" value="Create Document" style="width:150px;height:27px" />
</div>
}
Html.EndForm();
}

Add a new action method CreateDocument in HomeController.cs and include the below code 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.ApplicationInstance.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);
}

'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.ApplicationInstance.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 MVC 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 in ASP.NET MVC

How to mail merge Word document in ASP.NET MVC?

Steps to Mail merge Word document programmatically:

Access denied