RichEditControl.MailMerge(String, DocumentFormat) Method

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

Namespace: DevExpress.Xpf.RichEdit

Assembly: DevExpress.Xpf.RichEdit.v24.1.dll

NuGet Package: DevExpress.Wpf.RichEdit

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 merged document 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 DXRichEditMailMergeOptions.DataSource property, and saves the merged document to the specified file.

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