RichEditControl.MailMerge(String, DocumentFormat) Method

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

Namespace: DevExpress.XtraRichEdit

Assembly: DevExpress.XtraRichEdit.v20.1.dll

Declaration

public void MailMerge(
    string fileName,
    DocumentFormat format
)
Public Sub MailMerge(
    fileName As String,
    format As DocumentFormat
)

Parameters

Name Type Description
fileName String

A name of the file to which the merged document is saved.

format DocumentFormat

A DocumentFormat enumeration member specifying the destination format.

Remarks

The MailMerge method merges the current document with records retrieved from the RichEditMailMergeOptions.DataSource, specified via the RichEditControlOptionsBase.MailMerge options, and saves the merged document to the specified file.

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