Merge pull request #267 from VijayadharshiniMathiyalagan/ES-884992-How-to-skip-a-range-of-records-during-mail-merge-in-Word-document

Added sample to skip a range of records during mail-merge

Author: MohanaselvamJothi

Mail-Merge/Skip-range-of-records/Skip-range-of-records.sln

@@ -0,0 +1,25 @@
+
+Microsoft Visual Studio Solution File, Format Version 12.00
+# Visual Studio Version 17
+VisualStudioVersion = 17.12.35309.182
+MinimumVisualStudioVersion = 10.0.40219.1
+Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Skip-range-of-records", "Skip-range-of-records\Skip-range-of-records.csproj", "{3BADC57D-9594-49A2-92B3-A9925C41E66E}"
+EndProject
+Global
+	GlobalSection(SolutionConfigurationPlatforms) = preSolution
+		Debug|Any CPU = Debug|Any CPU
+		Release|Any CPU = Release|Any CPU
+	EndGlobalSection
+	GlobalSection(ProjectConfigurationPlatforms) = postSolution
+		{3BADC57D-9594-49A2-92B3-A9925C41E66E}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{3BADC57D-9594-49A2-92B3-A9925C41E66E}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{3BADC57D-9594-49A2-92B3-A9925C41E66E}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{3BADC57D-9594-49A2-92B3-A9925C41E66E}.Release|Any CPU.Build.0 = Release|Any CPU
+	EndGlobalSection
+	GlobalSection(SolutionProperties) = preSolution
+		HideSolutionNode = FALSE
+	EndGlobalSection
+	GlobalSection(ExtensibilityGlobals) = postSolution
+		SolutionGuid = {DFC8B131-CCB4-495D-B062-BB8386F39BF6}
+	EndGlobalSection
+EndGlobal

Mail-Merge/Skip-range-of-records/Skip-range-of-records/Data/Template.docx

@@ -0,0 +1 @@
+

Mail-Merge/Skip-range-of-records/Skip-range-of-records/Output/.gitkeep

@@ -0,0 +1,59 @@
+using Syncfusion.DocIO;
+using Syncfusion.DocIO.DLS;
+using System.Data;
+
+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);
+        }
+    }
+}
+
+#region Helper methods
+/// <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;
+}
+
+/// <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;  
+}
+
+#endregion

Mail-Merge/Skip-range-of-records/Skip-range-of-records/Program.cs

@@ -0,0 +1,24 @@
+<Project Sdk="Microsoft.NET.Sdk">
+
+  <PropertyGroup>
+    <OutputType>Exe</OutputType>
+    <TargetFramework>net8.0</TargetFramework>
+    <RootNamespace>Skip_range_of_records</RootNamespace>
+    <ImplicitUsings>enable</ImplicitUsings>
+    <Nullable>enable</Nullable>
+  </PropertyGroup>
+	
+	<ItemGroup>
+    <PackageReference Include="Syncfusion.DocIO.Net.Core" Version="*" />
+  </ItemGroup>
+
+  <ItemGroup>
+    <None Update="Data\Template.docx">
+      <CopyToOutputDirectory>Always</CopyToOutputDirectory>
+    </None>
+    <None Update="Output\.gitkeep">
+      <CopyToOutputDirectory>Always</CopyToOutputDirectory>
+    </None>
+  </ItemGroup>
+
+</Project>