A newer version of this page is available. Switch to the current version.

RichEditExtension.MailMerge(String, MailMergeOptions, Document) Method

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

Namespace: DevExpress.Web.Mvc

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

Declaration

public static void MailMerge(
    string extensionName,
    MailMergeOptions mailMergeOptions,
    Document document
)
Public Shared Sub MailMerge(
    extensionName As String,
    mailMergeOptions As MailMergeOptions,
    document As Document
)

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.

document Document

An object exposing the Document interface to which the merged document is sent.

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 document container.

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