RichEditControl.CreateMailMergeOptions() Method

Creates an object for specifying the options used in mail merge operations.

Namespace: DevExpress.XtraRichEdit

Assembly: DevExpress.XtraRichEdit.v23.2.dll

NuGet Packages: DevExpress.Win.PivotGrid, DevExpress.Win.RichEdit, DevExpress.Win.TreeMap

Declaration

C#

public MailMergeOptions CreateMailMergeOptions()

VB.NET

Public Function CreateMailMergeOptions As MailMergeOptions

Returns

Type	Description
MailMergeOptions	A MailMergeOptions class instance containing options used for mail merge.

Remarks

Default options used in mail merge operations are specified via the RichEditControl.Options.MailMerge property. If options should be modified for particular merges only, you can create a MailMergeOptions object using the CreateMailMergeOptions method, change options as required, and perform a merge using the RichEditControl.MailMerge method, which gets the MailMergeOptions as the parameter.

Related GitHub Examples

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

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-master-detail-mail-merge-essentials/CS/Form1.cs#L22

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

winforms-richedit-create-a-master-detail-report/CS/RichEditMasterDetailMailMerge/Form1.cs#L88

//Set additional mail merge options if necessary:
MailMergeOptions options = masterRichEdit.CreateMailMergeOptions();
options.LastRecordIndex = 4;

VB.NET

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

richEditCategoryTemplate.Options.MailMerge.DataSource = Categories
Dim mailMergeOptions As MailMergeOptions = richEditCategoryTemplate.CreateMailMergeOptions()
mailMergeOptions.MergeMode = MergeMode.NewParagraph

winforms-richedit-create-a-master-detail-report/VB/RichEditMasterDetailMailMerge/Form1.vb#L82

'Set additional mail merge options if necessary:
Dim options As MailMergeOptions = masterRichEdit.CreateMailMergeOptions()
options.LastRecordIndex = 4