com.aspose.words

Class MailMerger

java.lang.Object

com.aspose.words.Processor

com.aspose.words.MailMerger

public class MailMerger
extends Processor

Provides methods intended to fill template with data using simple mail merge and mail merge with regions operations.

Field Summary

Fields inherited from class com.aspose.words.Processor

mResultDocument

Method Summary

Modifier and Type	Method and Description
static MailMerger	create(MailMergerContext context) Creates new instance of the mail merger processor.
static void	execute(java.io.InputStream inputStream, java.io.OutputStream outputStream, int saveFormat, DataRow dataRow)
static void	execute(java.io.InputStream inputStream, java.io.OutputStream outputStream, int saveFormat, DataRow dataRow, MailMergeOptions mailMergeOptions)
static void	execute(java.io.InputStream inputStream, java.io.OutputStream outputStream, int saveFormat, DataTable dataTable)
static void	execute(java.io.InputStream inputStream, java.io.OutputStream outputStream, int saveFormat, DataTable dataTable, MailMergeOptions mailMergeOptions)
static void	execute(java.io.InputStream inputStream, java.io.OutputStream outputStream, int saveFormat, java.lang.String[] fieldNames, java.lang.Object[] fieldValues)
static void	execute(java.io.InputStream inputStream, java.io.OutputStream outputStream, int saveFormat, java.lang.String[] fieldNames, java.lang.Object[] fieldValues, MailMergeOptions mailMergeOptions)
static void	execute(java.io.InputStream inputStream, java.io.OutputStream outputStream, SaveOptions saveOptions, DataRow dataRow)
static void	execute(java.io.InputStream inputStream, java.io.OutputStream outputStream, SaveOptions saveOptions, DataRow dataRow, MailMergeOptions mailMergeOptions)
static void	execute(java.io.InputStream inputStream, java.io.OutputStream outputStream, SaveOptions saveOptions, DataTable dataTable)
static void	execute(java.io.InputStream inputStream, java.io.OutputStream outputStream, SaveOptions saveOptions, DataTable dataTable, MailMergeOptions mailMergeOptions)
static void	execute(java.io.InputStream inputStream, java.io.OutputStream outputStream, SaveOptions saveOptions, java.lang.String[] fieldNames, java.lang.Object[] fieldValues)
static void	execute(java.io.InputStream inputStream, java.io.OutputStream outputStream, SaveOptions saveOptions, java.lang.String[] fieldNames, java.lang.Object[] fieldValues, MailMergeOptions mailMergeOptions)
static void	execute(java.lang.String inputFileName, java.lang.String outputFileName, DataRow dataRow) Performs mail merge from a DataRow into the document.
static void	execute(java.lang.String inputFileName, java.lang.String outputFileName, DataTable dataTable) Performs mail merge from a DataTable into the document.
static void	execute(java.lang.String inputFileName, java.lang.String outputFileName, int saveFormat, DataRow dataRow)
static void	execute(java.lang.String inputFileName, java.lang.String outputFileName, int saveFormat, DataRow dataRow, MailMergeOptions mailMergeOptions)
static void	execute(java.lang.String inputFileName, java.lang.String outputFileName, int saveFormat, DataTable dataTable)
static void	execute(java.lang.String inputFileName, java.lang.String outputFileName, int saveFormat, DataTable dataTable, MailMergeOptions mailMergeOptions)
static void	execute(java.lang.String inputFileName, java.lang.String outputFileName, int saveFormat, java.lang.String[] fieldNames, java.lang.Object[] fieldValues)
static void	execute(java.lang.String inputFileName, java.lang.String outputFileName, int saveFormat, java.lang.String[] fieldNames, java.lang.Object[] fieldValues, MailMergeOptions mailMergeOptions)
static void	execute(java.lang.String inputFileName, java.lang.String outputFileName, SaveOptions saveOptions, DataRow dataRow)
static void	execute(java.lang.String inputFileName, java.lang.String outputFileName, SaveOptions saveOptions, DataRow dataRow, MailMergeOptions mailMergeOptions) Performs mail merge from a DataRow into the document.
static void	execute(java.lang.String inputFileName, java.lang.String outputFileName, SaveOptions saveOptions, DataTable dataTable)
static void	execute(java.lang.String inputFileName, java.lang.String outputFileName, SaveOptions saveOptions, DataTable dataTable, MailMergeOptions mailMergeOptions) Performs mail merge from a DataRow into the document.
static void	execute(java.lang.String inputFileName, java.lang.String outputFileName, SaveOptions saveOptions, java.lang.String[] fieldNames, java.lang.Object[] fieldValues)
static void	execute(java.lang.String inputFileName, java.lang.String outputFileName, SaveOptions saveOptions, java.lang.String[] fieldNames, java.lang.Object[] fieldValues, MailMergeOptions mailMergeOptions) Performs a mail merge operation for a single record.
static void	execute(java.lang.String inputFileName, java.lang.String outputFileName, java.lang.String[] fieldNames, java.lang.Object[] fieldValues) Performs a mail merge operation for a single record.
protected void	executeCore()
static java.io.OutputStream[]	executeToImages(java.io.InputStream inputStream, ImageSaveOptions saveOptions, DataRow dataRow)
static java.io.OutputStream[]	executeToImages(java.io.InputStream inputStream, ImageSaveOptions saveOptions, DataRow dataRow, MailMergeOptions mailMergeOptions) Performs mail merge from a DataRow into the document and renders the result to images.
static java.io.OutputStream[]	executeToImages(java.io.InputStream inputStream, ImageSaveOptions saveOptions, DataTable dataTable)
static java.io.OutputStream[]	executeToImages(java.io.InputStream inputStream, ImageSaveOptions saveOptions, DataTable dataTable, MailMergeOptions mailMergeOptions) Performs mail merge from a DataRow into the document and renders the result to images.
static java.io.OutputStream[]	executeToImages(java.io.InputStream inputStream, ImageSaveOptions saveOptions, java.lang.String[] fieldNames, java.lang.Object[] fieldValues)
static java.io.OutputStream[]	executeToImages(java.io.InputStream inputStream, ImageSaveOptions saveOptions, java.lang.String[] fieldNames, java.lang.Object[] fieldValues, MailMergeOptions mailMergeOptions) Performs a mail merge operation for a single record and renders the result to images.
static java.io.OutputStream[]	executeToImages(java.lang.String inputFileName, ImageSaveOptions saveOptions, DataRow dataRow)
static java.io.OutputStream[]	executeToImages(java.lang.String inputFileName, ImageSaveOptions saveOptions, DataRow dataRow, MailMergeOptions mailMergeOptions) Performs mail merge from a DataRow into the document and renders the result to images.
static java.io.OutputStream[]	executeToImages(java.lang.String inputFileName, ImageSaveOptions saveOptions, DataTable dataTable)
static java.io.OutputStream[]	executeToImages(java.lang.String inputFileName, ImageSaveOptions saveOptions, DataTable dataTable, MailMergeOptions mailMergeOptions) Performs mail merge from a DataRow into the document and renders the result to images.
static java.io.OutputStream[]	executeToImages(java.lang.String inputFileName, ImageSaveOptions saveOptions, java.lang.String[] fieldNames, java.lang.Object[] fieldValues)
static java.io.OutputStream[]	executeToImages(java.lang.String inputFileName, ImageSaveOptions saveOptions, java.lang.String[] fieldNames, java.lang.Object[] fieldValues, MailMergeOptions mailMergeOptions) Performs a mail merge operation for a single record and renders the result to images.
static void	executeWithRegions(java.io.InputStream inputStream, java.io.OutputStream outputStream, int saveFormat, DataSet dataSet)
static void	executeWithRegions(java.io.InputStream inputStream, java.io.OutputStream outputStream, int saveFormat, DataSet dataSet, MailMergeOptions mailMergeOptions)
static void	executeWithRegions(java.io.InputStream inputStream, java.io.OutputStream outputStream, int saveFormat, DataTable dataTable)
static void	executeWithRegions(java.io.InputStream inputStream, java.io.OutputStream outputStream, int saveFormat, DataTable dataTable, MailMergeOptions mailMergeOptions)
static void	executeWithRegions(java.io.InputStream inputStream, java.io.OutputStream outputStream, SaveOptions saveOptions, DataSet dataSet)
static void	executeWithRegions(java.io.InputStream inputStream, java.io.OutputStream outputStream, SaveOptions saveOptions, DataSet dataSet, MailMergeOptions mailMergeOptions)
static void	executeWithRegions(java.io.InputStream inputStream, java.io.OutputStream outputStream, SaveOptions saveOptions, DataTable dataTable)
static void	executeWithRegions(java.io.InputStream inputStream, java.io.OutputStream outputStream, SaveOptions saveOptions, DataTable dataTable, MailMergeOptions mailMergeOptions)
static void	executeWithRegions(java.lang.String inputFileName, java.lang.String outputFileName, DataSet dataSet) Performs mail merge from a DataSet into a document with mail merge regions.
static void	executeWithRegions(java.lang.String inputFileName, java.lang.String outputFileName, DataTable dataTable) Performs mail merge from a DataTable into the document with mail merge regions.
static void	executeWithRegions(java.lang.String inputFileName, java.lang.String outputFileName, int saveFormat, DataSet dataSet)
static void	executeWithRegions(java.lang.String inputFileName, java.lang.String outputFileName, int saveFormat, DataSet dataSet, MailMergeOptions mailMergeOptions)
static void	executeWithRegions(java.lang.String inputFileName, java.lang.String outputFileName, int saveFormat, DataTable dataTable)
static void	executeWithRegions(java.lang.String inputFileName, java.lang.String outputFileName, int saveFormat, DataTable dataTable, MailMergeOptions mailMergeOptions)
static void	executeWithRegions(java.lang.String inputFileName, java.lang.String outputFileName, SaveOptions saveOptions, DataSet dataSet)
static void	executeWithRegions(java.lang.String inputFileName, java.lang.String outputFileName, SaveOptions saveOptions, DataSet dataSet, MailMergeOptions mailMergeOptions) Performs mail merge from a DataSet into the document with mail merge regions.
static void	executeWithRegions(java.lang.String inputFileName, java.lang.String outputFileName, SaveOptions saveOptions, DataTable dataTable)
static void	executeWithRegions(java.lang.String inputFileName, java.lang.String outputFileName, SaveOptions saveOptions, DataTable dataTable, MailMergeOptions mailMergeOptions) Performs mail merge from a DataTable into the document with mail merge regions.
static java.io.OutputStream[]	executeWithRegionsToImages(java.io.InputStream inputStream, ImageSaveOptions saveOptions, DataSet dataSet)
static java.io.OutputStream[]	executeWithRegionsToImages(java.io.InputStream inputStream, ImageSaveOptions saveOptions, DataSet dataSet, MailMergeOptions mailMergeOptions) Performs mail merge from a DataSet into the document with mail merge regions and renders the result to images.
static java.io.OutputStream[]	executeWithRegionsToImages(java.io.InputStream inputStream, ImageSaveOptions saveOptions, DataTable dataTable)
static java.io.OutputStream[]	executeWithRegionsToImages(java.io.InputStream inputStream, ImageSaveOptions saveOptions, DataTable dataTable, MailMergeOptions mailMergeOptions) Performs mail merge from a DataTable into the document with mail merge regions and renders the result to images.
static java.io.OutputStream[]	executeWithRegionsToImages(java.lang.String inputFileName, ImageSaveOptions saveOptions, DataSet dataSet)
static java.io.OutputStream[]	executeWithRegionsToImages(java.lang.String inputFileName, ImageSaveOptions saveOptions, DataSet dataSet, MailMergeOptions mailMergeOptions) Performs mail merge from a DataSet into the document with mail merge regions and renders the result to images.
static java.io.OutputStream[]	executeWithRegionsToImages(java.lang.String inputFileName, ImageSaveOptions saveOptions, DataTable dataTable)
static java.io.OutputStream[]	executeWithRegionsToImages(java.lang.String inputFileName, ImageSaveOptions saveOptions, DataTable dataTable, MailMergeOptions mailMergeOptions) Performs mail merge from a DataTable into the document with mail merge regions and renders the result to images.

