Articles in this section
Category / Section

How to perform mail merge with two data sources in a Word document?

5 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 perform mail merge with two data sources in a Word document using C#.

To achieve this, set the ClearFields property to false to maintain unmerged merge fields. This allows you to execute the mail merge and then perform a second mail merge for the unmerged fields with a different data source.

Steps to perform mail merge with two data sources 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
Note:

Starting with v16.2.0.x, if you reference Syncfusion® assemblies from a 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 a trial message.

  1. Include the following namespaces in the Program.cs file.
    C#
using Syncfusion.DocIO.DLS;
using Syncfusion.DocIO; 
  1. Use the following code example to perform mail merge with two data sources in a Word document.
    C#
// Load the Word document
using (WordDocument document = new WordDocument(Path.GetFullPath(@"Data/EmployeesTemplate.docx")))
{
    //Sets “ClearFields” to true to remove empty mail merge fields from the document 
    document.MailMerge.ClearFields = false;
    //Gets the employee details as IEnumerable collection.
    List<Employee> employeeList = GetEmployees();
    //Creates an instance of MailMergeDataTable by specifying MailMerge group name and IEnumerable collection.
    MailMergeDataTable dataSource = new MailMergeDataTable("Employees", employeeList);
    //Performs Mail merge.
    document.MailMerge.ExecuteGroup(dataSource);

    //Uses the mail merge events handler for image fields.
    document.MailMerge.MergeImageField += new MergeImageFieldEventHandler(MergeField_LogoImage);
    //Gets the DataTable
    DataTable dataTable = GetDataTable();
    //Performs mail merge to merge the logo
    document.MailMerge.Execute(dataTable);

    // Save the modified document
    document.Save(Path.GetFullPath(@"../../../Output/Result.docx"), FormatType.Docx);
}
  1. Use the following code example to handle the MergeImageField event.
    C#
private static void MergeField_LogoImage(object sender, MergeImageFieldEventArgs args)
{
    //Binds image from file system during mail merge.
    if (args.FieldName == "Logo")
    {
        string photoFileName = args.FieldValue.ToString();
        //Gets the image from file system.
        FileStream imageStream = new FileStream(Path.GetFullPath(@"Data/" + photoFileName), FileMode.Open, FileAccess.Read);
        args.ImageStream = imageStream;
    }
}
  1. Use the following code example to get the details from different data sources.
    C#
public static List<Employee> GetEmployees()
{
    List<Employee> employees = new List<Employee>();
    employees.Add(new Employee("Nancy", "Smith", "Sales Representative", "505 - 20th Ave. E. Apt. 2A,", "Seattle", "WA", "USA"));
    employees.Add(new Employee("Andrew", "Fuller", "Vice President, Sales", "908 W. Capital Way", "Tacoma", "WA", "USA"));
    employees.Add(new Employee("Roland", "Mendel", "Sales Representative", "722 Moss Bay Blvd.", "Kirkland", "WA", "USA"));
    employees.Add(new Employee("Margaret", "Peacock", "Sales Representative", "4110 Old Redmond Rd.", "Redmond", "WA", "USA"));
    employees.Add(new Employee("Steven", "Buchanan", "Sales Manager", "14 Garrett Hill", "London", "Kirkland", "UK"));
    return employees;
}
private static DataTable GetDataTable()
{
    //Creates new DataTable instance 
    DataTable table = new DataTable();
    //Add columns in DataTable
    table.Columns.Add("Logo");

    //Add record in new DataRow
    DataRow row = table.NewRow();
    row["Logo"] = "Picture.png";
    table.Rows.Add(row);

    return table;
}
  1. Use the following code example to maintain employee details.
    C#
public class Employee
    {
        public string FirstName { get; set; }
        public string LastName { get; set; }
        public string Address { get; set; }
        public string City { get; set; }
        public string Region { get; set; }
        public string Country { get; set; }
        public string Title { get; set; }
        public Employee(string firstName, string lastName, string title, string address, string city, string region, string country)
        {
            FirstName = firstName;
            LastName = lastName;
            Title = title;
            Address = address;
            City = city;
            Region = region;
            Country = country;
        }
    }

You can download a complete working sample to perform mail merge with two data sources in a Word document from GitHub.

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, 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 perform mail merge with two data sources in a Word document in a .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 with 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