RichEditControl.MailMerge(Stream, DocumentFormat) Method

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

Namespace: DevExpress.XtraRichEdit

Assembly: DevExpress.XtraRichEdit.v23.2.dll

NuGet Packages: DevExpress.Win.PivotGrid, DevExpress.Win.RichEdit, DevExpress.Win.TreeMap

Declaration

C#

public void MailMerge(
    Stream stream,
    DocumentFormat format
)

VB.NET

Public Sub MailMerge(
    stream As Stream,
    format As DocumentFormat
)

Parameters

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

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