SnapControl.SnapMailMergeStarted Event

Occurs after document merging has started.

Namespace: DevExpress.Snap

Assembly: DevExpress.Snap.v18.2.dll

Declaration

C#

public event SnapMailMergeStartedEventHandler SnapMailMergeStarted

VB.NET

Public Event SnapMailMergeStarted As SnapMailMergeStartedEventHandler

Event Data

The SnapMailMergeStarted event's data class is SnapMailMergeStartedEventArgs. 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 a mail merge document that has started rendering.
OperationDescription	Provides access to the operation description.

Remarks

When a mail merge is performed in the user interface, the SnapMailMergeStarted event can be raised asynchronously, requiring use of the SnapControl‘s InvokeRequired property in the event handler to determine if it is necessary to call the SnapControl.Invoke method to execute a delegate in a thread that owns the control.