Methods inherited from class com.aspose.words.Processor

checkArgumentsSet, execute, from, from, from, from, getPartFileName, to, to, to, to, to, to, to, toOutput, toOutput

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

create

public static MailMerger create(MailMergerContext context)

Creates new instance of the mail merger processor.

Examples:

Shows how to do mail merge operation for a single record using context.

 
 // There is a several ways to do mail merge operation:
 String doc = getMyDir() + "Mail merge.doc";

 String[] fieldNames = new String[]{"FirstName", "Location", "SpecialCharsInName()"};
 String[] fieldValues = new String[]{"James Bond", "London", "Classified"};

 MailMergerContext mailMergerContext = new MailMergerContext();
 mailMergerContext.setSimpleDataSource(fieldNames, fieldValues);
 mailMergerContext.getMailMergeOptions().setTrimWhitespaces(true);

 MailMerger.create(mailMergerContext)
         .from(doc)
         .to(getArtifactsDir() + "LowCode.MailMergeContext.docx")
         .execute();
 
 

Shows how to do mail merge operation from a DataTable using context.

 
 // There is a several ways to do mail merge operation from a DataTable:
 String doc = getMyDir() + "Mail merge.doc";

 DataTable dataTable = new DataTable();
 dataTable.getColumns().add("FirstName");
 dataTable.getColumns().add("Location");
 dataTable.getColumns().add("SpecialCharsInName()");

 dataTable.getRows().add(new String[]{"James Bond", "London", "Classified"});

 MailMergerContext mailMergerContext = new MailMergerContext();
 mailMergerContext.setSimpleDataSource(dataTable);
 mailMergerContext.getMailMergeOptions().setTrimWhitespaces(true);

 MailMerger.create(mailMergerContext)
         .from(doc)
         .to(getArtifactsDir() + "LowCode.MailMergeContextDataTable.docx")
         .execute();
 
 

Shows how to do mail merge operation from a DataRow using context.

 
 // There is a several ways to do mail merge operation from a DataRow:
 String doc = getMyDir() + "Mail merge.doc";

 DataTable dataTable = new DataTable();
 dataTable.getColumns().add("FirstName");
 dataTable.getColumns().add("Location");
 dataTable.getColumns().add("SpecialCharsInName()");

 dataTable.getRows().add(new String[]{"James Bond", "London", "Classified"});
 DataRow dataRow = dataTable.getRows().get(0);

 MailMergerContext mailMergerContext = new MailMergerContext();
 mailMergerContext.setSimpleDataSource(dataRow);
 mailMergerContext.getMailMergeOptions().setTrimWhitespaces(true);

 MailMerger.create(mailMergerContext)
         .from(doc)
         .to(getArtifactsDir() + "LowCode.MailMergeContextDataRow.docx")
         .execute();
 
 

Shows how to do mail merge with regions operation from a DataTable using context.

 
 // There is a several ways to do mail merge with regions operation from a DataTable:
 String doc = getMyDir() + "Mail merge with regions.docx";

 DataTable dataTable = new DataTable("MyTable");
 dataTable.getColumns().add("FirstName");
 dataTable.getColumns().add("LastName");
 dataTable.getRows().add(new Object[]{"John", "Doe"});
 dataTable.getRows().add(new Object[]{"", ""});
 dataTable.getRows().add(new Object[]{"Jane", "Doe"});

 MailMergerContext mailMergerContext = new MailMergerContext();
 mailMergerContext.setRegionsDataSource(dataTable);
 mailMergerContext.getMailMergeOptions().setTrimWhitespaces(true);

 MailMerger.create(mailMergerContext)
         .from(doc)
         .to(getArtifactsDir() + "LowCode.MailMergeContextWithRegionsDataTable.docx")
         .execute();
 
 

Shows how to do mail merge operation for a single record from the stream using context.

 
 // There is a several ways to do mail merge operation using documents from the stream:
 String[] fieldNames = new String[]{"FirstName", "Location", "SpecialCharsInName()"};
 String[] fieldValues = new String[]{"James Bond", "London", "Classified"};

 try (FileInputStream streamIn = new FileInputStream(getMyDir() + "Mail merge.doc")) {
     MailMergerContext mailMergerContext = new MailMergerContext();
     mailMergerContext.setSimpleDataSource(fieldNames, fieldValues);
     mailMergerContext.getMailMergeOptions().setTrimWhitespaces(true);

     try (FileOutputStream streamOut = new FileOutputStream(getArtifactsDir() + "LowCode.MailMergeContextStream.docx")) {
         MailMerger.create(mailMergerContext)
                 .from(streamIn)
                 .to(streamOut, SaveFormat.DOCX)
                 .execute();
     }
 }
 
 

