officefileapi-devexpress-dot-xtrarichedit-dot-api-dot-native-dot-document-dot-mailmerge-x28-devexpress-dot-xtrarichedit-dot-api-dot-native-dot-mailmergeoptions-devexpress-dot-xtrarichedit-dot-api-dot-native-dot-document-x29.md
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.API.Native
Assembly : DevExpress.RichEdit.v25.2.Core.dll
NuGet Package : DevExpress.RichEdit.Core
void MailMerge(
MailMergeOptions options,
Document targetDocument
)
Sub MailMerge(
options As MailMergeOptions,
targetDocument As Document
)
| 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.
|
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.
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.
winforms-richedit-control-mail-merge/CS/MailMerge/Form1.cs#L32
// Export a mail-merged document in a different Document instance
richEditControl1.Document.MailMerge(myMergeOptions, richEditControl2.Document);
xtraTabControl1.SelectedTabPageIndex = 1;
winforms-richedit-use-images-in-mail-merge/CS/Form1.cs#L66
richEditControl1.Document.MailMerge(options, control.Document);
winforms-richedit-use-calculatedocumentvariable-event-to-insert-formatted-content/CS/Form1.cs#L38
server.CalculateDocumentVariable += new CalculateDocumentVariableEventHandler(Document_CalculateDocumentVariable);
richEditControl1.Document.MailMerge(myMergeOptions, server.Document);
how-to-use-docvariable-fields/CS/DocumentVariablesExample/Form1.cs#L38
this.Cursor = Cursors.WaitCursor;
richEditControl1.Document.MailMerge(myMergeOptions, richEditControl2.Document);
this.Cursor = Cursors.Default;
dxrichedit-for-wpf-how-to-implement-progress-indicator/CS/MainWindow.xaml.cs#L28
myMergeOptions.MergeMode = MergeMode.NewSection;
richEditControl1.Document.MailMerge(myMergeOptions, richEditControl2.Document);
tabControl.SelectedIndex = 1;
winforms-richedit-control-mail-merge/VB/MailMerge/Form1.vb#L29
'Export the mail-merged document in a different Document instance
richEditControl1.Document.MailMerge(myMergeOptions, richEditControl2.Document)
xtraTabControl1.SelectedTabPageIndex = 1
winforms-richedit-use-images-in-mail-merge/VB/Form1.vb#L64
Dim control As RichEditControl = New RichEditControl()
richEditControl1.Document.MailMerge(options, control.Document)
control.Dock = DockStyle.Fill
winforms-richedit-use-calculatedocumentvariable-event-to-insert-formatted-content/VB/Form1.vb#L30
AddHandler server.CalculateDocumentVariable, New CalculateDocumentVariableEventHandler(AddressOf Document_CalculateDocumentVariable)
richEditControl1.Document.MailMerge(myMergeOptions, server.Document)
richEditControl1.CreateNewDocument()
how-to-use-docvariable-fields/VB/DocumentVariablesExample/Form1.vb#L38
Cursor = Cursors.WaitCursor
richEditControl1.Document.MailMerge(myMergeOptions, richEditControl2.Document)
Cursor = Cursors.Default
See Also