[Expand]General Information
[Expand]WinForms Controls
[Expand]ASP.NET Controls and MVC Extensions
[Expand]ASP.NET Bootstrap Controls
[Expand]ASP.NET Core Bootstrap Controls
[Collapse]WPF Controls
 [Expand]What's Installed
 [Expand]Common Concepts
 [Expand]MVVM Framework
 [Collapse]Controls and Libraries
  [Expand]Data Grid
  [Expand]Ribbon, Bars and Menu
  [Expand]Charts Suite
  [Expand]Pivot Grid
  [Collapse]Rich Text Editor
   [Expand]Product Information
    Product Class Structure
    Supported Formats
   [Expand]Getting Started
   [Expand]RichEditControl Document
    Text Formatting
    Import and Export
   [Expand]Page Layout
    Mail Merge
    Restrictions and Protection
    Syntax Highlighting
   [Expand]Visual Elements
    HTML Tag Support
  [Expand]Tree List
  [Expand]Gauge Controls
  [Expand]Map Control
  [Expand]Layout Management
  [Expand]Windows Modern UI
  [Expand]Data Editors
  [Expand]Navigation Controls
  [Expand]Spell Checker
  [Expand]Property Grid
  [Expand]PDF Viewer
  [Expand]TreeMap Control
  [Expand]Gantt Control
  [Expand]Diagram Control
  [Expand]Windows and Utility Controls
   Dialogs, Notifications and Panels
  [Expand]Scheduler (legacy)
 [Expand]Scaffolding Wizard
  Redistribution and Deployment
  Get More Help
 [Expand]API Reference
[Expand]Xamarin Controls
[Expand]Windows 10 App Controls
[Expand]Office File API
[Expand]Report and Dashboard Server
[Expand]eXpressApp Framework
[Expand]eXpress Persistent Objects
[Expand]CodeRush Classic
[Expand]Cross-Platform Core Libraries
[Expand]Tools and Utilities
 End-User Documentation
View this topic on docs.devexpress.com (Learn more)

Mail Merge

Perform the following steps to create the mail merge document:

  1. Provide a Data Source
  2. Load a Document Template
  3. Merge and Save the Document

Expanded Provide a Data Source

Use the DXRichEditMailMergeOptions.DataSource property to set the data source to use in a mail merge. If the data source contains multiple data tables, use the DXRichEditMailMergeOptions.DataMember property to define a specific data member. RichEditCotnrol supports the following data source types:

  • System.Collections.IList;
  • System.Collections.ArrayList;
  • System.Data.DataTable.

Expanded Load a Document Template

Call the LoadDocument (see RichEditControl.LoadDocument) or LoadDocumentTemplate (see RichEditControl.LoadDocumentTemplate) method to load a template. The template is a document containing fields, which refer to a specified data source's data column names. Call the FieldCollection.Create method to insert the desired field to the given document position in code. Depending on the content to be inserted, use one of the following fields:

  • MERGEFIELD - to insert plain text;
  • DOCVARIABLE - to insert formatted content;
  • INCLUDEPICTURE - to insert images. Use the INCLUDEPICTURE field as follows: {INCLUDEPICTURE "{MERGEFIELD PictureLocation}" \d}, where PictureLocation is the path to the desired picture. Make sure that images have the same name as the field's contents in the database (for example, as the "FirstName" field) if the template requires mail merging different images, and insert the INCLUDEPICTURE as follows: { INCLUDEPICTURE "PicturesLocation{ MERGEFIELD FieldName }.jpg” *MERGEFORMAT \d }.


    Use the IUriStreamProvider to insert pictures from a data base.

Expanded Merge and Save the Document

Use the following API to set additional merging options (the number of records, merged ranges delimitation, etc.) and merge the document:

API Description
RichEditControlOptionsBase.MailMerge Provides access to the default mail merge options.
Document.CreateMailMergeOptions Initializes an MailMergeOptions instance, which contains additional mail merge options.
MailMergeOptions.FirstRecordIndex Gets or sets the record index from which the merge starts.
MailMergeOptions.LastRecordIndex Gets or sets the record index at which the merge finishes.
MailMergeOptions.MergeMode Gets or sets how the merged ranges are delimited in the resulting document.
Document.MailMerge Merges the current document using the specified options, and sends the result to the specified document.

After the mail merge is finished, you can send the document to further processing to another RichEditControl (as shown in the code below) or RichEditDocumentServer instance, or save it to the file.

The following code uses records 1 to 3 to perform a mail merge. Each record is merged into a new section in a merged document. The target document is created in another RichEditControl (richEditControl2).


You can export each merged record to a new PDF file. Refer to the E4308 example for details.

Mail Merge Events

Additionally, the RichEditControl provides the following events allowing you to control specific mail merging steps:

Event Description
RichEditControl.CustomizeMergeFields Fires when the 'Insert Merge Field' command button is clicked, and enables you to customize a drop-down field list.
RichEditControl.MailMergeStarted Fires before mail merge starts.
RichEditControl.MailMergeFinished Fires when mail merge is completed.
RichEditControl.MailMergeRecordStarted Fires before each data record is merged with the document in the mail merge process.
RichEditControl.MailMergeRecordFinished Fires after each data record is merged with the document in the mail merge process.

Expanded Mail Merging Functionality in the User Interface

The RichEditControl provides the Mail Merge , which allows end-users to insert merge fields, toggle field codes and results and view the merged data. Refer to the Lesson 1 - Create a Simple Rich Text Editor topic for details on how to provide the ribbon UI for the RichEditControl.

Expanded See Also

Is this topic helpful?​​​​​​​