Shows how to do mail merge operation from a DataTable using documents from the stream using context.

 
 // There is a several ways to do mail merge operation from a DataTable using documents from the stream:
 DataTable dataTable = new DataTable();
 dataTable.getColumns().add("FirstName");
 dataTable.getColumns().add("Location");
 dataTable.getColumns().add("SpecialCharsInName()");

 dataTable.getRows().add(new String[]{"James Bond", "London", "Classified"});

 try (FileInputStream streamIn = new FileInputStream(getMyDir() + "Mail merge.doc")) {
     MailMergerContext mailMergerContext = new MailMergerContext();
     mailMergerContext.setSimpleDataSource(dataTable);
     mailMergerContext.getMailMergeOptions().setTrimWhitespaces(true);

     try (FileOutputStream streamOut = new FileOutputStream(getArtifactsDir() + "LowCode.MailMergeContextStreamDataTable.docx")) {
         MailMerger.create(mailMergerContext)
                 .from(streamIn)
                 .to(streamOut, SaveFormat.DOCX)
                 .execute();
     }
 }
 
 

Shows how to do mail merge operation from a DataRow using documents from the stream using context.

 
 // There is a several ways to do mail merge operation from a DataRow using documents from the stream:
 DataTable dataTable = new DataTable();
 dataTable.getColumns().add("FirstName");
 dataTable.getColumns().add("Location");
 dataTable.getColumns().add("SpecialCharsInName()");

 dataTable.getRows().add(new String[]{"James Bond", "London", "Classified"});
 DataRow dataRow = dataTable.getRows().get(0);

 try (FileInputStream streamIn = new FileInputStream(getMyDir() + "Mail merge.doc")) {
     MailMergerContext mailMergerContext = new MailMergerContext();
     mailMergerContext.setSimpleDataSource(dataRow);
     mailMergerContext.getMailMergeOptions().setTrimWhitespaces(true);

     try (FileOutputStream streamOut = new FileOutputStream(getArtifactsDir() + "LowCode.MailMergeContextStreamDataRow.docx")) {
         MailMerger.create(mailMergerContext)
                 .from(streamIn)
                 .to(streamOut, SaveFormat.DOCX)
                 .execute();
     }
 }
 
 

Shows how to do mail merge with regions operation from a DataTable using documents from the stream using context.

 
 // There is a several ways to do mail merge with regions operation from a DataTable using documents from the stream:
 DataTable dataTable = new DataTable("MyTable");
 dataTable.getColumns().add("FirstName");
 dataTable.getColumns().add("LastName");
 dataTable.getRows().add(new Object[]{"John", "Doe"});
 dataTable.getRows().add(new Object[]{"", ""});
 dataTable.getRows().add(new Object[]{"Jane", "Doe"});

 try (FileInputStream streamIn = new FileInputStream(getMyDir() + "Mail merge.doc")) {
     MailMergerContext mailMergerContext = new MailMergerContext();
     mailMergerContext.setRegionsDataSource(dataTable);
     mailMergerContext.getMailMergeOptions().setTrimWhitespaces(true);

     try (FileOutputStream streamOut = new FileOutputStream(getArtifactsDir() + "LowCode.MailMergeContextStreamWithRegionsDataTable.docx")) {
         MailMerger.create(mailMergerContext)
                 .from(streamIn)
                 .to(streamOut, SaveFormat.DOCX)
                 .execute();
     }
 }
 
 

Shows how to do mail merge with regions operation from a DataSet using context.

 
 // There is a several ways to do mail merge with regions operation from a DataSet:
 String doc = getMyDir() + "Mail merge with regions data set.docx";

 DataTable tableCustomers = new DataTable("Customers");
 tableCustomers.getColumns().add("CustomerID");
 tableCustomers.getColumns().add("CustomerName");
 tableCustomers.getRows().add(new Object[]{1, "John Doe"});
 tableCustomers.getRows().add(new Object[]{2, "Jane Doe"});

 DataTable tableOrders = new DataTable("Orders");
 tableOrders.getColumns().add("CustomerID");
 tableOrders.getColumns().add("ItemName");
 tableOrders.getColumns().add("Quantity");
 tableOrders.getRows().add(new Object[]{1, "Hawaiian", 2});
 tableOrders.getRows().add(new Object[]{2, "Pepperoni", 1});
 tableOrders.getRows().add(new Object[]{2, "Chicago", 1});

 DataSet dataSet = new DataSet();
 dataSet.getTables().add(tableCustomers);
 dataSet.getTables().add(tableOrders);
 dataSet.getRelations().add(tableCustomers.getColumns().get("CustomerID"), tableOrders.getColumns().get("CustomerID"));

 MailMergerContext mailMergerContext = new MailMergerContext();
 mailMergerContext.setRegionsDataSource(dataSet);
 mailMergerContext.getMailMergeOptions().setTrimWhitespaces(true);

 MailMerger.create(mailMergerContext)
         .from(doc)
         .to(getArtifactsDir() + "LowCode.MailMergeContextWithRegionsDataTable.docx")
         .execute();
 
 

Shows how to do mail merge with regions operation from a DataSet using documents from the stream using context.

 
 // There is a several ways to do mail merge with regions operation from a DataSet using documents from the stream:
 DataTable tableCustomers = new DataTable("Customers");
 tableCustomers.getColumns().add("CustomerID");
 tableCustomers.getColumns().add("CustomerName");
 tableCustomers.getRows().add(new Object[]{1, "John Doe"});
 tableCustomers.getRows().add(new Object[]{2, "Jane Doe"});

 DataTable tableOrders = new DataTable("Orders");
 tableOrders.getColumns().add("CustomerID");
 tableOrders.getColumns().add("ItemName");
 tableOrders.getColumns().add("Quantity");
 tableOrders.getRows().add(new Object[]{1, "Hawaiian", 2});
 tableOrders.getRows().add(new Object[]{2, "Pepperoni", 1});
 tableOrders.getRows().add(new Object[]{2, "Chicago", 1});

 DataSet dataSet = new DataSet();
 dataSet.getTables().add(tableCustomers);
 dataSet.getTables().add(tableOrders);
 dataSet.getRelations().add(tableCustomers.getColumns().get("CustomerID"), tableOrders.getColumns().get("CustomerID"));

 try (FileInputStream streamIn = new FileInputStream(getMyDir() + "Mail merge.doc")) {
     MailMergerContext mailMergerContext = new MailMergerContext();
     mailMergerContext.setRegionsDataSource(dataSet);
     mailMergerContext.getMailMergeOptions().setTrimWhitespaces(true);

     try (FileOutputStream streamOut = new FileOutputStream(getArtifactsDir() + "LowCode.MailMergeContextStreamWithRegionsDataSet.docx")) {
         MailMerger.create(mailMergerContext)
                 .from(streamIn)
                 .to(streamOut, SaveFormat.DOCX)
                 .execute();
     }
 }
 
 

executeCore

protected void executeCore()
                    throws java.lang.Exception

Overrides:

executeCore in class Processor

Throws:

java.lang.Exception

execute

public static void execute(java.lang.String inputFileName,
                           java.lang.String outputFileName,
                           java.lang.String[] fieldNames,
                           java.lang.Object[] fieldValues)
                    throws java.lang.Exception

Performs a mail merge operation for a single record.

Remarks:

If the output format is an image (BMP, EMF, EPS, GIF, JPEG, PNG, or WebP), each page of the output will be saved as a separate file. The specified output file name will be used to generate file names for each part following the rule: outputFile_partIndex.extension.

If the output format is TIFF, the output will be saved as a single multi-frame TIFF file.

Examples:

Shows how to do mail merge operation for a single record.

 
 // There is a several ways to do mail merge operation:
 String doc = getMyDir() + "Mail merge.doc";

 String[] fieldNames = new String[]{"FirstName", "Location", "SpecialCharsInName()"};
 String[] fieldValues = new String[]{"James Bond", "London", "Classified"};

 MailMerger.execute(doc, getArtifactsDir() + "LowCode.MailMerge.1.docx", fieldNames, fieldValues);
 MailMerger.execute(doc, getArtifactsDir() + "LowCode.MailMerge.2.docx", SaveFormat.DOCX, fieldNames, fieldValues);
 MailMergeOptions options = new MailMergeOptions();
 options.setTrimWhitespaces(true);
 MailMerger.execute(doc, getArtifactsDir() + "LowCode.MailMerge.3.docx", SaveFormat.DOCX, fieldNames, fieldValues, options);
 
 

Parameters:

inputFileName - The input file name.

outputFileName - The output file name.

fieldNames - Array of merge field names. Field names are not case sensitive. If a field name that is not found in the document is encountered, it is ignored.

