Skip to main content
.NET Framework 4.5.2+

Document.MailMerge(MailMergeOptions, Document) Method

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

Namespace: DevExpress.XtraRichEdit.API.Native

Assembly: DevExpress.RichEdit.v22.1.Core.dll

Declaration

void MailMerge(
    MailMergeOptions options,
    Document targetDocument
)

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.

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

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.

See Also