Click or drag to resize
MailMerge Class
Represents a class that is used for mail merging - an operation by which DocumentModel may work in conjunction with data from an external data source, importing this data into a DocumentModel according to a set of codes contained in DocumentModel known as Fields.
Inheritance Hierarchy
SystemObject
  GemBox.Document.MailMergingMailMerge

Namespace:  GemBox.Document.MailMerging
Assembly:  GemBox.Document (in GemBox.Document.dll) Version: 25.3.30.1243
Syntax
public sealed class MailMerge

The MailMerge type exposes the following members.

Properties
  NameDescription
Public propertyClearOptions
Gets or sets the mail merge clear options.
Public propertyDocument
Gets the owner document.
Public propertyFieldMappings
Gets the mappings from field names to data source column names.
Public propertyRangeEndPrefix
Gets or sets the range end prefix that signals the mail merge engine that named range has ended.
Public propertyRangeStartPrefix
Gets or sets the range start prefix that signals the mail merge engine that following Fields are a part of a named range.
Top
Methods
  NameDescription
Public methodExecute(Object)
Executes a mail merge operation with specified data source.
Public methodExecute(Object, String)
Executes a mail merge operation with specified range name and data source.
Public methodGetMergeFieldNames
Gets the merge field names.
Public methodRemoveMergeFields
Removes all mail merge related fields (MergeField, MergeRec, MergeSeq, Next and If fields).
Public methodRemoveMergeFields(Boolean)
Removes the Fields with FieldType value of MergeField from the owning DocumentModel.
Top
Events
  NameDescription
Public eventFieldMerging
Occurs when Field is merging with data source value and can be used to customize the merging operation.
Top
Remarks

MailMerge can be accessed through MailMerge property.

Mail merge can be executed with a variety of data source types on a whole document or a named part of the document. For more information, see mail merge.

For mail merge examples, see mail merge samples.

See Also