fieldValues - Array of values to be inserted into the merge fields. Number of elements in this array must be the same as the number of elements in fieldNames.

Throws:

java.lang.Exception

execute

public static void execute(java.lang.String inputFileName,
                           java.lang.String outputFileName,
                           int saveFormat,
                           java.lang.String[] fieldNames,
                           java.lang.Object[] fieldValues)
                    throws java.lang.Exception

Throws:

java.lang.Exception

execute

public static void execute(java.lang.String inputFileName,
                           java.lang.String outputFileName,
                           int saveFormat,
                           java.lang.String[] fieldNames,
                           java.lang.Object[] fieldValues,
                           MailMergeOptions mailMergeOptions)
                    throws java.lang.Exception

Throws:

java.lang.Exception

execute

public static void execute(java.lang.String inputFileName,
                           java.lang.String outputFileName,
                           SaveOptions saveOptions,
                           java.lang.String[] fieldNames,
                           java.lang.Object[] fieldValues)
                    throws java.lang.Exception

Throws:

java.lang.Exception

execute

public static void execute(java.lang.String inputFileName,
                           java.lang.String outputFileName,
                           SaveOptions saveOptions,
                           java.lang.String[] fieldNames,
                           java.lang.Object[] fieldValues,
                           MailMergeOptions mailMergeOptions)
                    throws java.lang.Exception

Performs a mail merge operation for a single record.

Remarks:

If the output format is an image (BMP, EMF, EPS, GIF, JPEG, PNG, or WebP), each page of the output will be saved as a separate file. The specified output file name will be used to generate file names for each part following the rule: outputFile_partIndex.extension.

If the output format is TIFF, the output will be saved as a single multi-frame TIFF file.

Parameters:

inputFileName - The input file name.

outputFileName - The output file name.

saveOptions - The output's save options.

fieldNames - Array of merge field names. Field names are not case sensitive. If a field name that is not found in the document is encountered, it is ignored.

fieldValues - Array of values to be inserted into the merge fields. Number of elements in this array must be the same as the number of elements in fieldNames.

mailMergeOptions - Mail merge options.

Throws:

java.lang.Exception

execute

public static void execute(java.io.InputStream inputStream,
                           java.io.OutputStream outputStream,
                           int saveFormat,
                           java.lang.String[] fieldNames,
                           java.lang.Object[] fieldValues)
                    throws java.lang.Exception

Throws:

java.lang.Exception

execute

public static void execute(java.io.InputStream inputStream,
                           java.io.OutputStream outputStream,
                           int saveFormat,
                           java.lang.String[] fieldNames,
                           java.lang.Object[] fieldValues,
                           MailMergeOptions mailMergeOptions)
                    throws java.lang.Exception

Throws:

java.lang.Exception

execute

public static void execute(java.io.InputStream inputStream,
                           java.io.OutputStream outputStream,
                           SaveOptions saveOptions,
                           java.lang.String[] fieldNames,
                           java.lang.Object[] fieldValues)
                    throws java.lang.Exception

Throws:

java.lang.Exception

execute

public static void execute(java.io.InputStream inputStream,
                           java.io.OutputStream outputStream,
                           SaveOptions saveOptions,
                           java.lang.String[] fieldNames,
                           java.lang.Object[] fieldValues,
                           MailMergeOptions mailMergeOptions)
                    throws java.lang.Exception

Throws:

java.lang.Exception

execute

public static void execute(java.lang.String inputFileName,
                           java.lang.String outputFileName,
                           DataRow dataRow)
                    throws java.lang.Exception

Performs mail merge from a DataRow into the document.

Remarks:

If the output format is an image (BMP, EMF, EPS, GIF, JPEG, PNG, or WebP), each page of the output will be saved as a separate file. The specified output file name will be used to generate file names for each part following the rule: outputFile_partIndex.extension.

If the output format is TIFF, the output will be saved as a single multi-frame TIFF file.

Examples:

Shows how to do mail merge operation from a DataRow.

 
 // There is a several ways to do mail merge operation from a DataRow:
 String doc = getMyDir() + "Mail merge.doc";

 DataTable dataTable = new DataTable();
 dataTable.getColumns().add("FirstName");
 dataTable.getColumns().add("Location");
 dataTable.getColumns().add("SpecialCharsInName()");

 dataTable.getRows().add(new String[]{"James Bond", "London", "Classified"});
 DataRow dataRow = dataTable.getRows().get(0);

 MailMerger.execute(doc, getArtifactsDir() + "LowCode.MailMergeDataRow.1.docx", dataRow);
 MailMerger.execute(doc, getArtifactsDir() + "LowCode.MailMergeDataRow.2.docx", SaveFormat.DOCX, dataRow);
 MailMergeOptions options = new MailMergeOptions();
 options.setTrimWhitespaces(true);
 MailMerger.execute(doc, getArtifactsDir() + "LowCode.MailMergeDataRow.3.docx", SaveFormat.DOCX, dataRow, options);
 
 

Parameters:

inputFileName - The input file name.

outputFileName - The output file name.

dataRow - Row that contains data to be inserted into mail merge fields. Field names are not case sensitive. If a field name that is not found in the document is encountered, it is ignored.

Throws:

java.lang.Exception

execute

public static void execute(java.lang.String inputFileName,
                           java.lang.String outputFileName,
                           int saveFormat,
                           DataRow dataRow)
                    throws java.lang.Exception

Throws:

java.lang.Exception

execute

public static void execute(java.lang.String inputFileName,
                           java.lang.String outputFileName,
                           int saveFormat,
                           DataRow dataRow,
                           MailMergeOptions mailMergeOptions)
                    throws java.lang.Exception

Throws:

java.lang.Exception

execute

public static void execute(java.lang.String inputFileName,
                           java.lang.String outputFileName,
                           SaveOptions saveOptions,
                           DataRow dataRow)
                    throws java.lang.Exception

Throws:

java.lang.Exception

execute

public static void execute(java.lang.String inputFileName,
                           java.lang.String outputFileName,
                           SaveOptions saveOptions,
                           DataRow dataRow,
                           MailMergeOptions mailMergeOptions)
                    throws java.lang.Exception

Performs mail merge from a DataRow into the document.

Remarks:

If the output format is an image (BMP, EMF, EPS, GIF, JPEG, PNG, or WebP), each page of the output will be saved as a separate file. The specified output file name will be used to generate file names for each part following the rule: outputFile_partIndex.extension.

If the output format is TIFF, the output will be saved as a single multi-frame TIFF file.

Parameters:

inputFileName - The input file name.

outputFileName - The output file name.

saveOptions - The output's save options.

dataRow - Row that contains data to be inserted into mail merge fields. Field names are not case sensitive. If a field name that is not found in the document is encountered, it is ignored.

mailMergeOptions - Mail merge options.

Throws:

java.lang.Exception

execute

public static void execute(java.io.InputStream inputStream,
                           java.io.OutputStream outputStream,
                           int saveFormat,
                           DataRow dataRow)
                    throws java.lang.Exception

Throws:

java.lang.Exception

execute

public static void execute(java.io.InputStream inputStream,
                           java.io.OutputStream outputStream,
                           int saveFormat,
                           DataRow dataRow,
                           MailMergeOptions mailMergeOptions)
                    throws java.lang.Exception

Throws:

java.lang.Exception

execute

public static void execute(java.io.InputStream inputStream,
                           java.io.OutputStream outputStream,
                           SaveOptions saveOptions,
                           DataRow dataRow)
                    throws java.lang.Exception

Throws:

java.lang.Exception

execute

public static void execute(java.io.InputStream inputStream,
                           java.io.OutputStream outputStream,
                           SaveOptions saveOptions,
                           DataRow dataRow,
                           MailMergeOptions mailMergeOptions)
                    throws java.lang.Exception

Throws:

java.lang.Exception

execute

public static void execute(java.lang.String inputFileName,
                           java.lang.String outputFileName,
                           DataTable dataTable)
                    throws java.lang.Exception

Performs mail merge from a DataTable into the document.

Remarks:

If the output format is an image (BMP, EMF, EPS, GIF, JPEG, PNG, or WebP), each page of the output will be saved as a separate file. The specified output file name will be used to generate file names for each part following the rule: outputFile_partIndex.extension.

If the output format is TIFF, the output will be saved as a single multi-frame TIFF file.

Examples:

