RichEditControl.MailMerge(MailMergeOptions, Document) Method

Merges data to the current document and sends the result to the specified Document instance. Allows you to set the mail merge options.

Namespace: DevExpress.XtraRichEdit

Assembly: DevExpress.XtraRichEdit.v23.2.dll

NuGet Packages: DevExpress.Win.PivotGrid, DevExpress.Win.RichEdit, DevExpress.Win.TreeMap

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	An object that contains options for the current merge.
targetDocument	Document	An object that exposes 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 by the options parameter and sends the result to the specified document container, e.g., another RichEditControl.

The Document.CalculateDocumentVariable event is raised for the Document object passed as a parameter to the MailMerge method.

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference 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#

winforms-richedit-create-a-master-detail-report/CS/RichEditMasterDetailMailMerge/Form1.cs#L92

//Merge the document and pass it to the RichEditDocumentServer:
masterRichEdit.MailMerge(options, result.Document);
result.CalculateDocumentVariable -= result_CalculateDocumentVariable;

VB.NET

winforms-richedit-create-a-master-detail-report/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