RichEditDocumentServer.MailMerge(MailMergeOptions, String, DocumentFormat) Method

SECURITY-RELATED CONSIDERATIONS

Using file paths sourced from untrusted input may expose unauthorized files or allow unintended file access. Always validate and normalize all external paths to prevent path manipulation.

Merges data to the current document and saves the result to a file in the specified format. Allows you to set mail merge options.

Namespace : DevExpress.XtraRichEdit

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

NuGet Package : DevExpress.RichEdit.Core

Declaration

• C#
• VB.NET

public void MailMerge(
    MailMergeOptions options,
    string fileName,
    DocumentFormat format
)

Public Sub MailMerge(
    options As MailMergeOptions,
    fileName As String,
    format As DocumentFormat
)

Parameters

An object that contains options for the current merge.

| | fileName | String |

A name of the file to which the merged document is saved.

| | format | DocumentFormat |

An enumeration member that indicates the destination format.

|

Remarks

The MailMerge method merges the current document with records retrieved from the MailMergeOptions.DataSource property specified by the options parameter, and saves the merged document to a file.

The MailMerge method results in the CalculateDocumentVariable event being fired for the RichEditDocumentServer object.

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the MailMerge(MailMergeOptions, String, DocumentFormat) 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/Program.cs#L55

var outputPath = Path.Combine(Environment.CurrentDirectory, "result.docx");
wordProcessor.MailMerge(myMergeOptions, outputPath, DocumentFormat.OpenXml);

Implements

MailMerge(MailMergeOptions, String, DocumentFormat)

See Also

RichEditDocumentServer Class

RichEditDocumentServer Members

DevExpress.XtraRichEdit Namespace