Articles in this section
Category / Section

How to mail merge Word document in C#, VB.NET

2 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 C# and VB.NET.

Steps to Mail merge Word document in C#:

  1. Create a new C# console application project. Create Console application in Visual Studio
  2. Install Syncfusion.DocIO.WinForms NuGet package as a reference to your .NET Framework applications from the NuGet.org. Add DocIO NuGet package reference to the project
  3. Include the following namespace in the Program.cs file.

C#

using Syncfusion.DocIO.DLS;

VB

Imports Syncfusion.DocIO.DLS
  1. Use the following code to mail merge Word document.

C#

//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 document
    document.Save("Result.docx");
}

VB

'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 document
    document.Save("Result.docx")
End Using

A complete working example of mail merge Word document in C# can be downloaded from mail merge Word document.zip

By executing the program, you will get the output 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.

See Also:

Mail Merge Word document in Windows Forms

Mail Merge Word document in WPF

Mail Merge Word document in UWP

Mail Merge Word document in ASP.NET

Mail Merge Word document in ASP.NET MVC

Mail Merge Word document in ASP.NET Core

Mail Merge Word document in Xamarin

Mail Merge Word document in Xamarin.Android

Mail Merge Word document in Xamarin.iOS

Note:

Starting with v16.2.0.x, if you reference Syncfusion assemblies from trial setup or from the NuGet feed, include a license key in your projects. Refer to link to learn about generating and registering Syncfusion license key in your application to use the components without trail message.

 

Did you find this information helpful?
Yes
No
Help us improve this page
Please provide feedback or comments
Comments (0)
Please sign in to leave a comment
Access denied
Access denied