MailMergeOptions.MergeMode Property

Gets or sets how the merged ranges are delimited in the resulting document.

Namespace: DevExpress.XtraRichEdit.API.Native

Assembly: DevExpress.RichEdit.v22.2.Core.dll

NuGet Package: DevExpress.RichEdit.Core

Declaration

C#

MergeMode MergeMode { get; set; }

VB.NET

Property MergeMode As MergeMode

Property Value

Type	Description
MergeMode	An enumeration value that indicates the delimiter.

Available values:

Name	Description
NewParagraph	Specifies that the next merged range starts with a new paragraph.
NewSection	Specifies that the next merged range starts with a new section. The section break type is obtained from the previous section break or set to the NextPageby default. For headers and footers, it is the only allowed option.
JoinTables	Enables you to join rows, which result from a mail merge involving a table with merged fields, into a whole table.

Remarks

If a merge field is located in a document’s header or footer, the MergeMode should be set to MergeMode.NewSection for proper operation.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the MergeMode property.

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#

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

myMergeOptions.LastRecordIndex = 3;
myMergeOptions.MergeMode = MergeMode.NewSection;
richEditControl1.Document.MailMerge(myMergeOptions, richEditControl2.Document);

master-detail-mail-merge-essential-the-simplest-implementation-e3662/CS/Form1.cs#L23

MailMergeOptions mailMergeOptions = richEditCategoryTemplate.CreateMailMergeOptions();
mailMergeOptions.MergeMode = MergeMode.NewParagraph;

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

MailMergeOptions options = richEditControl1.Document.CreateMailMergeOptions();
options.MergeMode = MergeMode.NewSection;
frmResultingDocument form = new frmResultingDocument();

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

MailMergeOptions myMergeOptions = richEditControl1.Document.CreateMailMergeOptions();
myMergeOptions.MergeMode = MergeMode.NewSection;
richEditControl1.Document.MailMerge(myMergeOptions, richEditControl2.Document);

dxrichedit-for-wpf-how-to-use-document-variable-docvariable-fields-e3282/CS/MainWindow.xaml.cs#L34

MailMergeOptions myMergeOptions = richEditControl1.Document.CreateMailMergeOptions();
myMergeOptions.MergeMode = MergeMode.NewSection;
richEditControl1.Document.MailMerge(myMergeOptions, richEditControl2.Document);

VB.NET

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

myMergeOptions.LastRecordIndex = 3
myMergeOptions.MergeMode = MergeMode.NewSection
richEditControl1.Document.MailMerge(myMergeOptions, richEditControl2.Document)

master-detail-mail-merge-essential-the-simplest-implementation-e3662/VB/Form1.vb#L25

Dim mailMergeOptions As MailMergeOptions = richEditCategoryTemplate.CreateMailMergeOptions()
mailMergeOptions.MergeMode = MergeMode.NewParagraph

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

Dim options As MailMergeOptions = richEditControl1.Document.CreateMailMergeOptions()
options.MergeMode = MergeMode.NewSection
Dim form As New frmResultingDocument()

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

Dim myMergeOptions As MailMergeOptions = richEditControl1.Document.CreateMailMergeOptions()
myMergeOptions.MergeMode = MergeMode.NewSection
richEditControl1.Document.MailMerge(myMergeOptions, richEditControl2.Document)

dxrichedit-for-wpf-how-to-use-document-variable-docvariable-fields-e3282/VB/MainWindow.xaml.vb#L35

Dim myMergeOptions As MailMergeOptions = Me.richEditControl1.Document.CreateMailMergeOptions()
myMergeOptions.MergeMode = MergeMode.NewSection
Me.richEditControl1.Document.MailMerge(myMergeOptions, Me.richEditControl2.Document)