How to Remove Empty Column After Mail Merge in 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 remove an empty column after mail merge in a Word document using C#.
Follow the steps below:
- Find the table and column with the merge field.
- Execute the mail merge with an event handler.
- In the event handler, check if the merge field has a value.
- Use a Boolean flag to indicate whether the merge field contains a value.
- After the mail merge, remove the column if the merge field is empty.
Steps to remove the empty column after mail merge in Word document:
- Create a new .NET Core console application project.
- Install the Syncfusion.DocIO.Net.Core NuGet package as a reference to your project from NuGet.org.
Starting with v16.2.0.x, if you reference Syncfusion assemblies from 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 trail message.
- Include the following namespaces in Program.cs file
C#
using Syncfusion.DocIO.DLS;
using Syncfusion.DocIO;
- Use the following code example to remove the empty column after mail merge in Word document.
C#
//Boolean to check whether the merge field has value.
public static bool hasCostValue = false;
//Cell index of the merge field.
public static int cellIndex;
//Creates new Word document instance for Word processing.
using (WordDocument document = new WordDocument())
{
//Opens the Word template document.
Stream docStream = File.OpenRead(Path.GetFullPath(@"Data/Template.docx"));
document.Open(docStream, FormatType.Docx);
docStream.Dispose();
//Get the table.
WTable table = GetColumnIndex(document);
//Get the data set.
DataSet ds = GetData();
//Even handler to verify if a field has a valid value.
document.MailMerge.MergeField += new MergeFieldEventHandler(MergeField_TaskCost);
//Execute Mail Merge with groups.
document.MailMerge.ExecuteGroup(ds.Tables["Task_CostList"]);
if (!hasCostValue)
{
//Remove the empty column.
RemoveColumn(table);
}
//Saves and closes the Word document.
docStream = File.Create(Path.GetFullPath(@"Output/Output.docx"));
document.Save(docStream, FormatType.Docx);
docStream.Dispose();
}
- Use the following helper method to get the column index of a specific merge field within the Word document.
C#
/// <summary>
/// Get the column index.
/// </summary>
private static WTable GetColumnIndex(WordDocument document)
{
WTable table = null;
//Get the merge field.
WMergeField mergeField = document.FindItemByProperty(EntityType.MergeField, "FieldName", "Cost") as WMergeField;
if (mergeField != null)
{
//Check whether the merge field is present inside a table cell.
if (mergeField.OwnerParagraph.IsInCell)
{
WTableCell cell = mergeField.OwnerParagraph.OwnerTextBody as WTableCell;
//Get the column index.
cellIndex = cell.GetCellIndex();
table = cell.OwnerRow.Owner as WTable;
}
}
return table;
}
- Use the following helper method to get the data needed to perform a mail merge.
C#
/// <summary>
/// Gets the data to perform mail merge.
/// </summary>
private static DataSet GetData()
{
// Create a DataSet.
DataSet ds = new DataSet();
//List of Syncfusion products name.
string[] products = { "Task 1", "Task 2", "Task 3", "Task 4", "Task 5" };
//Add new Tables to the data set.
DataRow row;
ds.Tables.Add();
ds.Tables.Add();
//Add fields to the Task_CostList table.
ds.Tables[0].TableName = "Task_CostList";
ds.Tables[0].Columns.Add("Task");
ds.Tables[0].Columns.Add("Cost");
int count = 0;
//Insert values to the table row.
foreach (string product in products)
{
row = ds.Tables["Task_CostList"].NewRow();
row["Task"] = product;
ds.Tables["Task_CostList"].Rows.Add(row);
count++;
}
return ds;
}
- Use the following helper method to remove the column.
C#
/// <summary>
/// Remove the column.
/// </summary>
private static void RemoveColumn(WTable table)
{
//Iterate through all rows.
for (int i = table.Rows.Count - 1; i >= 0; i--)
{
//Remove the cell present in the cellIndex.
table.Rows[i].Cells.RemoveAt(cellIndex);
}
}
- Use the following helper method to process a merge field event to verify if a field has a valid value and set a flag accordingly.
C#
/// <summary>
/// Method to handle MergeField event to verify field value and set a flag.
/// </summary>
private static void MergeField_TaskCost(object sender, MergeFieldEventArgs args)
{
if ( args.FieldName == "Cost" && hasCostValue && args.FieldValue != null
&& args.FieldValue != DBNull.Value && args.FieldValue != string.Empty)
{
hasCostValue = true;
}
}
You can download a complete working sample to remove an empty column after 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 remove an empty column after 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!