Shows how to do mail merge operation from a DataTable.

 
 // There is a several ways to do mail merge operation from a DataTable:
 String doc = getMyDir() + "Mail merge.doc";

 DataTable dataTable = new DataTable();
 dataTable.getColumns().add("FirstName");
 dataTable.getColumns().add("Location");
 dataTable.getColumns().add("SpecialCharsInName()");

 dataTable.getRows().add(new String[]{"James Bond", "London", "Classified"});

 MailMerger.execute(doc, getArtifactsDir() + "LowCode.MailMergeDataTable.1.docx", dataTable);
 MailMerger.execute(doc, getArtifactsDir() + "LowCode.MailMergeDataTable.2.docx", SaveFormat.DOCX, dataTable);
 MailMergeOptions options = new MailMergeOptions();
 options.setTrimWhitespaces(true);
 MailMerger.execute(doc, getArtifactsDir() + "LowCode.MailMergeDataTable.3.docx", SaveFormat.DOCX, dataTable, options);
 
 

Parameters:

inputFileName - The input file name.

outputFileName - The output file name.

dataTable - Table that contains data to be inserted into mail merge fields. Field names are not case sensitive. If a field name that is not found in the document is encountered, it is ignored.

Throws:

java.lang.Exception

execute

public static void execute(java.lang.String inputFileName,
                           java.lang.String outputFileName,
                           int saveFormat,
                           DataTable dataTable)
                    throws java.lang.Exception

Throws:

java.lang.Exception

execute

public static void execute(java.lang.String inputFileName,
                           java.lang.String outputFileName,
                           int saveFormat,
                           DataTable dataTable,
                           MailMergeOptions mailMergeOptions)
                    throws java.lang.Exception

Throws:

java.lang.Exception

execute

public static void execute(java.lang.String inputFileName,
                           java.lang.String outputFileName,
                           SaveOptions saveOptions,
                           DataTable dataTable)
                    throws java.lang.Exception

Throws:

java.lang.Exception

execute

public static void execute(java.lang.String inputFileName,
                           java.lang.String outputFileName,
                           SaveOptions saveOptions,
                           DataTable dataTable,
                           MailMergeOptions mailMergeOptions)
                    throws java.lang.Exception

Performs mail merge from a DataRow into the document.

Remarks:

If the output format is an image (BMP, EMF, EPS, GIF, JPEG, PNG, or WebP), each page of the output will be saved as a separate file. The specified output file name will be used to generate file names for each part following the rule: outputFile_partIndex.extension.

If the output format is TIFF, the output will be saved as a single multi-frame TIFF file.

Parameters:

inputFileName - The input file name.

outputFileName - The output file name.

saveOptions - The output's save options.

dataTable - Table that contains data to be inserted into mail merge fields. Field names are not case sensitive. If a field name that is not found in the document is encountered, it is ignored.

mailMergeOptions - Mail merge options.

Throws:

java.lang.Exception

execute

public static void execute(java.io.InputStream inputStream,
                           java.io.OutputStream outputStream,
                           int saveFormat,
                           DataTable dataTable)
                    throws java.lang.Exception

Throws:

java.lang.Exception

execute

public static void execute(java.io.InputStream inputStream,
                           java.io.OutputStream outputStream,
                           int saveFormat,
                           DataTable dataTable,
                           MailMergeOptions mailMergeOptions)
                    throws java.lang.Exception

Throws:

java.lang.Exception

execute

public static void execute(java.io.InputStream inputStream,
                           java.io.OutputStream outputStream,
                           SaveOptions saveOptions,
                           DataTable dataTable)
                    throws java.lang.Exception

Throws:

java.lang.Exception

execute

public static void execute(java.io.InputStream inputStream,
                           java.io.OutputStream outputStream,
                           SaveOptions saveOptions,
                           DataTable dataTable,
                           MailMergeOptions mailMergeOptions)
                    throws java.lang.Exception

Throws:

java.lang.Exception

executeWithRegions

public static void executeWithRegions(java.lang.String inputFileName,
                                      java.lang.String outputFileName,
                                      DataTable dataTable)
                               throws java.lang.Exception

Performs mail merge from a DataTable into the document with mail merge regions.

Remarks:

If the output format is an image (BMP, EMF, EPS, GIF, JPEG, PNG, or WebP), each page of the output will be saved as a separate file. The specified output file name will be used to generate file names for each part following the rule: outputFile_partIndex.extension.

If the output format is TIFF, the output will be saved as a single multi-frame TIFF file.

Examples:

Shows how to do mail merge with regions operation from a DataTable.

 
 // There is a several ways to do mail merge with regions operation from a DataTable:
 String doc = getMyDir() + "Mail merge with regions.docx";

 DataTable dataTable = new DataTable("MyTable");
 dataTable.getColumns().add("FirstName");
 dataTable.getColumns().add("LastName");
 dataTable.getRows().add(new Object[]{"John", "Doe"});
 dataTable.getRows().add(new Object[]{"", ""});
 dataTable.getRows().add(new Object[]{"Jane", "Doe"});

 MailMerger.executeWithRegions(doc, getArtifactsDir() + "LowCode.MailMergeWithRegionsDataTable.1.docx", dataTable);
 MailMerger.executeWithRegions(doc, getArtifactsDir() + "LowCode.MailMergeWithRegionsDataTable.2.docx", SaveFormat.DOCX, dataTable);
 MailMergeOptions options = new MailMergeOptions();
 options.setTrimWhitespaces(true);
 MailMerger.executeWithRegions(doc, getArtifactsDir() + "LowCode.MailMergeWithRegionsDataTable.3.docx", SaveFormat.DOCX, dataTable, options);
 
 

Parameters:

inputFileName - The input file name.

outputFileName - The output file name.

dataTable - Data source for the mail merge operation. The table must have its TableName property set.

Throws:

java.lang.Exception

executeWithRegions

public static void executeWithRegions(java.lang.String inputFileName,
                                      java.lang.String outputFileName,
                                      int saveFormat,
                                      DataTable dataTable)
                               throws java.lang.Exception

Throws:

java.lang.Exception

executeWithRegions

public static void executeWithRegions(java.lang.String inputFileName,
                                      java.lang.String outputFileName,
                                      int saveFormat,
                                      DataTable dataTable,
                                      MailMergeOptions mailMergeOptions)
                               throws java.lang.Exception

Throws:

java.lang.Exception

executeWithRegions

public static void executeWithRegions(java.lang.String inputFileName,
                                      java.lang.String outputFileName,
                                      SaveOptions saveOptions,
                                      DataTable dataTable)
                               throws java.lang.Exception

Throws:

java.lang.Exception

executeWithRegions

public static void executeWithRegions(java.lang.String inputFileName,
                                      java.lang.String outputFileName,
                                      SaveOptions saveOptions,
                                      DataTable dataTable,
                                      MailMergeOptions mailMergeOptions)
                               throws java.lang.Exception

Performs mail merge from a DataTable into the document with mail merge regions.

Remarks:

If the output format is an image (BMP, EMF, EPS, GIF, JPEG, PNG, or WebP), each page of the output will be saved as a separate file. The specified output file name will be used to generate file names for each part following the rule: outputFile_partIndex.extension.

If the output format is TIFF, the output will be saved as a single multi-frame TIFF file.

Parameters:

inputFileName - The input file name.

outputFileName - The output file name.

saveOptions - The output's save options.

dataTable - Table that contains data to be inserted into mail merge fields. Field names are not case sensitive. If a field name that is not found in the document is encountered, it is ignored.

mailMergeOptions - Mail merge options.

Throws:

java.lang.Exception

executeWithRegions

public static void executeWithRegions(java.io.InputStream inputStream,
                                      java.io.OutputStream outputStream,
                                      int saveFormat,
                                      DataTable dataTable)
                               throws java.lang.Exception

Throws:

java.lang.Exception

executeWithRegions

public static void executeWithRegions(java.io.InputStream inputStream,
                                      java.io.OutputStream outputStream,
                                      int saveFormat,
                                      DataTable dataTable,
                                      MailMergeOptions mailMergeOptions)
                               throws java.lang.Exception

Throws:

java.lang.Exception

executeWithRegions

public static void executeWithRegions(java.io.InputStream inputStream,
                                      java.io.OutputStream outputStream,
                                      SaveOptions saveOptions,
                                      DataTable dataTable)
                               throws java.lang.Exception

Throws:

java.lang.Exception

executeWithRegions

public static void executeWithRegions(java.io.InputStream inputStream,
                                      java.io.OutputStream outputStream,
                                      SaveOptions saveOptions,
                                      DataTable dataTable,
                                      MailMergeOptions mailMergeOptions)
                               throws java.lang.Exception

Throws:

java.lang.Exception

