MailMergeOptions Interface

Defines mail merge options for a specific merge process.

Namespace: DevExpress.XtraRichEdit.API.Native

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

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

Declaration

C#

[ComVisible(true)]
public interface MailMergeOptions

VB.NET

<ComVisible(True)>
Public Interface MailMergeOptions

Related API Members

The following members return MailMergeOptions objects:

Library	Related API Members
WinForms Controls	RichEditControl.CreateMailMergeOptions()
WPF Controls	RichEditControl.CreateMailMergeOptions()
Office File API	Document.CreateMailMergeOptions()
	IRichEditDocumentServer.CreateMailMergeOptions()
	RichEditDocumentServer.CreateMailMergeOptions()
ASP.NET Web Forms Controls	ASPxRichEdit.CreateMailMergeOptions()
ASP.NET MVC Extensions	RichEditExtension.CreateMailMergeOptions()

Remarks

To customize mail merge options, pass the MailMergeOptions instance as a parameter to the MailMerge method.

Common mail merge options are specified by the RichEditMailMergeOptions class.

Example

The code sample below specifies mail merge options, runs the mail merge, and saves the document to the specified file.

C#

using DevExpress.Office.Services;
using DevExpress.XtraRichEdit;
using DevExpress.XtraRichEdit.API.Native;

using (var wordProcessor = new RichEditDocumentServer())
{
    //...
    wordProcessor.CalculateDocumentVariable += WordProcessor_CalculateDocumentVariable;

    // Register the URI provider service
    IUriStreamService uriStreamService = wordProcessor.GetService<IUriStreamService>();
    uriStreamService.RegisterProvider(new ImageStreamProvider(xmlDataSet.Tables[0], "Photo"));

    MailMergeOptions myMergeOptions =
        wordProcessor.Document.CreateMailMergeOptions();
    myMergeOptions.DataSource = xmlDataSet.Tables[0];
    myMergeOptions.MergeMode = MergeMode.NewSection;

    wordProcessor.MailMerge(myMergeOptions, "result.docx", DocumentFormat.OpenXml);
}

VB.NET

Imports DevExpress.Office.Services
Imports DevExpress.XtraRichEdit
Imports DevExpress.XtraRichEdit.API.Native

Using wordProcessor = New RichEditDocumentServer()
    '...
    wordProcessor.CalculateDocumentVariable += WordProcessor_CalculateDocumentVariable

    Dim uriStreamService As IUriStreamService = wordProcessor.GetService(Of IUriStreamService)()
    uriStreamService.RegisterProvider(New ImageStreamProvider(xmlDataSet.Tables(0), "Photo"))

    Dim myMergeOptions As MailMergeOptions = wordProcessor.Document.CreateMailMergeOptions()
    myMergeOptions.DataSource = xmlDataSet.Tables(0)
    myMergeOptions.MergeMode = MergeMode.NewSection

    wordProcessor.MailMerge(myMergeOptions, "result.docx", DocumentFormat.OpenXml)
End Using