Skip to main content

DevExpress v24.2 Update — Your Feedback Matters

Our What's New in v24.2 webpage includes product-specific surveys. Your response to our survey questions will help us measure product satisfaction for features released in this major update and help us refine our plans for our next major release.

Take the survey Not interested

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.v24.2.Core.dll

NuGet Package: DevExpress.RichEdit.Core

#Declaration

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

See Also