windowsforms-devexpress-dot-xtrarichedit-dot-richeditcontrol-8b67068b.md
Fires after each data record is merged with the document in the mail merge process.
Namespace : DevExpress.XtraRichEdit
Assembly : DevExpress.XtraRichEdit.v25.2.dll
NuGet Package : DevExpress.Win.RichEdit
public event MailMergeRecordFinishedEventHandler MailMergeRecordFinished
Public Event MailMergeRecordFinished As MailMergeRecordFinishedEventHandler
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. |
| MailMergeRegionInfo | Obtains information on the currently merged region. |
| RecordDocument | Gets a template document after a record is merged. |
| RecordIndex | Gets an index of a record currently merged. |
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.
private void richEditControl1_MailMergeRecordFinished(object sender, MailMergeRecordFinishedEventArgs e) {
e.RecordDocument.AppendDocumentContent("Docs\\bungalow.docx", DocumentFormat.Docx);
}
Private Sub richEditControl1_MailMergeRecordFinished(ByVal sender As Object, ByVal e As MailMergeRecordFinishedEventArgs) Handles richEditControl1.MailMergeRecordFinished
e.RecordDocument.AppendDocumentContent("Docs\bungalow.docx", DocumentFormat.Docx)
End Sub
See Also