Back to Devexpress

RichEditDocumentServer.CreateMailMergeOptions() Method

officefileapi-devexpress-dot-xtrarichedit-dot-richeditdocumentserver-78393a90.md

latest4.2 KB
Original Source

RichEditDocumentServer.CreateMailMergeOptions() Method

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

Namespace : DevExpress.XtraRichEdit

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

NuGet Package : DevExpress.RichEdit.Core

Declaration

csharp
public MailMergeOptions CreateMailMergeOptions()
vb
Public Function CreateMailMergeOptions As MailMergeOptions

Returns

TypeDescription
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.

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.

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

csharp
// 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

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

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

vb
' 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

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

Implements

CreateMailMergeOptions()

See Also

MailMerge

RichEditDocumentServer Class

RichEditDocumentServer Members

DevExpress.XtraRichEdit Namespace