RichEditControl.MailMergeStarted Event

Fires before mail merge starts.

Namespace: DevExpress.Xpf.RichEdit

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

Declaration

C#

public event MailMergeStartedEventHandler MailMergeStarted

VB.NET

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.

Note

A complete sample project is available at https://github.com/DevExpress-Examples/dxrichedit-for-wpf-how-to-use-document-variable-docvariable-fields-e3282.

MainWindow.xaml.cs

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));
        }

MainWindow.xaml.vb

Imports DevExpress.Services
Imports System.Drawing
        Private Sub richEditControl1_MailMergeStarted(ByVal sender As Object, ByVal e As MailMergeStartedEventArgs)
            richEditControl1.RemoveService(GetType(IProgressIndicationService))
            richEditControl1.AddService(GetType(IProgressIndicationService), New MyProgressIndicatorService(richEditControl1, Me.progressBarControl1))
        End Sub

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the MailMergeStarted event.

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#

dxrichedit-for-wpf-how-to-implement-progress-indicator-for-slow-richeditcontrol-operations-e3293/CS/MainWindow.xaml#L19

<dx:DXTabItem Header="Template">
    <dxre:RichEditControl Name="richEditControl1" Loaded="richEditControl1_Loaded" MailMergeStarted="richEditControl1_MailMergeStarted" MailMergeFinished="richEditControl1_MailMergeFinished" MailMergeRecordStarted="richEditControl1_MailMergeRecordStarted" MailMergeRecordFinished="richEditControl1_MailMergeRecordFinished" />
</dx:DXTabItem>

dxrichedit-for-wpf-how-to-use-document-variable-docvariable-fields-e3282/CS/MainWindow.xaml#L23

<dx:DXTabItem Header="Template">
    <dxre:RichEditControl Name="richEditControl1" Loaded="richEditControl1_Loaded" MailMergeStarted="richEditControl1_MailMergeStarted" MailMergeFinished="richEditControl1_MailMergeFinished" MailMergeRecordStarted="richEditControl1_MailMergeRecordStarted" MailMergeRecordFinished="richEditControl1_MailMergeRecordFinished" />
</dx:DXTabItem>