'Declaration Public Event ExportEnding As EventHandler(Of ExportEndingEventArgs)
public event EventHandler<ExportEndingEventArgs> ExportEnding
The event handler receives an argument of type ExportEndingEventArgs containing data related to this event. The following ExportEndingEventArgs properties provide information specific to this event.
Property | Description |
---|---|
Canceled | Returns a boolean indicating if the export operation was canceled. |
CancelInfo | Returns an object that provides information about action that canceled the export. |
ExportControl | Returns the Infragistics.Windows.DataPresenter.DataPresenterBase created for the export operation whose settings were initialized based on the Source control provided to the DataPresenterWordWriter.Export method. |
Source | Returns the Infragistics.Windows.DataPresenter.DataPresenterBase passed into the DataPresenterWordWriter.Export method. |
Writer | Returns the writer that will be used to perform the export operation and generate the Word document. |
The ExportEnding event is invoked when the export process has completed to give the developer an opportunity to manipulate the Writer being used. This is particularly important when using an overload of the Export method that takes a filename as the file will be saved after the ExportEnding is complete but before the ExportEnded. Also, since the file will not have been created until after the ExportEnding, if you wanted to copy the file to another location or display the file to the end user, the ExportEnded event should be used to do that.
The ExportEndingEventArgs.Canceled property can be used to determine if the export operation was canceled.
Note: The Infragistics.Documents.Word.WordDocumentWriter.EndDocument(System.Boolean) of the ExportEndingEventArgs.Writer will be invoked after this event is raised if the DataPresenterWordWriter created the writer.
Target Platforms: Windows 10, Windows 8.1, Windows 8, Windows 7, Windows Server 2012, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2