ASPxRichEdit.MailMerge(MailMergeOptions, String, DocumentFormat) Method

Initializes the mail merge process and generates the resulting documents containing the merged information.

Namespace: DevExpress.Web.ASPxRichEdit

Assembly: DevExpress.Web.ASPxRichEdit.v24.1.dll

NuGet Package: DevExpress.Web.Office

Declaration

C#

public void MailMerge(
    MailMergeOptions mailMergeOptions,
    string fileName,
    DocumentFormat documentFormat
)

VB.NET

Public Sub MailMerge(
    mailMergeOptions As MailMergeOptions,
    fileName As String,
    documentFormat As DocumentFormat
)

Parameters

Name	Type	Description
mailMergeOptions	MailMergeOptions	A MailMergeOptions interface exposing options for the current merge.
fileName	String	A name of the file to which the merged document is saved.
documentFormat	DocumentFormat	A DocumentFormat enumeration member specifying the destination format.

Remarks

The MailMerge method merges the current document with records retrieved from the default mail merge data source specified via the RichEdit’s DataSourceID (or DataSource) property (starting from the MailMergeOptions.FirstRecordIndex through the MailMergeOptions.LastRecordIndex, as specified via the mailMergeOptions parameter) and sends the merged document to the specified file.