How to skip a range of records 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 skip a range of records during mail merge in a Word document using C#.

To achieve this, follow the steps below:

• Retrieve data to fill the document during the mail merge.
• Perform the mail merge using a merge field event handler.
• In the event handler, clear the merge field text for specific row indices (e.g., between 2 and 7) to skip those records from the final output.

Steps to skip a range of records 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;
using Syncfusion.DocIO.DLS; 
using System.Data;

4. Use the following code example to skip a range of records during mail merge in a Word document.
   C#

using (FileStream fileStream = new FileStream(Path.GetFullPath(@"Data/Template.docx"), FileMode.Open, FileAccess.ReadWrite))
{
   // Opens the template document.
   using (WordDocument document = new WordDocument(fileStream, FormatType.Docx))
   {
       // Uses the mail merge events to skip a range of records during mail merge.
       document.MailMerge.MergeField += new MergeFieldEventHandler(SkipRangeOfRecords);
       // Executes Mail Merge with groups.
       document.MailMerge.ExecuteGroup(GetDataTable());
       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 event handler to specify which records to skip during the mail merge.
   C#

/// <summary>
/// Event handler to skip a range of records during mail merge.
/// </summary>
void SkipRangeOfRecords(object sender, MergeFieldEventArgs args)
{
   // Check if the current row index is between 2 and 7.
   // If so, set the field text to an empty string, effectively skipping those records.
   if (args.RowIndex > 2 && args.RowIndex < 7)
       args.Text = string.Empty;
}

6. Use the following helper method to get a DataTable populated with employee data for mail merge.
   C#

/// <summary>
/// Gets a DataTable populated with employee data for mail merge.
/// </summary>
DataTable GetDataTable()
{
   // Create a new DataTable with columns for employee name and number.
   DataTable dataTable = new DataTable("Employee");
   dataTable.Columns.Add("EmployeeName");
   dataTable.Columns.Add("EmployeeNumber");

   // Populate the DataTable with 20 rows of employee data.
   for (int i = 0; i < 20; i++)
   {
       // Create a new DataRow and add it to the DataTable.
       DataRow datarow = dataTable.NewRow();
       dataTable.Rows.Add(datarow);
       // Set employee name.
       datarow[0] = "Employee" + i.ToString();
       // Set employee number.
       datarow[1] = "EMP" + i.ToString();       
   }
   // Return the populated DataTable.
   return dataTable;  
}

You can download a complete working sample to skip a range of records during mail merge in a 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 about how to skip a range of records during mail merge in a 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!