Back to Devexpress

RichEditControl.MailMerge(Document) Method

windowsforms-devexpress-dot-xtrarichedit-dot-richeditcontrol-dot-mailmerge-x28-devexpress-dot-xtrarichedit-dot-api-dot-native-dot-document-x29.md

latest3.3 KB
Original Source

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.v25.2.dll

NuGet Package : DevExpress.Win.RichEdit

Declaration

csharp
public void MailMerge(
    Document document
)
vb
Public Sub MailMerge(
    document As Document
)

Parameters

NameTypeDescription
documentDocument

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.

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.

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

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

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

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

See Also

RichEditControl Class

RichEditControl Members

DevExpress.XtraRichEdit Namespace