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

IRichEditDocumentServer.MailMerge(MailMergeOptions, Stream, DocumentFormat) Method

Merges the current document using the specified options and sends the result to the specified stream in a specified format.

Namespace: DevExpress.XtraRichEdit

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

A MailMergeOptions interface exposing options for the current merge.

stream Stream

A Stream object that is the output stream.

format DocumentFormat

A DocumentFormat enumeration member specifying the destination format.

#Remarks

The MailMerge method merges the current document with records starting from the MailMergeOptions.FirstRecordIndex through the MailMergeOptions.LastRecordIndex retrieved from the MailMergeOptions.DataSource specified via the options parameter, and sends the merged document to the specified stream.

The MailMerge method results in the RichEditControl.CalculateDocumentVariable event being fired for the IRichEditDocumentServer object.

See Also