RichEditControl.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.Xpf.RichEdit

Assembly: DevExpress.Xpf.RichEdit.v24.2.dll

NuGet Package: DevExpress.Wpf.RichEdit

Declaration

C#

public void MailMerge(
    MailMergeOptions options,
    Document targetDocument
)

VB.NET

Public Sub MailMerge(
    options As MailMergeOptions,
    targetDocument As Document
)

Parameters

Name	Type	Description
options	MailMergeOptions	An object that contains options for the current merge.
targetDocument	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 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.