Skip to content

Latest commit

 

History

History
98 lines (74 loc) · 4.02 KB

nested-mailmerge-radwordsprocessing.md

File metadata and controls

98 lines (74 loc) · 4.02 KB
title description type page_title slug tags res_type ticketid
Performing Nested MailMerge with Multiple Levels in RadWordsProcessing
Learn how to implement nested MailMerge operations with multiple levels of data, such as handling lists within lists, in RadWordsProcessing.
how-to
How to Handle Nested MailMerge with Multi-Level Data in RadWordsProcessing
nested-mailmerge-radwordsprocessing
wordsprocessing, mailmerge, nested, data, list, document, processing
kb
1668943

Environment

Version Product Author
2024.3.806 RadWordsProcessing Desislava Yordanova

Description

Learn how to perform a [MailMerge]({%slug radwordsprocessing-editing-mail-merge%}) operation with multiple levels of nested data, such as a list within a list (e.g., Incident > Person > Phones) in [RadWordsProcessing]({%slug radwordsprocessing-overview%}).

Solution

To achieve a nested [MailMerge]({%slug radwordsprocessing-editing-mail-merge%} operation with multiple levels of data, follow the steps below:

  1. Prepare your data model to reflect the nested structure. In this case, the model includes Incident, Person, and Phone classes.

  2. Use the [MailMerge]({%slug radwordsprocessing-editing-mail-merge%}) method to merge the data with the document template. Ensure your document template has the appropriate merge fields defined for each level of data.

  3. Use special merge fields (TableStart, TableEnd, RangeStart, and RangeEnd) to denote the beginning and end of each nested collection.

Here is an example demonstrating how to set up your data model and perform the nested 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; }
}

// Preparing 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 People list: TableStart:People and TableEnd:People.
  • For the start and end of the Phones list within each Person: RangeStart:Phones and RangeEnd:Phones.
  • For merging individual property values, use merge fields named after the properties, such as FirstName, LastName, and PhoneNumber.

Nested mail merge template

Generating the Necessary Table Structure in the Document

When dealing with nested collections, it's crucial to dynamically create table structures that can accommodate the varying lengths of these collections.

By following these steps and utilizing the provided code snippets, you can effectively perform nested MailMerge operations with multiple levels of data in RadWordsProcessing.

Nested mail merge

See Also

  • [MailMerge]({%slug radwordsprocessing-editing-mail-merge%})
  • [Generating a Word Document with Data Using MailMerge in RadWordsProcessing]({%slug generate-doc-template-and-populate-with-collection-data-mail-merge%})
  • [Populate a Table with Data using Nested Mail Merge Functionality]({%slug populate-table-data-mail-merge%})