RichEditControl.MailMergeStarted Event
Fires before mail merge starts.
Namespace: DevExpress.XtraRichEdit
Assembly: DevExpress.XtraRichEdit.v20.2.dll
NuGet Package: DevExpress.Win.RichEdit
Declaration
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 progress indicator on the form.
using DevExpress.XtraRichEdit;
using DevExpress.XtraRichEdit.API.Native;
using DevExpress.Services;
private void richEditControl1_MailMergeStarted(object sender, MailMergeStartedEventArgs e) {
richEditControl1.RemoveService(typeof(IProgressIndicationService));
richEditControl1.AddService(typeof(IProgressIndicationService),
new MyProgressIndicatorService(richEditControl1, this.progressBarControl1));
}
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.