RichEditControl.MailMerge(MailMergeOptions, Document) Method

Merges the current document using the specified options, and sends the result to the specified Document.

Namespace: DevExpress.Xpf.RichEdit

Assembly: DevExpress.Xpf.RichEdit.v19.1.dll

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	A MailMergeOptions interface exposing 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 via the options parameter, and sends the result to the specified document container, e.g. another RichEditControl.

Use the MailMergeOptions.FirstRecordIndex and the MailMergeOptions.LastRecordIndex properties to specify the start and the end of a record set.

The Document.CalculateDocumentVariable event is raised for the object with the Document interface, passed as an argument to the MailMerge method.