RichEditControl.MailMergeRecordFinished Event

Fires after each data record is merged with the document in the mail merge process.

Namespace: DevExpress.XtraRichEdit

Assembly: DevExpress.XtraRichEdit.v23.2.dll

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

Declaration

C#

public event MailMergeRecordFinishedEventHandler MailMergeRecordFinished

VB.NET

Public Event MailMergeRecordFinished As MailMergeRecordFinishedEventHandler

Event Data

The MailMergeRecordFinished event's data class is MailMergeRecordFinishedEventArgs. 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.
RecordDocument	Gets a template document after a record is merged.
RecordIndex	Gets an index of a record currently merged.

Remarks

The MailMergeRecordFinished event can be used to post-process the merged section of a document that corresponds to a particular record. The following code snippet demonstrates that, after each record is merged, a custom footer is appended.

View Example

Form1.cs

private void richEditControl1_MailMergeRecordFinished(object sender, MailMergeRecordFinishedEventArgs e) {
    e.RecordDocument.AppendDocumentContent("Docs\\bungalow.docx", DocumentFormat.OpenXml);
}

Form1.vb

Private Sub richEditControl1_MailMergeRecordFinished(ByVal sender As Object, ByVal e As MailMergeRecordFinishedEventArgs) Handles richEditControl1.MailMergeRecordFinished
    e.RecordDocument.AppendDocumentContent("Docs\bungalow.docx", DocumentFormat.OpenXml)
End Sub