Skip to main content

Document.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.API.Native

Assembly: DevExpress.RichEdit.v23.2.Core.dll

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


void MailMerge(
    MailMergeOptions options,
    Stream stream,
    DocumentFormat format


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.


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 Document.CalculateDocumentVariable event for the Document object.

See Also