officefileapi-devexpress-dot-xtrarichedit-dot-api-dot-native-dot-document-a9423248.md
Enables customizing the mail merge options.
Namespace : DevExpress.XtraRichEdit.API.Native
Assembly : DevExpress.RichEdit.v25.2.Core.dll
NuGet Package : DevExpress.RichEdit.Core
MailMergeOptions CreateMailMergeOptions()
Function CreateMailMergeOptions As MailMergeOptions
| Type | Description |
|---|---|
| MailMergeOptions |
A MailMergeOptions instance, specifying the mail merge options.
|
The default mail merge options are specified via the RichEditControlOptionsBase.MailMerge property.
To modify mail merge options, create a MailMergeOptions object (by calling the CreateMailMergeOptions method), and pass the modified options as a parameter to the Document.MailMerge method.
For more information, refer to Mail Merge.
The following code snippets (auto-collected from DevExpress Examples) contain references to the CreateMailMergeOptions() 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#L26
{
MailMergeOptions myMergeOptions = richEditControl1.Document.CreateMailMergeOptions();
myMergeOptions.FirstRecordIndex = 1;
winforms-richedit-use-images-in-mail-merge/CS/Form1.cs#L42
{
MailMergeOptions options = richEditControl1.Document.CreateMailMergeOptions();
options.MergeMode = MergeMode.NewSection;
winforms-richedit-use-calculatedocumentvariable-event-to-insert-formatted-content/CS/Form1.cs#L32
private void button2_Click(object sender, EventArgs e) {
MailMergeOptions myMergeOptions = richEditControl1.Document.CreateMailMergeOptions();
myMergeOptions.MergeMode = MergeMode.NewParagraph;
how-to-use-docvariable-fields/CS/DocumentVariablesExample/Form1.cs#L35
private void btnMailMerge_Click(object sender, EventArgs e) {
MailMergeOptions myMergeOptions = richEditControl1.Document.CreateMailMergeOptions();
myMergeOptions.MergeMode = MergeMode.NewSection;
word-document-api-use-docvariable-fields/CS/Program.cs#L28
// Adjust mail-merge options
MailMergeOptions myMergeOptions = document.CreateMailMergeOptions();
myMergeOptions.MergeMode = MergeMode.NewSection;
winforms-richedit-control-mail-merge/VB/MailMerge/Form1.vb#L23
Private Sub mergeToNewDocumentItem_ItemClick(ByVal sender As Object, ByVal e As ItemClickEventArgs) Handles mergeToNewDocumentItem.ItemClick
Dim myMergeOptions As MailMergeOptions = richEditControl1.Document.CreateMailMergeOptions()
myMergeOptions.FirstRecordIndex = 1
winforms-richedit-use-images-in-mail-merge/VB/Form1.vb#L35
Private Sub MergeToNewDocument()
Dim options As MailMergeOptions = richEditControl1.Document.CreateMailMergeOptions()
options.MergeMode = MergeMode.NewSection
winforms-richedit-use-calculatedocumentvariable-event-to-insert-formatted-content/VB/Form1.vb#L26
Private Sub button2_Click(ByVal sender As Object, ByVal e As EventArgs)
Dim myMergeOptions As MailMergeOptions = richEditControl1.Document.CreateMailMergeOptions()
myMergeOptions.MergeMode = MergeMode.NewParagraph
how-to-use-docvariable-fields/VB/DocumentVariablesExample/Form1.vb#L35
Private Sub btnMailMerge_Click(ByVal sender As Object, ByVal e As EventArgs)
Dim myMergeOptions As MailMergeOptions = richEditControl1.Document.CreateMailMergeOptions()
myMergeOptions.MergeMode = MergeMode.NewSection
word-document-api-use-docvariable-fields/VB/Program.vb#L22
' Adjust mail-merge options
Dim myMergeOptions As MailMergeOptions = document.CreateMailMergeOptions()
myMergeOptions.MergeMode = MergeMode.NewSection
See Also