RichEditControl.MailMergeStarted Event

Fires before mail merge starts.

Namespace: DevExpress.Xpf.RichEdit

Assembly: DevExpress.Xpf.RichEdit.v20.1.dll

Declaration

public event MailMergeStartedEventHandler MailMergeStarted
Public Event MailMergeStarted As MailMergeStartedEventHandler

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.

Remarks

You can handle this event to inform the end-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 a progress indicator on the form.

using DevExpress.Services;
using System.Drawing;
        private void richEditControl1_MailMergeStarted(object sender, MailMergeStartedEventArgs e) {
            richEditControl1.RemoveService(typeof(IProgressIndicationService));
            richEditControl1.AddService(typeof(IProgressIndicationService),
                new MyProgressIndicatorService(richEditControl1, this.progressBarControl1));
        }

Implements

See Also