Performing Nested MailMerge with Multiple Levels in RadWordsProcessing
Environment
| Version | Product | Author |
|---|---|---|
| 2024.3.806 | RadWordsProcessing | Desislava Yordanova |
Description
This article shows how to perform a MailMerge operation with multiple levels of nested data, such as a list within a list (for example, Incident > Person > Phones) in RadWordsProcessing.
Solution
To perform a nested MailMerge operation with multiple levels of data, follow these steps:
-
Prepare your data model to reflect the nested structure. In this case, the model includes the
Incident,Person, andPhoneclasses. -
Use the MailMerge method to merge the data with the document template. Ensure your document template has the appropriate merge fields defined for each level of data.
-
Use special merge fields (
TableStart,TableEnd,RangeStart, andRangeEnd) to denote the beginning and end of each nested collection.
The following example shows how to set up your data model and perform the nested MailMerge:
Example 1: Set Up Nested Data Model and Perform MailMerge
// Define your data models.
public class Incident
{
public string ReportNumber { get; set; }
public List<Person> People { get; set; }
}
public class Person
{
public string FirstName { get; set; }
public string LastName { get; set; }
public List<Phone> Phones { get; set; }
}
public class Phone
{
public string PhoneNumber { get; set; }
}
// Prepare the data.
var mergeData = new List<Incident>{
new Incident{
ReportNumber = "INC-2024-001",
People = new List<Person>{
new Person{
FirstName = "John",
LastName = "Doe",
Phones = new List<Phone>{
new Phone{ PhoneNumber = "310-555-0101" },
new Phone{ PhoneNumber = "310-555-0102" }
}
},
// Add more Person instances as needed.
}
}
};
// Perform the MailMerge operation.
RadFlowDocument document = new RadFlowDocument();
// Assume 'provider' is initialized and points to the appropriate document format provider.
var mailMergeResult = document.MailMerge(mergeData);
In your document template, ensure you have the corresponding merge fields:
-
For the start and end of the
Peoplelist:TableStart:PeopleandTableEnd:People. -
For the start and end of the
Phoneslist within eachPerson:RangeStart:PhonesandRangeEnd:Phones. -
For merging individual property values, use merge fields named after the properties, such as
FirstName,LastName, andPhoneNumber.
Generating the Table Structure in the Document
When you work with nested collections, you must dynamically create table structures that accommodate the varying lengths of these collections.
The following image shows the result of the nested MailMerge operation:
