Skip to main content

RichEditDocumentServer.MailMerge(MailMergeOptions, Stream, DocumentFormat) Method

Merges data to the current document and sends the result in the specified format to a stream. Allows you to set mail merge options.

Namespace: DevExpress.XtraRichEdit

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

NuGet Packages: DevExpress.RichEdit.Core, DevExpress.Win.Navigation

Declaration

public void MailMerge(
    MailMergeOptions options,
    Stream stream,
    DocumentFormat format
)

Parameters

Name Type Description
options MailMergeOptions

An object that contains options for the current merge.

stream Stream

An output stream.

format DocumentFormat

An enumeration member that indicates the destination format.

Remarks

The MailMerge method merges the current document with records retrieved from the MailMergeOptions.DataSource property specified by the options parameter, and sends the merged document to the specified stream.

The MailMerge method triggers the CalculateDocumentVariable event for the RichEditDocumentServer object.

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the MailMerge(MailMergeOptions, Stream, DocumentFormat) 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