Aspose::Words::MailMerging Namespace Reference

Classes

class  FieldMergingArgs
 Provides data for the MergeField event. More...
 
class  FieldMergingArgsBase
 Base class for Aspose::Words::MailMerging::FieldMergingArgs and Aspose::Words::MailMerging::ImageFieldMergingArgs. More...
 
class  ImageFieldMergingArgs
 Provides data for the Aspose::Words::MailMerging::IFieldMergingCallback::ImageFieldMerging(System::SharedPtr<Aspose::Words::MailMerging::ImageFieldMergingArgs>) event. 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  MailMergeCleanupOptions {
  MailMergeCleanupOptions::None = 0x00, MailMergeCleanupOptions::RemoveEmptyParagraphs = 0x01, MailMergeCleanupOptions::RemoveUnusedRegions = 0x02, MailMergeCleanupOptions::RemoveUnusedFields = 0x04,
  MailMergeCleanupOptions::RemoveContainingFields = 0x08, MailMergeCleanupOptions::RemoveStaticFields = 0x10, MailMergeCleanupOptions::RemoveEmptyTableRows = 0x20
}
 Specifies options that determine what items are removed during mail merge. More...
 

Enumeration Type Documentation

◆ MailMergeCleanupOptions

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.

This option applies only to mail merge with regions.

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 Aspose::Words::Fields::FieldType::FieldListNum, Aspose::Words::Fields::FieldType::FieldSymbol, etc.) are not considered to be static.

Here is the full list of field types, which are not considered to be static:

RemoveEmptyTableRows 

Specifies whether empty rows that contain mail merge regions should be removed from the document.

This option applies only to mail merge with regions.