RichEditDocumentServer.CreateMailMergeOptions() Method

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

Namespace: DevExpress.XtraRichEdit

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

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

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

To specify options for a particular merge operation, create a MailMergeOptions object using the CreateMailMergeOptions method, change options as required and perform a merge using the RichEditDocumentServer.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#

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

// Specify data source for mail merge.
MailMergeOptions options = productRichEdit.CreateMailMergeOptions();
options.DataSource = dataDetailedForProducts;

word-document-api-use-multiple-data-sources-for-mail-merge/CS/MailMergeSample/Default.aspx.cs#L34

Stream result = new MemoryStream();
MailMergeOptions mailMergeOptions = documentServer.CreateMailMergeOptions();

VB.NET

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

' Specify data source for mail merge.
Dim options As MailMergeOptions = productRichEdit.CreateMailMergeOptions()
options.DataSource = dataDetailedForProducts

word-document-api-use-multiple-data-sources-for-mail-merge/VB/MailMergeSample/Default.aspx.vb#L32

Dim result As Stream = New MemoryStream()
Dim mailMergeOptions As MailMergeOptions = documentServer.CreateMailMergeOptions()
If Equals(templateName, "preview1") Then

Implements

CreateMailMergeOptions()