IRichEditDocumentServer.MailMerge(MailMergeOptions, String, DocumentFormat) Method

Merges the current document using the specified options 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(
    MailMergeOptions options,
    string fileName,
    DocumentFormat format
)

VB.NET

Sub MailMerge(
    options As MailMergeOptions,
    fileName As String,
    format As DocumentFormat
)

Parameters

Name	Type	Description
options	MailMergeOptions	A MailMergeOptions interface exposing options for the current merge.
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, starting from the MailMergeOptions.FirstRecordIndex through the MailMergeOptions.LastRecordIndex retrieved from the MailMergeOptions.DataSource specified via the options parameter, and saves the merged document to the specified file.

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