RichEditControl.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.Xpf.RichEdit

Assembly: DevExpress.Xpf.RichEdit.v24.2.dll

NuGet Package: DevExpress.Wpf.RichEdit

Declaration

C#

public void MailMerge(
    MailMergeOptions options,
    Stream stream,
    DocumentFormat format
)

VB.NET

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

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