ConversionEvents Leave feedback
On this page
Aggregates conversion lifecycle event handlers. Pass an instance to the Converter constructor’s events parameter or to the fluent WithEvents method. Prefer this over the individual ConverterSettings handler properties, which are obsolete.
public sealed class ConversionEvents
| Name | Description |
|---|---|
| ConversionEvents() | The default constructor. |
| Name | Description |
|---|---|
| OnCompressionCompleted { get; set; } | Fired when compression of conversion output completes. Only invoked in builds that include the compression pipeline (LIB_ZIP). |
| OnConversionCompleted { get; set; } | Fired once when the conversion run finishes, regardless of success or failure. |
| OnConversionProgress { get; set; } | Fired periodically with conversion progress as a percentage (0–100). |
| OnConversionStarted { get; set; } | Fired once at the start of the conversion run, before any document is processed. |
| OnDocumentConverted { get; set; } | Fired once per whole-document conversion that completes successfully. |
| OnDocumentFailed { get; set; } | Fired once per whole-document conversion that fails, and once per contained item (an archive entry, an email attachment, a mailbox item) that cannot be loaded and is skipped while the conversion of the remaining items continues. For such an item the context carries its name, hierarchy level and item index, and Unknown as its source and target format. |
| OnFontSubstituted { get; set; } | Fired when a font referenced by the source document is not available and is substituted (either by a customer-supplied FontSubstitute rule, by the configured default font, or by the conversion pipeline’s internal fallback). |
| OnPageConverted { get; set; } | Fired once per page when a per-page conversion completes successfully. |
| OnPageFailed { get; set; } | Fired once per page when a per-page conversion fails. |
- namespace GroupDocs.Conversion
- assembly GroupDocs.Conversion
Was this page helpful?
Any additional feedback you'd like to share with us?
Please tell us how we can improve this page.
Thank you for your feedback!
We value your opinion. Your feedback will help us improve our documentation.
