How to mail merge Word document in ASP.NET Core application?

Mail merge is a process of merging data from a data source to a Word template document. Syncfusion® Essential® DocIO is a .NET Core 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 Core.

Steps to Mail merge Word document programmatically:

1. Create a new ASP.NET Core Web application project.
2. Select Web Application pattern (Model-View-Controller) for the project.
3. Install the Syncfusion.DocIO.Net.Core NuGet package as a reference to your project from NuGet.org.
4. Include the following namespaces in the HomeController.cs file.

C#

using Syncfusion.DocIO;
using Syncfusion.DocIO.DLS;
using System.IO;

5. A default action method named Index will be present in HomeController.cs. Right click on Index method and select Go To View where you will be directed to its associated view page Index.cshtml.
6. 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();
}

7. Add a new action method CreateDocument in HomeController.cs and include the below code to mail merge Word document and download it.

C#

//Opens the Word template document
FileStream fileStreamPath = new FileStream(@"Data/Letter Formatting.docx", FileMode.Open, FileAccess.Read, FileShare.ReadWrite);
using (WordDocument document = new WordDocument(fileStreamPath, FormatType.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 MemoryStream
    MemoryStream stream = new MemoryStream();
    document.Save(stream, FormatType.Docx);
    stream.Position = 0;
    //Download Word document in the browser
    return File(stream, "application/msword", "Result.docx");
}

A complete working example of mail merge Word document in ASP.NET Core can be downloaded from mail merge Word document.zip

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

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, and most importantly PDF conversion with code examples.

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

An online example to perform mail merge in Word document.

See Also:

Mail Merge Word document in ASP.NET MVC

Mail Merge Word document in ASP.NET

Mail Merge Word document in C#

Mail Merge Word document in Windows Forms

Mail Merge Word document in WPF

Mail Merge Word document in UWP

Mail Merge Word document in Xamarin

Mail Merge Word document in Xamarin.Android

Mail Merge Word document in Xamarin.iOS