Skip to main content

RichEditDocumentServer.MailMerge(MailMergeOptions, Document) Method

Merges data to the current document and sends the result to the specified Document instance. Allows you to set the mail merge options.

Namespace: DevExpress.XtraRichEdit

Assembly: DevExpress.RichEdit.v23.2.Core.dll

NuGet Packages: DevExpress.RichEdit.Core, DevExpress.Win.Navigation

Declaration

public void MailMerge(
    MailMergeOptions options,
    Document targetDocument
)

Parameters

Name Type Description
options MailMergeOptions

An object that contains options for the current merge.

targetDocument Document

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

Remarks

The MailMerge method merges the current document with records retrieved from the MailMergeOptions.DataSource specified by the options parameter and sends the result to the specified document container, e.g., another RichEditControl.

The Document.CalculateDocumentVariable event is raised for the Document object passed as a parameter to the MailMerge method.

See Also