IRichEditDocumentServer.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.RichEdit.v24.1.Core.dll

NuGet Packages: DevExpress.RichEdit.Core, DevExpress.Win.Navigation

Declaration

C#

void MailMerge(
    string fileName,
    DocumentFormat format
)

VB.NET

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.

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