officefileapi-devexpress-dot-xtrarichedit-dot-richeditdocumentserver-b32b9e1f.md
Fires after each data record is merged with the document in the mail merge process.
Namespace : DevExpress.XtraRichEdit
Assembly : DevExpress.RichEdit.v25.2.Core.dll
NuGet Package : DevExpress.RichEdit.Core
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 (auto-collected from DevExpress Examples) contains a reference to the MailMergeRecordFinished 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.
word-document-api-use-docvariable-fields/CS/Program.cs#L34
wordProcessor.MailMergeRecordStarted += wordProcessor_MailMergeRecordStarted;
wordProcessor.MailMergeRecordFinished += wordProcessor_MailMergeRecordFinished;
word-document-api-use-docvariable-fields/VB/Program.vb#L28
AddHandler wordProcessor.MailMergeRecordStarted, AddressOf wordProcessor_MailMergeRecordStarted
AddHandler wordProcessor.MailMergeRecordFinished, AddressOf wordProcessor_MailMergeRecordFinished
See Also