The Aspose.Words.MailMerging namespace 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.MailMerge property.

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

See also: Aspose::Words::Reporting

Classes
class	FieldMergingArgs
	Provides data for the MergeField event. More...

class	FieldMergingArgsBase
	Base class for FieldMergingArgs and ImageFieldMergingArgs. More...

interface	IFieldMergingCallback
	Implement this interface if you want to control how data is inserted into merge fields during a mail merge operation. More...

class	ImageFieldMergingArgs
	Provides data for the ImageFieldMerging() event. More...

interface	IMailMergeCallback
	Implement this interface if you want to receive notifications while mail merge is performed. More...

interface	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. More...

interface	IMailMergeDataSourceRoot
	Implement this interface to allow mail merge from a custom data source with master-detail data. More...

class	MailMerge
	Represents the mail merge functionality. More...

class	MailMergeRegionInfo
	Contains information about a mail merge region. More...

class	MappedDataFieldCollection
	Allows to automatically map between names of fields in your data source and names of mail merge fields in the document. More...

Enumerations
enum class	MailMergeCleanupOptions
	Specifies options that determine what items are removed during mail merge. More...

Enumeration Type Documentation

◆ MailMergeCleanupOptions

enum Aspose::Words::MailMerging::MailMergeCleanupOptions

strong

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

Enumerator
None	Specifies a default value.
RemoveEmptyParagraphs	Specifies whether paragraphs that contained mail merge fields with no data should be removed from the document. When this option is set, paragraphs which contain region start and end merge fields which are otherwise empty are also removed.
RemoveUnusedRegions	Specifies whether unused mail merge regions should be removed from the document.
RemoveUnusedFields	Specifies whether unused merge fields should be removed from the document.
RemoveContainingFields	Specifies whether fields that contain merge fields (for example, IFs) should be removed from the document if the nested merge fields are removed.
RemoveStaticFields	Specifies whether static fields should be removed from the document. Static fields are fields, which results remain the same upon any document change. Fields, which do not store their results in a document and are calculated on the fly (like FieldListNum, FieldSymbol, etc.) are not considered to be static. Here is the full list of field types, which are not considered to be static: FieldAdvance FieldAutoNum FieldAutoNumLegal FieldAutoNumOutline FieldBarcode FieldBidiOutline FieldDate FieldDisplayBarcode FieldMergeBarcode FieldFormCheckBox FieldFormDropDown FieldFormula FieldGoToButton FieldHyperlink FieldIncludeText FieldIndexEntry FieldLink FieldListNum FieldMacroButton FieldNoteRef FieldNumPages FieldPage FieldPageRef FieldPrint FieldPrintDate FieldPrivate FieldRefDoc FieldSection FieldSectionPages FieldSymbol FieldTime FieldTOAEntry FieldTOCEntry
RemoveEmptyTableRows	Specifies whether empty rows that contain mail merge regions should be removed from the document.

Classes

Enumerations

Enumeration Type Documentation

◆ MailMergeCleanupOptions