executeWithRegions

public static void executeWithRegions(java.lang.String inputFileName,
                                      java.lang.String outputFileName,
                                      DataSet dataSet)
                               throws java.lang.Exception

Performs mail merge from a DataSet into a document with mail merge regions.

Remarks:

If the output format is an image (BMP, EMF, EPS, GIF, JPEG, PNG, or WebP), each page of the output will be saved as a separate file. The specified output file name will be used to generate file names for each part following the rule: outputFile_partIndex.extension.

If the output format is TIFF, the output will be saved as a single multi-frame TIFF file.

Examples:

Shows how to do mail merge with regions operation from a DataSet.

 
 // There is a several ways to do mail merge with regions operation from a DataSet:
 String doc = getMyDir() + "Mail merge with regions data set.docx";

 DataTable tableCustomers = new DataTable("Customers");
 tableCustomers.getColumns().add("CustomerID");
 tableCustomers.getColumns().add("CustomerName");
 tableCustomers.getRows().add(new Object[]{1, "John Doe"});
 tableCustomers.getRows().add(new Object[]{2, "Jane Doe"});

 DataTable tableOrders = new DataTable("Orders");
 tableOrders.getColumns().add("CustomerID");
 tableOrders.getColumns().add("ItemName");
 tableOrders.getColumns().add("Quantity");
 tableOrders.getRows().add(new Object[]{1, "Hawaiian", 2});
 tableOrders.getRows().add(new Object[]{2, "Pepperoni", 1});
 tableOrders.getRows().add(new Object[]{2, "Chicago", 1});

 DataSet dataSet = new DataSet();
 dataSet.getTables().add(tableCustomers);
 dataSet.getTables().add(tableOrders);
 dataSet.getRelations().add(tableCustomers.getColumns().get("CustomerID"), tableOrders.getColumns().get("CustomerID"));

 MailMerger.executeWithRegions(doc, getArtifactsDir() + "LowCode.MailMergeWithRegionsDataSet.1.docx", dataSet);
 MailMerger.executeWithRegions(doc, getArtifactsDir() + "LowCode.MailMergeWithRegionsDataSet.2.docx", SaveFormat.DOCX, dataSet);
 MailMergeOptions options = new MailMergeOptions();
 options.setTrimWhitespaces(true);
 MailMerger.executeWithRegions(doc, getArtifactsDir() + "LowCode.MailMergeWithRegionsDataSet.3.docx", SaveFormat.DOCX, dataSet, options);
 
 

Parameters:

inputFileName - The input file name.

outputFileName - The output file name.

dataSet - DataSet that contains data to be inserted into mail merge fields.

Throws:

java.lang.Exception

executeWithRegions

public static void executeWithRegions(java.lang.String inputFileName,
                                      java.lang.String outputFileName,
                                      int saveFormat,
                                      DataSet dataSet)
                               throws java.lang.Exception

Throws:

java.lang.Exception

executeWithRegions

public static void executeWithRegions(java.lang.String inputFileName,
                                      java.lang.String outputFileName,
                                      int saveFormat,
                                      DataSet dataSet,
                                      MailMergeOptions mailMergeOptions)
                               throws java.lang.Exception

Throws:

java.lang.Exception

executeWithRegions

public static void executeWithRegions(java.lang.String inputFileName,
                                      java.lang.String outputFileName,
                                      SaveOptions saveOptions,
                                      DataSet dataSet)
                               throws java.lang.Exception

Throws:

java.lang.Exception

executeWithRegions

public static void executeWithRegions(java.lang.String inputFileName,
                                      java.lang.String outputFileName,
                                      SaveOptions saveOptions,
                                      DataSet dataSet,
                                      MailMergeOptions mailMergeOptions)
                               throws java.lang.Exception

Performs mail merge from a DataSet into the document with mail merge regions.

Remarks:

If the output format is an image (BMP, EMF, EPS, GIF, JPEG, PNG, or WebP), each page of the output will be saved as a separate file. The specified output file name will be used to generate file names for each part following the rule: outputFile_partIndex.extension.

If the output format is TIFF, the output will be saved as a single multi-frame TIFF file.

Parameters:

inputFileName - The input file name.

outputFileName - The output file name.

saveOptions - The output's save options.

dataSet - DataSet that contains data to be inserted into mail merge fields.

mailMergeOptions - Mail merge options.

Throws:

java.lang.Exception

executeWithRegions

public static void executeWithRegions(java.io.InputStream inputStream,
                                      java.io.OutputStream outputStream,
                                      int saveFormat,
                                      DataSet dataSet)
                               throws java.lang.Exception

Throws:

java.lang.Exception

executeWithRegions

public static void executeWithRegions(java.io.InputStream inputStream,
                                      java.io.OutputStream outputStream,
                                      int saveFormat,
                                      DataSet dataSet,
                                      MailMergeOptions mailMergeOptions)
                               throws java.lang.Exception

Throws:

java.lang.Exception

executeWithRegions

public static void executeWithRegions(java.io.InputStream inputStream,
                                      java.io.OutputStream outputStream,
                                      SaveOptions saveOptions,
                                      DataSet dataSet)
                               throws java.lang.Exception

Throws:

java.lang.Exception

executeWithRegions

public static void executeWithRegions(java.io.InputStream inputStream,
                                      java.io.OutputStream outputStream,
                                      SaveOptions saveOptions,
                                      DataSet dataSet,
                                      MailMergeOptions mailMergeOptions)
                               throws java.lang.Exception

Throws:

java.lang.Exception

executeToImages

public static java.io.OutputStream[] executeToImages(java.lang.String inputFileName,
                                                     ImageSaveOptions saveOptions,
                                                     java.lang.String[] fieldNames,
                                                     java.lang.Object[] fieldValues)
                                              throws java.lang.Exception

Throws:

java.lang.Exception

executeToImages

public static java.io.OutputStream[] executeToImages(java.lang.String inputFileName,
                                                     ImageSaveOptions saveOptions,
                                                     java.lang.String[] fieldNames,
                                                     java.lang.Object[] fieldValues,
                                                     MailMergeOptions mailMergeOptions)
                                              throws java.lang.Exception

Performs a mail merge operation for a single record and renders the result to images.

Examples:

Shows how to do mail merge operation for a single record and save result to images.

 
 // There is a several ways to do mail merge operation:
 String doc = getMyDir() + "Mail merge.doc";

 String[] fieldNames = new String[]{"FirstName", "Location", "SpecialCharsInName()"};
 String[] fieldValues = new String[]{"James Bond", "London", "Classified"};

 OutputStream[] images = MailMerger.executeToImages(doc, new ImageSaveOptions(SaveFormat.PNG), fieldNames, fieldValues);
 MailMergeOptions mailMergeOptions = new MailMergeOptions();
 mailMergeOptions.setTrimWhitespaces(true);
 images = MailMerger.executeToImages(doc, new ImageSaveOptions(SaveFormat.PNG), fieldNames, fieldValues, mailMergeOptions);
 
 

Parameters:

inputFileName - The input file name.

saveOptions - The output's save options.

fieldNames - Array of merge field names. Field names are not case sensitive. If a field name that is not found in the document is encountered, it is ignored.

fieldValues - Array of values to be inserted into the merge fields. Number of elements in this array must be the same as the number of elements in fieldNames.

mailMergeOptions - Mail merge options.

Throws:

java.lang.Exception

executeToImages

public static java.io.OutputStream[] executeToImages(java.io.InputStream inputStream,
                                                     ImageSaveOptions saveOptions,
                                                     java.lang.String[] fieldNames,
                                                     java.lang.Object[] fieldValues)
                                              throws java.lang.Exception

Throws:

java.lang.Exception

executeToImages

public static java.io.OutputStream[] executeToImages(java.io.InputStream inputStream,
                                                     ImageSaveOptions saveOptions,
                                                     java.lang.String[] fieldNames,
                                                     java.lang.Object[] fieldValues,
                                                     MailMergeOptions mailMergeOptions)
                                              throws java.lang.Exception

Performs a mail merge operation for a single record and renders the result to images.

Examples:

Shows how to do mail merge operation for a single record from the stream and save result to images.

 
 // There is a several ways to do mail merge operation using documents from the stream:
 String[] fieldNames = new String[]{"FirstName", "Location", "SpecialCharsInName()"};
 String[] fieldValues = new String[]{"James Bond", "London", "Classified"};

 try (FileInputStream streamIn = new FileInputStream(getMyDir() + "Mail merge.doc")) {
     OutputStream[] images = MailMerger.executeToImages(streamIn, new ImageSaveOptions(SaveFormat.PNG), fieldNames, fieldValues);

     MailMergeOptions mailMergeOptions = new MailMergeOptions();
     mailMergeOptions.setTrimWhitespaces(true);
     images = MailMerger.executeToImages(streamIn, new ImageSaveOptions(SaveFormat.PNG), fieldNames, fieldValues, mailMergeOptions);
 }
 
 

