RichEditControl.MailMerge(String, DocumentFormat) Method

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

Namespace: DevExpress.XtraRichEdit

Assembly: DevExpress.XtraRichEdit.v23.2.dll

NuGet Packages: DevExpress.Win.PivotGrid, DevExpress.Win.RichEdit, DevExpress.Win.TreeMap

Declaration

C#

public void MailMerge(
    string fileName,
    DocumentFormat format
)

VB.NET

Public Sub MailMerge(
    fileName As String,
    format As DocumentFormat
)

Parameters

Name	Type	Description
fileName	String	A name of the file to which the merge result is saved.
format	DocumentFormat	An enumeration member that indicates the destination format.

Remarks

The MailMerge method merges the current document with records retrieved from the RichEditControl.Options.MailMerge.DataSource property, and saves the merged document to the specified file.

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