Back to Devexpress

IRichEditDocumentServer.MailMergeRecordStarted Event

officefileapi-devexpress-dot-xtrarichedit-dot-iricheditdocumentserver-92991034.md

latest2.4 KB
Original Source

IRichEditDocumentServer.MailMergeRecordStarted Event

Fires before 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

Declaration

csharp
event MailMergeRecordStartedEventHandler MailMergeRecordStarted
vb
Event MailMergeRecordStarted As MailMergeRecordStartedEventHandler

Event Data

The MailMergeRecordStarted event's data class is MailMergeRecordStartedEventArgs. The following properties provide information specific to this event:

PropertyDescription
CancelGets or sets a value indicating whether the event should be canceled. Inherited from CancelEventArgs.
DocumentGets a merged document.
MailMergeRegionInfoObtains information on the currently merged region.
RecordDocumentGets a template document before a record is merged.
RecordIndexGets an index of a record currently merged.

Remarks

The MailMergeRecordStarted event can be used to pre-process the merged section of a document that corresponds to a particular record.

See Also

IRichEditDocumentServer Interface

IRichEditDocumentServer Members

DevExpress.XtraRichEdit Namespace