How to insert multiple images into a single merge field during mail merge in a 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 insert multiple images into a single merge field during mail merge in a Word document using C#.

To achieve this, use MergeImageField event to insert the picture at the merge field position. Similarly, insert the remaining pictures at the next index position and set the field value as empty.

Steps to insert multiple images into a single merge field during mail merge in a 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; 

4. Use the following code example to insert multiple images into a single merge field during 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))
   {
       //Uses the mail merge events handler for image fields.
       document.MailMerge.MergeImageField += new MergeImageFieldEventHandler(MergeField_ProductImage);
       //Specifies the field names and field values.
       string[] fieldNames = new string[] { "Logo" , "Name", "Company" };
       string[] fieldValues = new string[] { "AdventureImages", "Nancy Davilo", "Syncfusion" };
       //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);
       }
   }
}

4. Use the following code example to insert multiple images into a single merge field using MergeImageField event.
   C#

private static void MergeField_ProductImage(object sender, MergeImageFieldEventArgs args)
{
   //Binds image from file system during mail merge
   if (args.FieldName == "Logo")
   {
       //Gets the current merge field owner paragraph.
       WParagraph paragraph = args.CurrentMergeField.OwnerParagraph;
       //Gets the current merge field index in the current paragraph.
       int mergeFieldIndex = paragraph.ChildEntities.IndexOf(args.CurrentMergeField);
       //Gets the folder name from the field value.
       string ProductFolderName = args.FieldValue.ToString();
       // Define allowed image extensions
       string[] imageExtensions = { ".jpg", ".jpeg", ".png", ".bmp", ".gif", ".tiff" };
       // Gets the image names from the Data folder
       string[] imageNames = Directory.GetFiles(Path.GetFullPath(@"Data/"))
                                      .Where(file => imageExtensions.Contains(Path.GetExtension(file).ToLower()))
                                      .ToArray();
       //Loops through the image names.
       foreach (string imageName in imageNames)
       {
           //Gets the image from file system
           FileStream imageStream = new FileStream(imageName, FileMode.Open, FileAccess.Read);
           //Creates a new picture.
           WPicture picture = new WPicture(paragraph.Document);
           //Loads the image into picture.
           picture.LoadImage(imageStream);
           //Resizes the picture
           picture.Height = 50;
           picture.Width = 50;
           //Inserts the picture at the current merge field index.
           paragraph.ChildEntities.Insert(mergeFieldIndex, picture);
           mergeFieldIndex++;
       }
       //Set field value as empty.
       args.Text = string.Empty;
   }
} 

You can download a complete working sample to insert multiple images into a single merge field during mail merge in a Word document from the GitHub.

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 insert multiple images into a single merge field during mail merge 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!