aspose.words.mailmerging module

The aspose.words.mailmerging module contains classes of the “original” mail merge reporting engine.

This reporting engine requires the document to be marked up with Microsoft Word mail merge fields, but supports more functionality than Microsoft Word’s mail merge.

The engine allows to quickly and easily populate a report template with data from various sources such as DataTable, DataSet, DataView, IDataReader or an array of values.

The MailMerge object which provides access to the reporting functionality is available via the Document.mail_merge property.

For the newer and more advanced reporting engine based on the LINQ method syntax see aspose.words.reporting.

Classes

Class	Description
FieldMergingArgs	Provides data for the MergeField event. To learn more, visit the Mail Merge and Reporting documentation article.
FieldMergingArgsBase	Base class for FieldMergingArgs and ImageFieldMergingArgs. To learn more, visit the Mail Merge and Reporting documentation article.
IFieldMergingCallback	Implement this interface if you want to control how data is inserted into merge fields during a mail merge operation.
IMailMergeCallback	Implement this interface if you want to receive notifications while mail merge is performed.
IMailMergeDataSource	Implement this interface to allow mail merge from a custom data source, such as a list of objects. Master-detail data is also supported.
IMailMergeDataSourceRoot	Implement this interface to allow mail merge from a custom data source with master-detail data.
ImageFieldMergingArgs	Provides data for the IFieldMergingCallback.image_field_merging() event. To learn more, visit the Mail Merge and Reporting documentation article.
MailMerge	Represents the mail merge functionality. To learn more, visit the Mail Merge and Reporting documentation article.
MailMergeRegionInfo	Contains information about a mail merge region. To learn more, visit the Mail Merge and Reporting documentation article.
MappedDataFieldCollection	Allows to automatically map between names of fields in your data source and names of mail merge fields in the document. To learn more, visit the Mail Merge and Reporting documentation article.
MustacheTag	Represents “mustache” tag.

Enumerations

Enumeration	Description
MailMergeCleanupOptions	Specifies options that determine what items are removed during mail merge.