Document.MailMerge(Stream, DocumentFormat) Method

Merges data to the current document, and sends the result in the specified format to a stream.

Namespace : DevExpress.XtraRichEdit.API.Native

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

NuGet Package : DevExpress.RichEdit.Core

Declaration

csharp

void MailMerge(
    Stream stream,
    DocumentFormat format
)

Sub MailMerge(
    stream As Stream,
    format As DocumentFormat
)

Name	Type	Description
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 RichEditDocumentServer.Options.MailMerge.DataSource property, and sends the merged document to the specified stream.

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