Document.MailMerge(MailMergeOptions, String, DocumentFormat) Method
Merges data to the current document and saves the result to a file in the specified format. Allows you to set mail merge options.
Namespace: DevExpress.XtraRichEdit.API.Native
Assembly: DevExpress.RichEdit.v24.1.Core.dll
NuGet Packages: DevExpress.RichEdit.Core, DevExpress.Win.Navigation
Declaration
Parameters
Name | Type | Description |
---|---|---|
options | MailMergeOptions | An object that contains options for the current merge. |
fileName | String | A name of the file to which the merged document is saved. |
format | DocumentFormat | An enumeration member that indicates the destination format. |
Remarks
The MailMerge
method merges the current document with records retrieved from the MailMergeOptions.DataSource property specified by the options
parameter, and saves the merged document to a file.
The MailMerge
method results in the Document.CalculateDocumentVariable event being fired for the Document object.
Related GitHub Examples
The following code snippets (auto-collected from DevExpress Examples) contain references to the MailMerge(MailMergeOptions, String, DocumentFormat) method.
Note
The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.