How to Replace Merge Field with RTF In .NET Core Word Document?

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 replace merge field with RTF using mail merge in Word document using C#.

Steps to replace merge field with RTF using mail merge in Word document:

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

3. Include the following namespaces in Program.cs file
   C#

using Syncfusion.DocIO.DLS;
using Syncfusion.DocIO;
using System.Data;

4. Use the following code example to replace merge field with RTF using mail merge in Word document.
   C#

using (FileStream fileStream = new FileStream(Path.GetFullPath(@"Data/Template.docx"), FileMode.Open, FileAccess.ReadWrite))
{
   //Open an existing Word document.
   using (WordDocument document = new WordDocument(fileStream, FormatType.Docx))
   {
       //Gets data to perform the mail merge.
       DataTable table = GetDataTable();
       //Executes the mail merge using the provided data.
       document.MailMerge.Execute(table);
       //Replaces placeholder text with content from RTF files.
       InsertRTF(document);
       //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);
       }
   }
}

5. Use the following helper method to get data to perform the mail merge.
   C#

/// <summary>
/// Create and return a DataTable with sample data for the mail merge.
/// </summary>
private static DataTable GetDataTable()
{
   //Create a new DataTable with columns matching the merge fields.
   DataTable dataTable = new DataTable("RTF");
   dataTable.Columns.Add("CustomerName");
   dataTable.Columns.Add("Address");
   dataTable.Columns.Add("Phone");
   dataTable.Columns.Add("ProductList");

   //Create a new row and add sample data.
   DataRow datarow = dataTable.NewRow();
   dataTable.Rows.Add(datarow);
   datarow["CustomerName"] = "Nancy Davolio";
   datarow["Address"] = "59 rue de I'Abbaye, Reims 51100, France";
   datarow["Phone"] = "1-888-936-8638";

   //Append placeholder text for RTF content into the row.
   datarow["ProductList"] = "#InsertRTF_ProductList#";
   return dataTable;
}

6. Use the following helper method to replace the placeholders in the Word document with RTF content.
   C#

/// <summary>
/// Replace the placeholders in the Word document with RTF content.
/// </summary>
private static void InsertRTF(WordDocument document)
{
   using (FileStream fileStream = new FileStream(Path.GetFullPath(@"Data/ProductList.rtf"), FileMode.Open, FileAccess.ReadWrite))
   {
       //Open the RTF document.
       using (WordDocument rtfDocument = new WordDocument(fileStream, FormatType.Rtf))
       {
           //Replace the placeholder with RTF content.
           document.Replace("#InsertRTF_ProductList#", rtfDocument, true, true);
       }
   }
}

You can download a complete working sample to replace merge field with RTF using mail merge in Word document from the GitHub.

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 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 how to replace merge field with RTF 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!