RichEditControlOptionsBase.MailMerge Property

Provides access to the default mail merge options.

Namespace: DevExpress.XtraRichEdit

Assembly: DevExpress.RichEdit.v19.1.Core.dll

Declaration

C#

public RichEditMailMergeOptions MailMerge { get; }

VB.NET

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
	RichEditControl	.Options.MailMerge
WPF Controls	RichEditControl	.Options.MailMerge
Office File API	IRichEditDocumentServer	.Options.MailMerge
	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.

Related GitHub Examples

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#

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

    richEditControl1.LoadDocument("Docs\\invitation.docx");
    richEditControl1.Options.MailMerge.DataSource = new SampleData();
}

how-to-use-document-variable-docvariable-fields-e3099/CS/DocumentVariablesExample/Form1.cs#L20

richEditControl1.Options.MailMerge.DataSource = new SampleData();
richEditControl2.Document.CalculateDocumentVariable += new CalculateDocumentVariableEventHandler(eventHandler_CalculateDocumentVariable);

VB.NET

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

    richEditControl1.LoadDocument("Docs\invitation.docx")
    richEditControl1.Options.MailMerge.DataSource = New SampleData()
End Sub

how-to-use-document-variable-docvariable-fields-e3099/VB/DocumentVariablesExample/Form1.vb#L22

richEditControl1.Options.MailMerge.DataSource = New SampleData()
AddHandler richEditControl2.Document.CalculateDocumentVariable, AddressOf eventHandler_CalculateDocumentVariable