RichEditControl.MailMergeRecordFinished Event
In This Article
Fires after each data record is merged with the document in the mail merge process.
Namespace: DevExpress.XtraRichEdit
Assembly: DevExpress.XtraRichEdit.v24.2.dll
NuGet Package: DevExpress.Win.RichEdit
#Declaration
public event MailMergeRecordFinishedEventHandler MailMergeRecordFinished
#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 Cancel |
Document | Gets a merged document. |
Record |
Gets a template document after a record is merged. |
Record |
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.
private void richEditControl1_MailMergeRecordFinished(object sender, MailMergeRecordFinishedEventArgs e) {
e.RecordDocument.AppendDocumentContent("Docs\\bungalow.docx", DocumentFormat.OpenXml);
}
See Also