Parameters:

inputStream - The input file stream.

saveOptions - The output's save options.

fieldNames - Array of merge field names. Field names are not case sensitive. If a field name that is not found in the document is encountered, it is ignored.

fieldValues - Array of values to be inserted into the merge fields. Number of elements in this array must be the same as the number of elements in fieldNames.

mailMergeOptions - Mail merge options.

Throws:

java.lang.Exception

executeToImages

public static java.io.OutputStream[] executeToImages(java.lang.String inputFileName,
                                                     ImageSaveOptions saveOptions,
                                                     DataRow dataRow)
                                              throws java.lang.Exception

Throws:

java.lang.Exception

executeToImages

public static java.io.OutputStream[] executeToImages(java.lang.String inputFileName,
                                                     ImageSaveOptions saveOptions,
                                                     DataRow dataRow,
                                                     MailMergeOptions mailMergeOptions)
                                              throws java.lang.Exception

Performs mail merge from a DataRow into the document and renders the result to images.

Examples:

Shows how to do mail merge operation from a DataRow and save result to images.

 
 // There is a several ways to do mail merge operation from a DataRow:
 String doc = getMyDir() + "Mail merge.doc";

 DataTable dataTable = new DataTable();
 dataTable.getColumns().add("FirstName");
 dataTable.getColumns().add("Location");
 dataTable.getColumns().add("SpecialCharsInName()");

 dataTable.getRows().add(new String[]{"James Bond", "London", "Classified"});
 DataRow dataRow = dataTable.getRows().get(0);

 OutputStream[] images = MailMerger.executeToImages(doc, new ImageSaveOptions(SaveFormat.PNG), dataRow);
 MailMergeOptions options = new MailMergeOptions();
 options.setTrimWhitespaces(true);
 images = MailMerger.executeToImages(doc, new ImageSaveOptions(SaveFormat.PNG), dataRow, options);
 
 

Parameters:

inputFileName - The input file name.

saveOptions - The output's save options.

dataRow - Row that contains data to be inserted into mail merge fields. Field names are not case sensitive. If a field name that is not found in the document is encountered, it is ignored.

mailMergeOptions - Mail merge options.

Throws:

java.lang.Exception

executeToImages

public static java.io.OutputStream[] executeToImages(java.io.InputStream inputStream,
                                                     ImageSaveOptions saveOptions,
                                                     DataRow dataRow)
                                              throws java.lang.Exception

Throws:

java.lang.Exception

executeToImages

public static java.io.OutputStream[] executeToImages(java.io.InputStream inputStream,
                                                     ImageSaveOptions saveOptions,
                                                     DataRow dataRow,
                                                     MailMergeOptions mailMergeOptions)
                                              throws java.lang.Exception

Performs mail merge from a DataRow into the document and renders the result to images.

Examples:

Shows how to do mail merge operation from a DataRow using documents from the stream and save result to images.

 
 // There is a several ways to do mail merge operation from a DataRow using documents from the stream:
 DataTable dataTable = new DataTable();
 dataTable.getColumns().add("FirstName");
 dataTable.getColumns().add("Location");
 dataTable.getColumns().add("SpecialCharsInName()");

 dataTable.getRows().add(new String[]{"James Bond", "London", "Classified"});
 DataRow dataRow = dataTable.getRows().get(0);

 try (FileInputStream streamIn = new FileInputStream(getMyDir() + "Mail merge.doc")) {
     OutputStream[] images = MailMerger.executeToImages(streamIn, new ImageSaveOptions(SaveFormat.PNG), dataRow);
     MailMergeOptions options = new MailMergeOptions();
     options.setTrimWhitespaces(true);
     images = MailMerger.executeToImages(streamIn, new ImageSaveOptions(SaveFormat.PNG), dataRow, options);
 }
 
 

Parameters:

inputStream - The input file stream.

saveOptions - The output's save options.

dataRow - Row that contains data to be inserted into mail merge fields. Field names are not case sensitive. If a field name that is not found in the document is encountered, it is ignored.

mailMergeOptions - Mail merge options.

Throws:

java.lang.Exception

executeToImages

public static java.io.OutputStream[] executeToImages(java.lang.String inputFileName,
                                                     ImageSaveOptions saveOptions,
                                                     DataTable dataTable)
                                              throws java.lang.Exception

Throws:

java.lang.Exception

executeToImages

public static java.io.OutputStream[] executeToImages(java.lang.String inputFileName,
                                                     ImageSaveOptions saveOptions,
                                                     DataTable dataTable,
                                                     MailMergeOptions mailMergeOptions)
                                              throws java.lang.Exception

Performs mail merge from a DataRow into the document and renders the result to images.

Examples:

Shows how to do mail merge operation from a DataTable and save result to images.

 
 // There is a several ways to do mail merge operation from a DataTable:
 String doc = getMyDir() + "Mail merge.doc";

 DataTable dataTable = new DataTable();
 dataTable.getColumns().add("FirstName");
 dataTable.getColumns().add("Location");
 dataTable.getColumns().add("SpecialCharsInName()");

 dataTable.getRows().add(new String[]{"James Bond", "London", "Classified"});

 OutputStream[] images = MailMerger.executeToImages(doc, new ImageSaveOptions(SaveFormat.PNG), dataTable);
 MailMergeOptions options = new MailMergeOptions();
 options.setTrimWhitespaces(true);
 images = MailMerger.executeToImages(doc, new ImageSaveOptions(SaveFormat.PNG), dataTable, options);
 
 

Parameters:

inputFileName - The input file name.

saveOptions - The output's save options.

dataTable - Table that contains data to be inserted into mail merge fields. Field names are not case sensitive. If a field name that is not found in the document is encountered, it is ignored.

mailMergeOptions - Mail merge options.

Throws:

java.lang.Exception

executeToImages

public static java.io.OutputStream[] executeToImages(java.io.InputStream inputStream,
                                                     ImageSaveOptions saveOptions,
                                                     DataTable dataTable)
                                              throws java.lang.Exception

Throws:

java.lang.Exception

executeToImages

public static java.io.OutputStream[] executeToImages(java.io.InputStream inputStream,
                                                     ImageSaveOptions saveOptions,
                                                     DataTable dataTable,
                                                     MailMergeOptions mailMergeOptions)
                                              throws java.lang.Exception

Performs mail merge from a DataRow into the document and renders the result to images.

Examples:

Shows how to do mail merge operation from a DataTable using documents from the stream and save to images.

 
 // There is a several ways to do mail merge operation from a DataTable using documents from the stream and save result to images:
 DataTable dataTable = new DataTable();
 dataTable.getColumns().add("FirstName");
 dataTable.getColumns().add("Location");
 dataTable.getColumns().add("SpecialCharsInName()");

 dataTable.getRows().add(new String[]{"James Bond", "London", "Classified"});

 try (FileInputStream streamIn = new FileInputStream(getMyDir() + "Mail merge.doc")) {
     OutputStream[] images = MailMerger.executeToImages(streamIn, new ImageSaveOptions(SaveFormat.PNG), dataTable);
     MailMergeOptions options = new MailMergeOptions();
     options.setTrimWhitespaces(true);
     images = MailMerger.executeToImages(streamIn, new ImageSaveOptions(SaveFormat.PNG), dataTable, options);
 }
 
 

Parameters:

inputStream - The input file stream.

saveOptions - The output's save options.

dataTable - Table that contains data to be inserted into mail merge fields. Field names are not case sensitive. If a field name that is not found in the document is encountered, it is ignored.

mailMergeOptions - Mail merge options.

Throws:

java.lang.Exception

executeWithRegionsToImages

public static java.io.OutputStream[] executeWithRegionsToImages(java.lang.String inputFileName,
                                                                ImageSaveOptions saveOptions,
                                                                DataTable dataTable)
                                                         throws java.lang.Exception

Throws:

java.lang.Exception

executeWithRegionsToImages

public static java.io.OutputStream[] executeWithRegionsToImages(java.lang.String inputFileName,
                                                                ImageSaveOptions saveOptions,
                                                                DataTable dataTable,
                                                                MailMergeOptions mailMergeOptions)
                                                         throws java.lang.Exception

