MailMergeOptions.MergeMode Property

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

Namespace: DevExpress.XtraRichEdit.API.Native

Assembly: DevExpress.RichEdit.v24.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#

mail-merge-in-a-richeditcontrol/CS/MailMerge/Form1.cs#L29

myMergeOptions.LastRecordIndex = 3;
myMergeOptions.MergeMode = MergeMode.NewSection;

word-document-api-create-master-detail-report/CS/MasterDetailExample/MergeProcessor.cs#L108

// Do not specify this option if calculated fields are not within table cells.
options.MergeMode = MergeMode.JoinTables;
// Provide a procedure for further processing.

winforms-richedit-master-detail-mail-merge-essentials/CS/Form1.cs#L23

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

how-to-use-images-in-richedit-mail-merge/CS/Form1.cs#L44

MailMergeOptions options = richEditControl1.Document.CreateMailMergeOptions();
options.MergeMode = MergeMode.NewSection;
string fileName = System.IO.Directory.GetCurrentDirectory() + @"\..\..\MailMergeResult.rtf";

winforms-richedit-use-calculatedocumentvariable-event-to-insert-formatted-content/CS/Form1.cs#L34

MailMergeOptions myMergeOptions = richEditControl1.Document.CreateMailMergeOptions();
myMergeOptions.MergeMode = MergeMode.NewParagraph;

VB.NET

mail-merge-in-a-richeditcontrol/VB/MailMerge/Form1.vb#L26

myMergeOptions.LastRecordIndex = 3
myMergeOptions.MergeMode = MergeMode.NewSection

word-document-api-create-master-detail-report/VB/MasterDetailExample/MergeProcessor.vb#L101

' Do not specify this option if calculated fields are not within table cells.
options.MergeMode = MergeMode.JoinTables
' Provide a procedure for further processing.

winforms-richedit-master-detail-mail-merge-essentials/VB/Form1.vb#L22

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

how-to-use-images-in-richedit-mail-merge/VB/Form1.vb#L36

Dim options As MailMergeOptions = richEditControl1.Document.CreateMailMergeOptions()
options.MergeMode = MergeMode.NewSection
Dim fileName As String = System.IO.Directory.GetCurrentDirectory() & "\..\..\MailMergeResult.rtf"

winforms-richedit-use-calculatedocumentvariable-event-to-insert-formatted-content/VB/Form1.vb#L27

Dim myMergeOptions As MailMergeOptions = richEditControl1.Document.CreateMailMergeOptions()
myMergeOptions.MergeMode = MergeMode.NewParagraph
Dim server As RichEditDocumentServer = New RichEditDocumentServer()