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.v21.2.Core.dll

NuGet Package: DevExpress.RichEdit.Core

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

C#

mail-merge-in-a-richeditcontrol/CS/MailMerge/Form1.cs#L68

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

how-to-use-images-in-richedit-mail-merge/CS/Form1.cs#L77

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

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

// Mail-merge the document
document.MailMerge(myMergeOptions, "Result.docx", DocumentFormat.OpenXml);

VB.NET

mail-merge-in-a-richeditcontrol/VB/MailMerge/Form1.vb#L58

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

how-to-use-images-in-richedit-mail-merge/VB/Form1.vb#L72

Dim fileName As String = IO.Directory.GetCurrentDirectory() & "\..\..\MailMergeResult.rtf"
richEditControl1.Document.MailMerge(options, fileName, DocumentFormat.Rtf)
Dim process As Process = New Process()

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

' Mail-merge the document
document.MailMerge(myMergeOptions, "Result.docx", DocumentFormat.OpenXml)
Call Process.Start("Result.docx")