Document.MailMerge(MailMergeOptions, String, DocumentFormat) Method

Merges the current document using the specified options and sends the result to the specified file in a specified format.

Namespace: DevExpress.XtraRichEdit.API.Native

Assembly: DevExpress.RichEdit.v19.1.Core.dll

Declaration

C#

void MailMerge(
    MailMergeOptions options,
    string fileName,
    DocumentFormat format
)

VB.NET

Sub MailMerge(
    options As MailMergeOptions,
    fileName As String,
    format As DocumentFormat
)

Parameters

Name	Type	Description
options	MailMergeOptions	A MailMergeOptions interface exposing options for the current merge.
fileName	String	A name of the file to which the merged document is saved.
format	DocumentFormat	A DocumentFormat enumeration member specifying the destination format.

Remarks

The MailMerge method merges the current document with records starting from the MailMergeOptions.FirstRecordIndex through the MailMergeOptions.LastRecordIndex retrieved from the MailMergeOptions.DataSource specified via the options parameter, and saves the merged document to the specified 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.

C#

how-to-implement-mail-merge-in-a-richeditcontrol-e1680/CS/MailMerge/Form1.cs#L68

{
    richEditControl1.Document.MailMerge(myMergeOptions, fileDialog.FileName, DocumentFormat.OpenXml);
    System.Diagnostics.Process.Start(fileDialog.FileName);

how-to-use-images-when-implementing-the-mail-merge-functionality-e4164/CS/Form1.cs#L77

richEditControl1.Document.MailMerge(options, fileName, DocumentFormat.Rtf);

word-document-api-use-docvariable-fields/CS/WordProcessingFileAPI_CalcDocumentVariable/Program.cs#L30

myMergeOptions.MergeMode = MergeMode.NewSection;
srv.Document.MailMerge(myMergeOptions, "Result.docx", DocumentFormat.OpenXml);

VB.NET

how-to-implement-mail-merge-in-a-richeditcontrol-e1680/VB/MailMerge/Form1.vb#L60

If fName <> "" Then
    richEditControl1.Document.MailMerge(myMergeOptions, fileDialog.FileName, DocumentFormat.OpenXml)
    System.Diagnostics.Process.Start(fileDialog.FileName)

how-to-use-images-when-implementing-the-mail-merge-functionality-e4164/VB/Form1.vb#L81

richEditControl1.Document.MailMerge(options, fileName, DocumentFormat.Rtf)

word-document-api-use-docvariable-fields/VB/WordProcessingFileAPI_CalcDocumentVariable/Program.vb#L20

myMergeOptions.MergeMode = MergeMode.NewSection
srv.Document.MailMerge(myMergeOptions, "Result.docx", DocumentFormat.OpenXml)
Call Process.Start("Result.docx")