Document.MailMerge(MailMergeOptions, Document) Method

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

Namespace: DevExpress.XtraRichEdit.API.Native

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

Declaration

C#

void MailMerge(
    MailMergeOptions options,
    Document targetDocument
)

VB.NET

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.

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

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the MailMerge(MailMergeOptions, Document) method.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

expandoobjects-data-binding-and-mail-merge-in-xtrarichedit-e3752/CS/ExpandoObject_MailMerge/Form1.cs#L64

frmResultingDocument form = new frmResultingDocument();
richEditControl1.Document.MailMerge(options,form.Document);
form.Show(this);

how-to-implement-progress-indicator-for-slow-richeditcontrol-operations-e3075/CS/ProgressIndicator/Form1.cs#L29

myMergeOptions.MergeMode = MergeMode.NewSection;
richEditControl1.Document.MailMerge(myMergeOptions, richEditControl2.Document);
xtraTabControl1.SelectedTabPageIndex = 1;

how-to-implement-mail-merge-in-a-richeditcontrol-e1680/CS/MailMerge/Form1.cs#L31

myMergeOptions.MergeMode = MergeMode.NewSection;
richEditControl1.Document.MailMerge(myMergeOptions, richEditControl2.Document);
#endregion #merge

how-to-use-images-when-implementing-the-mail-merge-functionality-e4164/CS/Form1.cs#L66

richEditControl1.Document.MailMerge(options, control.Document);

how-to-create-a-calculated-field-e3663/CS/Form1.cs#L24

richEditControl1.Document.MailMerge(mailMergeOptions, server.Document);

VB.NET

expandoobjects-data-binding-and-mail-merge-in-xtrarichedit-e3752/VB/ExpandoObject_MailMerge/Form1.vb#L63

Dim form As New frmResultingDocument()
richEditControl1.Document.MailMerge(options,form.Document)
form.Show(Me)

how-to-implement-progress-indicator-for-slow-richeditcontrol-operations-e3075/VB/ProgressIndicator/Form1.vb#L27

myMergeOptions.MergeMode = MergeMode.NewSection
richEditControl1.Document.MailMerge(myMergeOptions, richEditControl2.Document)
xtraTabControl1.SelectedTabPageIndex = 1

how-to-implement-mail-merge-in-a-richeditcontrol-e1680/VB/MailMerge/Form1.vb#L29

            myMergeOptions.MergeMode = MergeMode.NewSection
            richEditControl1.Document.MailMerge(myMergeOptions, richEditControl2.Document)
'            #End Region ' #merge

how-to-use-images-when-implementing-the-mail-merge-functionality-e4164/VB/Form1.vb#L70

richEditControl1.Document.MailMerge(options, control.Document)

how-to-create-a-calculated-field-e3663/VB/Form1.vb#L26

richEditControl1.Document.MailMerge(mailMergeOptions, server.Document)