RichEditExtension.MailMerge(String, MailMergeOptions, String, DocumentFormat) Method

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

Namespace: DevExpress.Web.Mvc

Assembly: DevExpress.Web.Mvc5.v20.2.dll

Declaration

public static void MailMerge(
    string extensionName,
    MailMergeOptions mailMergeOptions,
    string fileName,
    DocumentFormat documentFormat
)
Public Shared Sub MailMerge(
    extensionName As String,
    mailMergeOptions As MailMergeOptions,
    fileName As String,
    documentFormat As DocumentFormat
)

Parameters

Name Type Description
extensionName String

A string value that specifies the RichEdit name.

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 and sends the merged document to the specified file.

The correct RichEdit's state is available on a controller only if the form containing RichEdit is submitted or a request to the server is sent using the RichEdit's callback.

See Also