Performs mail merge from a DataTable into the document with mail merge regions and renders the result to images.

Examples:

Shows how to do mail merge with regions operation from a DataTable and save result to images.

 
 // There is a several ways to do mail merge with regions operation from a DataTable:
 String doc = getMyDir() + "Mail merge with regions.docx";

 DataTable dataTable = new DataTable("MyTable");
 dataTable.getColumns().add("FirstName");
 dataTable.getColumns().add("LastName");
 dataTable.getRows().add(new Object[]{"John", "Doe"});
 dataTable.getRows().add(new Object[]{"", ""});
 dataTable.getRows().add(new Object[]{"Jane", "Doe"});

 OutputStream[] images = MailMerger.executeWithRegionsToImages(doc, new ImageSaveOptions(SaveFormat.PNG), dataTable);
 MailMergeOptions options = new MailMergeOptions();
 options.setTrimWhitespaces(true);
 images = MailMerger.executeWithRegionsToImages(doc, new ImageSaveOptions(SaveFormat.PNG), dataTable, options);
 
 

Parameters:

inputFileName - The input file name.

saveOptions - The output's save options.

dataTable - Table that contains data to be inserted into mail merge fields. Field names are not case sensitive. If a field name that is not found in the document is encountered, it is ignored.

mailMergeOptions - Mail merge options.

Throws:

java.lang.Exception

executeWithRegionsToImages

public static java.io.OutputStream[] executeWithRegionsToImages(java.io.InputStream inputStream,
                                                                ImageSaveOptions saveOptions,
                                                                DataTable dataTable)
                                                         throws java.lang.Exception

Throws:

java.lang.Exception

executeWithRegionsToImages

public static java.io.OutputStream[] executeWithRegionsToImages(java.io.InputStream inputStream,
                                                                ImageSaveOptions saveOptions,
                                                                DataTable dataTable,
                                                                MailMergeOptions mailMergeOptions)
                                                         throws java.lang.Exception

Performs mail merge from a DataTable into the document with mail merge regions and renders the result to images.

Examples:

Shows how to do mail merge with regions operation from a DataTable using documents from the stream and save result to images.

 
 // There is a several ways to do mail merge with regions operation from a DataTable using documents from the stream:
 DataTable dataTable = new DataTable("MyTable");
 dataTable.getColumns().add("FirstName");
 dataTable.getColumns().add("LastName");
 dataTable.getRows().add(new Object[]{"John", "Doe"});
 dataTable.getRows().add(new Object[]{"", ""});
 dataTable.getRows().add(new Object[]{"Jane", "Doe"});

 try (FileInputStream streamIn = new FileInputStream(getMyDir() + "Mail merge.doc")) {
     OutputStream[] images = MailMerger.executeWithRegionsToImages(streamIn, new ImageSaveOptions(SaveFormat.PNG), dataTable);
     MailMergeOptions options = new MailMergeOptions();
     options.setTrimWhitespaces(true);
     images = MailMerger.executeWithRegionsToImages(streamIn, new ImageSaveOptions(SaveFormat.PNG), dataTable, options);
 }
 
 

Parameters:

inputStream - The input file stream.

saveOptions - The output's save options.

dataTable - Table that contains data to be inserted into mail merge fields. Field names are not case sensitive. If a field name that is not found in the document is encountered, it is ignored.

mailMergeOptions - Mail merge options.

Throws:

java.lang.Exception

executeWithRegionsToImages

public static java.io.OutputStream[] executeWithRegionsToImages(java.lang.String inputFileName,
                                                                ImageSaveOptions saveOptions,
                                                                DataSet dataSet)
                                                         throws java.lang.Exception

Throws:

java.lang.Exception

executeWithRegionsToImages

public static java.io.OutputStream[] executeWithRegionsToImages(java.lang.String inputFileName,
                                                                ImageSaveOptions saveOptions,
                                                                DataSet dataSet,
                                                                MailMergeOptions mailMergeOptions)
                                                         throws java.lang.Exception

Performs mail merge from a DataSet into the document with mail merge regions and renders the result to images.

Examples:

Shows how to do mail merge with regions operation from a DataSet and save result to images.

 
 // There is a several ways to do mail merge with regions operation from a DataSet:
 String doc = getMyDir() + "Mail merge with regions data set.docx";

 DataTable tableCustomers = new DataTable("Customers");
 tableCustomers.getColumns().add("CustomerID");
 tableCustomers.getColumns().add("CustomerName");
 tableCustomers.getRows().add(new Object[]{1, "John Doe"});
 tableCustomers.getRows().add(new Object[]{2, "Jane Doe"});

 DataTable tableOrders = new DataTable("Orders");
 tableOrders.getColumns().add("CustomerID");
 tableOrders.getColumns().add("ItemName");
 tableOrders.getColumns().add("Quantity");
 tableOrders.getRows().add(new Object[]{1, "Hawaiian", 2});
 tableOrders.getRows().add(new Object[]{2, "Pepperoni", 1});
 tableOrders.getRows().add(new Object[]{2, "Chicago", 1});

 DataSet dataSet = new DataSet();
 dataSet.getTables().add(tableCustomers);
 dataSet.getTables().add(tableOrders);
 dataSet.getRelations().add(tableCustomers.getColumns().get("CustomerID"), tableOrders.getColumns().get("CustomerID"));

 OutputStream[] images = MailMerger.executeWithRegionsToImages(doc, new ImageSaveOptions(SaveFormat.PNG), dataSet);
 MailMergeOptions options = new MailMergeOptions();
 options.setTrimWhitespaces(true);
 images = MailMerger.executeWithRegionsToImages(doc, new ImageSaveOptions(SaveFormat.PNG), dataSet, options);
 
 

Parameters:

inputFileName - The input file name.

saveOptions - The output's save options.

dataSet - DataSet that contains data to be inserted into mail merge fields.

mailMergeOptions - Mail merge options.

Throws:

java.lang.Exception

executeWithRegionsToImages

public static java.io.OutputStream[] executeWithRegionsToImages(java.io.InputStream inputStream,
                                                                ImageSaveOptions saveOptions,
                                                                DataSet dataSet)
                                                         throws java.lang.Exception

Throws:

java.lang.Exception

executeWithRegionsToImages

public static java.io.OutputStream[] executeWithRegionsToImages(java.io.InputStream inputStream,
                                                                ImageSaveOptions saveOptions,
                                                                DataSet dataSet,
                                                                MailMergeOptions mailMergeOptions)
                                                         throws java.lang.Exception

Performs mail merge from a DataSet into the document with mail merge regions and renders the result to images.

Examples:

Shows how to do mail merge with regions operation from a DataSet using documents from the stream and save result to images.

 
 // There is a several ways to do mail merge with regions operation from a DataSet using documents from the stream:
 DataTable tableCustomers = new DataTable("Customers");
 tableCustomers.getColumns().add("CustomerID");
 tableCustomers.getColumns().add("CustomerName");
 tableCustomers.getRows().add(new Object[]{1, "John Doe"});
 tableCustomers.getRows().add(new Object[]{2, "Jane Doe"});

 DataTable tableOrders = new DataTable("Orders");
 tableOrders.getColumns().add("CustomerID");
 tableOrders.getColumns().add("ItemName");
 tableOrders.getColumns().add("Quantity");
 tableOrders.getRows().add(new Object[]{1, "Hawaiian", 2});
 tableOrders.getRows().add(new Object[]{2, "Pepperoni", 1});
 tableOrders.getRows().add(new Object[]{2, "Chicago", 1});

 DataSet dataSet = new DataSet();
 dataSet.getTables().add(tableCustomers);
 dataSet.getTables().add(tableOrders);
 dataSet.getRelations().add(tableCustomers.getColumns().get("CustomerID"), tableOrders.getColumns().get("CustomerID"));

 try (FileInputStream streamIn = new FileInputStream(getMyDir() + "Mail merge.doc")) {
     OutputStream[] images = MailMerger.executeWithRegionsToImages(streamIn, new ImageSaveOptions(SaveFormat.PNG), dataSet);
     MailMergeOptions options = new MailMergeOptions();
     options.setTrimWhitespaces(true);
     images = MailMerger.executeWithRegionsToImages(streamIn, new ImageSaveOptions(SaveFormat.PNG), dataSet, options);
 }
 
 

Parameters:

inputStream - The input file stream.

saveOptions - The output's save options.

dataSet - DataSet that contains data to be inserted into mail merge fields.

mailMergeOptions - Mail merge options.

Throws:

java.lang.Exception