RichEditControlOptionsBase.MailMerge Property

Provides access to the default mail merge options.

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

Declaration

C#
VB.NET

public RichEditMailMergeOptions MailMerge { get; }

Public ReadOnly Property MailMerge As RichEditMailMergeOptions

Property Value

Type	Description
RichEditMailMergeOptions	A RichEditMailMergeOptions object containing default mail merge options.

Property Paths

You can access this nested property as listed below:

Library	Object Type	Path to MailMerge
WinForms Controls	SnapControl	.Options.MailMerge
WinForms Controls	RichEditControl	.Options.MailMerge
WPF Controls	RichEditControl	.Options.MailMerge
Office File API	IRichEditDocumentServer	.Options.MailMerge
Office File API	RichEditDocumentServer	.Options.MailMerge
Reporting	SyntaxEditor	.Options.MailMerge

Remarks

The settings specified via the MailMerge property are used by the Document.MailMerge method, unless specified explicitly in the options parameter.

To perform a specific mail merge with options different from those set via the MailMerge, create a new MailMergeOptions instance using the Document.CreateMailMergeOptions method, specify its property values as required, and call the Document.MailMerge method overload with options.

The following code snippets (auto-collected from DevExpress Examples) contain references to the MailMerge 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#
VB.NET

how-to-create-a-master-detail-report-e4718/CS/MasterDetailExample/MergeProcessor.cs#L40

suppllierRichEdit.LoadDocument("supplier.rtf");
suppllierRichEdit.Options.MailMerge.DataSource = ds;

how-to-export-each-record-into-a-new-pdf-file-during-the-mailmerge-operation-e4308/CS/MailMergeEachRecordSeparatePDF/Form1.cs#L20

dataNavigator1.DataSource = datasource;
richEditControl1.Options.MailMerge.DataSource = datasource;
richEditControl1.Options.MailMerge.ViewMergedData = true;

utility-for-creating-a-mail-merge-template-e3661/CS/Form1.cs#L60

    CreateDefaultData(dataTable);
    richEditControl1.Options.MailMerge.DataSource = dataTable;
}

how-to-create-a-master-detail-report-in-a-richeditcontrol-e3331/CS/RichEditMasterDetailMailMerge/Form1.cs#L62

//so provide it with a mock data.
mainRichEdit.Options.MailMerge.DataSource = CreateFakeDataSource();

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

dynamic weathers = GetExpandoFromXml("weather.xml");
richEditControl1.Options.MailMerge.DataSource = weathers;

how-to-create-a-master-detail-report-e4718/VB/MasterDetailExample/MergeProcessor.vb#L38

suppllierRichEdit.LoadDocument("supplier.rtf")
suppllierRichEdit.Options.MailMerge.DataSource = ds

how-to-export-each-record-into-a-new-pdf-file-during-the-mailmerge-operation-e4308/VB/MailMergeEachRecordSeparatePDF/Form1.vb#L22

dataNavigator1.DataSource = datasource
richEditControl1.Options.MailMerge.DataSource = datasource
richEditControl1.Options.MailMerge.ViewMergedData = True

utility-for-creating-a-mail-merge-template-e3661/VB/Form1.vb#L62

    CreateDefaultData(dataTable)
    richEditControl1.Options.MailMerge.DataSource = dataTable
End Sub

how-to-create-a-master-detail-report-in-a-richeditcontrol-e3331/VB/RichEditMasterDetailMailMerge/Form1.vb#L58

'so provide it with a mock data:
mainRichEdit.Options.MailMerge.DataSource = CreateFakeDataSource()

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

Dim weathers As Object = GetExpandoFromXml("weather.xml")
richEditControl1.Options.MailMerge.DataSource = weathers

.NET Subscription

Common Tools

Controls

Tools

Controls and Extensions

Tools

Maintenance Mode

.NET Subscription

Common Tools

Controls

Tools

Controls and Extensions

Tools

Maintenance Mode

RichEditControlOptionsBase.MailMerge Property

Declaration

Property Value

Property Paths

Remarks

RichEditControlOptionsBase.MailMerge Property

Declaration

Property Value

Property Paths

Remarks

Related GitHub Examples