RichEditControl.MailMerge(Stream, DocumentFormat) Method

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

Namespace: DevExpress.XtraRichEdit

Assembly: DevExpress.XtraRichEdit.v20.1.dll

Declaration

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

Parameters

Name Type Description
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 retrieved from the default mail merge RichEditMailMergeOptions.DataSource specified via the RichEditControlOptionsBase.MailMerge options and sends the merged document to the specified stream.

NOTE

A newer and more convenient approach to Master-Detail Mail Merge is provided by the SnapControl and SnapDocumentServer.

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

See Also