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

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

Namespace: DevExpress.Web.Mvc

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

NuGet Package: DevExpress.Web.Mvc5

Declaration

C#

public static void MailMerge(
    string extensionName,
    MailMergeOptions mailMergeOptions,
    Stream stream,
    DocumentFormat documentFormat
)

VB.NET

Public Shared Sub MailMerge(
    extensionName As String,
    mailMergeOptions As MailMergeOptions,
    stream As Stream,
    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.
stream	Stream	A Stream object that is the output stream.
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 stream.

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.