RichEditControlOptionsBase.MailMerge Property

Provides access to the default mail merge options.

Namespace: DevExpress.XtraRichEdit

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

NuGet Packages: DevExpress.RichEdit.Core, DevExpress.Win.Navigation

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:

Object Type	Path to MailMerge
IRichEditDocumentServer	.Options .MailMerge
RichEditDocumentServer	.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 snippet (auto-collected from DevExpress Examples) contains a reference 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#

winforms-richedit-customize-insert-merge-field-menu/CS/CustomInsertMergeFieldItem.cs#L66

private void PopulatePopupMenu() {
    RichEditMailMergeOptions mailMergeOptions = RichEditControl.Options.MailMerge;
    DataBindingController mergeFieldsController = new DataBindingController(mailMergeOptions.DataSource, mailMergeOptions.DataMember);

VB.NET

winforms-richedit-customize-insert-merge-field-menu/VB/CustomInsertMergeFieldItem.vb#L118

Private Sub PopulatePopupMenu()
    Dim mailMergeOptions As RichEditMailMergeOptions = RichEditControl.Options.MailMerge
    Dim mergeFieldsController As DataBindingController = New DataBindingController(mailMergeOptions.DataSource, mailMergeOptions.DataMember)