FieldMergingArgsBase

FieldMergingArgsBase class

Base class for FieldMergingArgs and ImageFieldMergingArgs.

To learn more, visit the Mail Merge and Reporting documentation article.

public abstract class FieldMergingArgsBase

Properties

NameDescription
Document { get; }Returns the Document object for which the mail merge is performed.
DocumentFieldName { get; }Gets the name of the merge field as specified in the document.
Field { get; }Gets the object that represents the current merge field.
FieldName { get; }Gets the name of the merge field in the data source.
FieldValue { get; set; }Gets or sets the value of the field from the data source.
RecordIndex { get; }Gets the zero based index of the record that is being merged.
TableName { get; }Gets the name of the data table for the current merge operation or empty string if the name is not available.

Examples

Shows how to execute a mail merge with a custom callback that handles merge data in the form of HTML documents.

Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);

builder.InsertField(@"MERGEFIELD  html_Title  \b Content");
builder.InsertField(@"MERGEFIELD  html_Body  \b Content");

object[] mergeData =
{
    "<html>" +
        "<h1>" +
            "<span style=\"color: #0000ff; font-family: Arial;\">Hello World!</span>" +
        "</h1>" +
    "</html>", 

    "<html>" +
        "<blockquote>" +
            "<p>Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.</p>" +
        "</blockquote>" +
    "</html>"
};

doc.MailMerge.FieldMergingCallback = new HandleMergeFieldInsertHtml();
doc.MailMerge.Execute(new[] { "html_Title", "html_Body" }, mergeData);

doc.Save(ArtifactsDir + "MailMergeEvent.MergeHtml.docx");

Shows how to execute a mail merge with a custom callback that handles merge data in the form of HTML documents (HandleMergeFieldInsertHtml).

/// <summary>
/// If the mail merge encounters a MERGEFIELD whose name starts with the "html_" prefix,
/// this callback parses its merge data as HTML content and adds the result to the document location of the MERGEFIELD.
/// </summary>
private class HandleMergeFieldInsertHtml : IFieldMergingCallback
{
    /// <summary>
    /// Called when a mail merge merges data into a MERGEFIELD.
    /// </summary>
    void IFieldMergingCallback.FieldMerging(FieldMergingArgs args)
    {
        if (args.DocumentFieldName.StartsWith("html_") && args.Field.GetFieldCode().Contains("\\b"))
        {
            // Add parsed HTML data to the document's body.
            DocumentBuilder builder = new DocumentBuilder(args.Document);
            builder.MoveToMergeField(args.DocumentFieldName);
            builder.InsertHtml((string)args.FieldValue);

            // Since we have already inserted the merged content manually,
            // we will not need to respond to this event by returning content via the "Text" property. 
            args.Text = string.Empty;
        }
    }

    void IFieldMergingCallback.ImageFieldMerging(ImageFieldMergingArgs args)
    {
        // Do nothing.
    }
}

See Also

FieldMergingArgs Class IFieldMergingCallback Interface