SnapDocumentServer.SnapMailMergeRecordFinished Event
Occurs after data field merging has finished.
Namespace: DevExpress.Snap
Assembly: DevExpress.Docs.v21.1.dll
NuGet Package: DevExpress.Document.Processor
Declaration
Event Data
The SnapMailMergeRecordFinished event's data class is SnapMailMergeRecordFinishedEventArgs. 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 | Returns the document that is being merged. |
RecordDocument | Provides access to the document created for a single record after the fields are processed. |
RecordIndex | Returns the data record index. |
Remarks
Handle the SnapMailMergeRecordFinished event to perform any actions after the process of field merging has finished. For example, you can access the data source collection of a single record document using the SnapDocument.DataSources property of the SnapDocument object accessed via the SnapMailMergeRecordFinishedEventArgs.RecordDocument property.
Note
Do not delete or modify the main data source used for the mail-merge process (i.e., the data source assigned to the DataSource and DataSourceName properties of the SnapMailMergeVisualOptions object) in the event handler, an exception will be thrown otherwise.