Articles in this section
Category / Section

How to execute mail merge fields in a textbox, header, or footer in a Word document?

3 mins read

Syncfusion® Essential® DocIO is a .NET Word library used to create, read, edit, and convert Word documents programmatically without Microsoft Word or interop dependencies. Using this library, you can execute mail merge fields in a textbox, header, or footer in a Word document using C#.

To achieve this, add the merge field inside a textbox, header, or footer in the template Word document and then perform a mail merge.

Steps to execute mail merge fields in a textbox, header, or footer in a Word document:

  1. Create a new .NET Core console application project.
    Create console application in Visual Studio
  2. Install the Syncfusion.DocIO.Net.Core NuGet package as a reference to your project from NuGet.org.
    Add DocIO NuGet package reference to the project

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 the link to learn about generating and registering a Syncfusion® license key in your application to use the components without trail message.

  1. Include the following namespaces in Program.cs file
    C#
using Syncfusion.DocIO.DLS;
using Syncfusion.DocIO; 
  1. Use the following code example to perform mail merge in a Word document.
    C#
using (FileStream fileStream = new FileStream(Path.GetFullPath(@"Data/Template.docx"), FileMode.Open, FileAccess.ReadWrite))
{
   //Loads an existing Word document into DocIO instance.
   using (WordDocument document = new WordDocument(fileStream, FormatType.Automatic))
   {
       string[] fieldNames = new string[] { "HeaderContent", "ProductName1", "ProductName2" };
       string[] fieldValues = new string[] { "Adventure Works Cycles", "Mountain-200", "Mountain-300" };
       //Performs the mail merge
       document.MailMerge.Execute(fieldNames, fieldValues);

       //Creates file stream.
       using (FileStream outputStream = new FileStream(Path.GetFullPath(@"Output/Result.docx"), FileMode.Create, FileAccess.ReadWrite))
       {
           //Saves the Word document to file stream.
           document.Save(outputStream, FormatType.Docx);
       }
   }
}

You can download a complete working sample to execute mail merge fields in a textbox, header, or footer in a Word document from the GitHub.

Output Word document

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

Conclusion

I hope you enjoyed learning about how to execute mail merge fields in a textbox, header, or footer in a Word document in .NET Core Word document.

You can refer to our ASP.NET Core DocIO feature tour page to know about its other groundbreaking feature representations and documentation, and how to quickly get started for configuration specifications. You can also explore our ASP.NET Core DocIO example to understand how to create and manipulate data.

For current customers, you can check out our components from the License and Downloads page. If you are new to Syncfusion®, you can try our 30-day free trial to check out our other controls.

If you have any queries or require clarifications, please let us know in the comments section below. You can also contact us through our support forums, Direct-Trac, or feedback portal. We are always happy to assist you!

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