RichEditControl.MailMerge(MailMergeOptions, Document) Method

Merges the current document using the specified options, and sends the result to the specified Document.

Namespace: DevExpress.XtraRichEdit

Assembly: DevExpress.XtraRichEdit.v19.1.dll

Declaration

C#

public void MailMerge(
    MailMergeOptions options,
    Document targetDocument
)

VB.NET

Public Sub MailMerge(
    options As MailMergeOptions,
    targetDocument As Document
)

Parameters

Name	Type	Description
options	MailMergeOptions	A MailMergeOptions interface exposing options for the current merge.
targetDocument	Document	An object exposing the Document interface to which the merged document is sent.

Remarks

The MailMerge method merges the current document with records retrieved from the MailMergeOptions.DataSource, specified via the options parameter, and sends the result to the specified document container, e.g. another RichEditControl.

Note

A newer and more convenient approach to Master-Detail Mail Merge is provided by the SnapControl and SnapDocumentServer.

Use the MailMergeOptions.FirstRecordIndex and the MailMergeOptions.LastRecordIndex properties to specify the start and the end of a record set.

The Document.CalculateDocumentVariable event is raised for the object with the Document interface, passed as an argument to the MailMerge method.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the MailMerge(MailMergeOptions, Document) 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-export-each-record-into-a-new-pdf-file-during-the-mailmerge-operation-e4308/CS/MailMergeEachRecordSeparatePDF/Form1.cs#L42

using (FileStream fs = new FileStream(filename, FileMode.Create, System.IO.FileAccess.Write)) {
    richEditControl1.MailMerge(options, docServer.Document);
    docServer.ExportToPdf(fs);

VB.NET

how-to-export-each-record-into-a-new-pdf-file-during-the-mailmerge-operation-e4308/VB/MailMergeEachRecordSeparatePDF/Form1.vb#L45

Using fs As New FileStream(filename, FileMode.Create, System.IO.FileAccess.Write)
    richEditControl1.MailMerge(options, docServer.Document)
    docServer.ExportToPdf(fs)

how-to-create-a-master-detail-report-in-a-richeditcontrol-e3331/VB/RichEditMasterDetailMailMerge/Form1.vb#L86

'Merge the document and pass it to the RichEditDocumentServer:
masterRichEdit.MailMerge(options, result.Document)
RemoveHandler result.CalculateDocumentVariable, AddressOf result_CalculateDocumentVariable