IFieldMergingCallback class
IFieldMergingCallback class
Implement this interface if you want to control how data is inserted into merge fields during a mail merge operation.
Methods
Name | Description |
---|---|
field_merging(args) | Called when the Aspose.Words mail merge engine is about to insert data into a merge field in the document. |
image_field_merging(args) | Called when the Aspose.Words mail merge engine is about to insert an image into a merge field. |
Examples
Shows how to execute a mail merge with a custom callback that handles merge data in the form of HTML documents.
def test_merge_html(self):
doc = aw.Document()
builder = aw.DocumentBuilder(doc)
builder.insert_field(r"MERGEFIELD html_Title \b Content")
builder.insert_field(r"MERGEFIELD html_Body \b Content")
merge_data = [
"<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.mail_merge.field_merging_callback = ExMailMergeEvent.HandleMergeFieldInsertHtml()
doc.mail_merge.execute(["html_Title", "html_Body"], merge_data)
doc.save(ARTIFACTS_DIR + "MailMergeEvent.merge_html.docx")
class HandleMergeFieldInsertHtml(aw.mailmerging.IFieldMergingCallback):
"""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."""
def field_merging(self, args: aw.mailmerging.FieldMergingArgs):
"""Called when a mail merge merges data into a MERGEFIELD."""
if args.document_field_name.startswith("html_") and "\\b" in args.field.get_field_code():
# Add parsed HTML data to the document's body.
builder = aw.DocumentBuilder(args.document)
builder.move_to_merge_field(args.document_field_name)
builder.insert_html(str(args.field_value))
# 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 = ""
def image_field_merging(self, args: aw.mailmerging.ImageFieldMergingArgs):
# Do nothing.
pass
Shows how to insert images stored in a database BLOB field into a report.
def test_image_from_blob(self):
doc = aw.Document(MY_DIR + "Mail merge destination - Northwind employees.docx")
doc.mail_merge.field_merging_callback = ExMailMergeEvent.HandleMergeImageFieldFromBlob()
conn_string = f"Provider=Microsoft.Jet.OLEDB.4.0;Data Source={DatabaseDir + 'Northwind.mdb'};"
query = "SELECT FirstName, LastName, Title, Address, City, Region, Country, PhotoBLOB FROM Employees"
with OleDbConnection(conn_string) as conn:
conn.open()
# Open the data reader, which needs to be in a mode that reads all records at once.
cmd = OleDbCommand(query, conn)
data_reader = cmd.execute_reader()
doc.mail_merge.execute_with_regions(data_reader, "Employees")
doc.save(ARTIFACTS_DIR + "MailMergeEvent.image_from_blob.docx")
class HandleMergeImageFieldFromBlob(aw.mailmerging.IFieldMergingCallback):
def field_merging(self, args: aw.mailmerging.FieldMergingArgs):
# Do nothing.
pass
def image_field_merging(self, args: aw.mailmerging.ImageFieldMergingArgs):
"""This is called when a mail merge encounters a MERGEFIELD in the document with an "Image:" tag in its name."""
args.image_stream = io.BytesIO(args.field_value)
See Also
- module aspose.words.mailmerging