Skip to main content

RichEditControl.MailMergeStarted Event

Fires before mail merge starts.

Namespace: DevExpress.XtraRichEdit

Assembly: DevExpress.XtraRichEdit.v24.1.dll

NuGet Packages: DevExpress.Win.PivotGrid, DevExpress.Win.RichEdit, DevExpress.Win.TreeMap


public event MailMergeStartedEventHandler MailMergeStarted

Event Data

The MailMergeStarted event's data class is MailMergeStartedEventArgs. The following properties provide information specific to this event:

Property Description
Cancel Gets or sets a value indicating whether the event should be canceled. Inherited from CancelEventArgs.
Document Gets a merged document.
OperationDescription Specifies the text displayed by the progress indicator while the document is being rendered.


You can handle this event to inform a user that a mail merge has started, since this process can be time consuming. The following code snippet shows that the MailMergeStarted event is used to register a custom service for updating progress indicator on the form.

View Example

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

private void richEditControl1_MailMergeStarted(object sender, MailMergeStartedEventArgs e) {
        new MyProgressIndicatorService(richEditControl1, this.progressBarControl1));
See Also