MailMerge: Merging Fields from Child Tables or Related Objects
MailMerge resolves child table and related object data using dot-prefixed merge field names. The master table passed to Merge or MergeObjects drives document instances, while prefixed fields map to related DataTables or nested object properties. Merge blocks define scoped relations.

The Merge method of MailMerge accepts a DataTable as a parameter and the MergeObjects method accepts an IEnumerable object such as a List as the data source. This DataTable or object acts as the master table for the merge process.
MergeField names without a prefix in the template are matched to this table and doesn't require a prefix. The rows of the master table are used to create the document instances of the template. In other words: The number of resulting documents in a merge process depends on the number of records in the master table.
All relations between child tables and the master table is defined as a prefix in the merge field name concatenated with a dot:
ChildTable[.ChildTable].ColumnName
Our sample database has the following structure:
In case the master table is Sales_SalesOrderHeader, the merge field values for MergeFields without a prefix are coming from this table. If MergeFields have a prefix, the values are coming from related tables such as Sales_SalesOrderDetail:
Sales_SalesOrdcerDetail.ProductID
The master table is the base table for the complete report. Inside of merge blocks, the master table for this block is the merge block table. All child tables of this block table can be used inside of the merge block with the same notation. In other words: Each merge block as a new master table and relations are based on the block master table.
As a business object, the above DataSet would look similar to the illustrated classes below:
The class SalesOrderHeader has a property of type SalesOrderDetail which acts like a child table in our datasource context.
class SalesOrderHeader
{
public int RevisionNumber { get; set; }
public DateTime OrderDate { get; set; }
public SalesOrderDetail OrderDetail { get; set; }
}
class SalesOrderDetail
{
public List<Production_Product> Products { get; set; }
public Customer Customer { get; set; }
}
class Production_Product
{
public string Name { get; set; }
public string ProductNumber { get; set; }
}
class Customer
{
public int CustomerID { get; set; }
public string Name { get; set; }
public int SalesPersonID { get; set; }
}
The merge field name syntax is following the same rules as for DataTables. The relation between related objects is defined as a prefix in the merge field name concatenated with a dot.
Reporting
The Text Control Reporting Framework combines powerful reporting features with an easy-to-use, MS Word compatible word processor. Users can create documents and templates using ordinary Microsoft Word skills. The Reporting Framework is included in all .NET based TX Text Control products including ASP.NET, Windows Forms and WPF.
Related Posts
MailMerge Class Settings Explained
The MailMerge class provides four properties to control merge output: RemoveEmptyFields, RemoveEmptyLines, RemoveEmptyBlocks, and RemoveEmptyImages. Each property handles unmatched or missing data…
Merge Excel Documents into MailMerge Templates using IncludeText Fields
IncludeText fields in TX Text Control templates reference external Excel files during mail merge. The process loads .xlsx files as temporary ServerTextControl instances, using Bookmark to target…
MailMerge: Conditional Table Cell Colors using Filter Instructions
The TX Text Control MailMerge FieldMerged event exposes TableCell instances during merge for conditional formatting. A CellFilterInstructions class parses filter rules from merge field names and…
MailMerge: Using Filters to Remove Unwanted Rows
TX Text Control merge block filters remove unwanted rows from repeating data during the mail merge process without modifying the underlying source. Filter conditions applied to merge blocks…
ReportingWindows FormsMail Merge
MailMerge: Conditional Rendering of Merge Blocks
TX Text Control X16 provides two approaches to conditionally render merge blocks within MailMerge templates. Setting RemoveEmptyBlocks removes blocks when child data is absent, while…
