RichEditControl.MailMerge(Document) Method

Merges data to the current document and sends the result to the specified Document instance.

Namespace: DevExpress.XtraRichEdit

Assembly: DevExpress.XtraRichEdit.v21.2.dll

NuGet Packages: DevExpress.Win.Design, DevExpress.Win.RichEdit

Declaration

C#

public void MailMerge(
    Document document
)

VB.NET

Public Sub MailMerge(
    document As Document
)

Parameters

Name	Type	Description
document	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 RichEditControl.Options.MailMerge.DataSource property 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(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#L66

//When the mail merge starts, the CalculateDocumentVariable raises:
mainRichEdit.MailMerge(resultRichEdit.Document);

VB.NET

winforms-richedit-create-a-master-detail-report/VB/RichEditMasterDetailMailMerge/Form1.vb#L62

'When the mail merge starts, the CalculateDocumentVariable raises:
mainRichEdit.MailMerge(resultRichEdit.Document)