MailMerger.ExecuteWithRegionsToImages

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

ExecuteWithRegionsToImages(string, ImageSaveOptions, DataTable, MailMergeOptions)

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

public static Stream[] ExecuteWithRegionsToImages(string inputFileName, 
    ImageSaveOptions saveOptions, DataTable dataTable, MailMergeOptions mailMergeOptions = null)
ParameterTypeDescription
inputFileNameStringThe input file name.
saveOptionsImageSaveOptionsThe output’s save options.
dataTableDataTableTable 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.
mailMergeOptionsMailMergeOptionsMail merge options.

Examples

Shows how to fill a template with data by executing mail merge with regions using a DataTable data source and save the result to images stream.

DataTable dt = new DataTable("Items");
dt.Columns.Add("Item");
dt.Columns.Add("Quantity");
dt.Columns.Add("Price");
dt.Rows.Add("Orange", 5, 10);
dt.Rows.Add("Apple", 10, 4);
dt.Rows.Add(null, null, null); // empty row.
dt.Rows.Add("Pear", 4, 6);

Stream[] pages = MailMerger.ExecuteWithRegionsToImages(MyDir + "MailMergeTemplate.docx", new ImageSaveOptions(SaveFormat.Jpeg), dt);

See Also


ExecuteWithRegionsToImages(Stream, ImageSaveOptions, DataTable, MailMergeOptions)

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

public static Stream[] ExecuteWithRegionsToImages(Stream inputStream, ImageSaveOptions saveOptions, 
    DataTable dataTable, MailMergeOptions mailMergeOptions = null)
ParameterTypeDescription
inputStreamStreamThe input file stream.
saveOptionsImageSaveOptionsThe output’s save options.
dataTableDataTableTable 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.
mailMergeOptionsMailMergeOptionsMail merge options.

Examples

Shows how to fill a template loaded from stream with data by executing mail merge with regions using a DataTable data source and save the result to images stream.

DataTable dt = new DataTable("Items");
dt.Columns.Add("Item");
dt.Columns.Add("Quantity");
dt.Columns.Add("Price");
dt.Rows.Add("Orange", 5, 10);
dt.Rows.Add("Apple", 10, 4);
dt.Rows.Add(null, null, null); // empty row.
dt.Rows.Add("Pear", 4, 6);

using (Stream input = File.OpenRead(MyDir + "MailMergeTemplate.docx"))
{
    Stream[] pages = MailMerger.ExecuteWithRegionsToImages(input, new ImageSaveOptions(SaveFormat.Jpeg), dt);
}

See Also


ExecuteWithRegionsToImages(string, ImageSaveOptions, DataSet, MailMergeOptions)

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

public static Stream[] ExecuteWithRegionsToImages(string inputFileName, 
    ImageSaveOptions saveOptions, DataSet dataSet, MailMergeOptions mailMergeOptions = null)
ParameterTypeDescription
inputFileNameStringThe input file name.
saveOptionsImageSaveOptionsThe output’s save options.
dataSetDataSetDataSet that contains data to be inserted into mail merge fields.
mailMergeOptionsMailMergeOptionsMail merge options.

Examples

Shows how to fill a template with data by executing mail merge with regions using a DataSet data source and save the result to images stream.

DataSet ds = new DataSet();
DataTable dt = ds.Tables.Add("Items");
dt.Columns.Add("Item");
dt.Columns.Add("Quantity");
dt.Columns.Add("Price");
dt.Rows.Add("Orange", 5, 10);
dt.Rows.Add("Apple", 10, 4);
dt.Rows.Add(null, null, null); // empty row.
dt.Rows.Add("Pear", 4, 6);

Stream[] pages = MailMerger.ExecuteWithRegionsToImages(MyDir + "MailMergeTemplate.docx", new ImageSaveOptions(SaveFormat.Jpeg), ds);

See Also


ExecuteWithRegionsToImages(Stream, ImageSaveOptions, DataSet, MailMergeOptions)

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

public static Stream[] ExecuteWithRegionsToImages(Stream inputStream, ImageSaveOptions saveOptions, 
    DataSet dataSet, MailMergeOptions mailMergeOptions = null)
ParameterTypeDescription
inputStreamStreamThe input file stream.
saveOptionsImageSaveOptionsThe output’s save options.
dataSetDataSetDataSet that contains data to be inserted into mail merge fields.
mailMergeOptionsMailMergeOptionsMail merge options.

Examples

Shows how to fill a template loaded from stream with data by executing mail merge with regions using a DataSet data source and save the result to images stream.

DataSet ds = new DataSet();
DataTable dt = ds.Tables.Add("Items");
dt.Columns.Add("Item");
dt.Columns.Add("Quantity");
dt.Columns.Add("Price");
dt.Rows.Add("Orange", 5, 10);
dt.Rows.Add("Apple", 10, 4);
dt.Rows.Add(null, null, null); // empty row.
dt.Rows.Add("Pear", 4, 6);

using (Stream input = File.OpenRead(MyDir + "MailMergeTemplate.docx"))
{
    Stream[] pages = MailMerger.ExecuteWithRegionsToImages(input, new ImageSaveOptions(SaveFormat.Jpeg), ds);
}

See Also