ConversionEvents

ConversionEvents class

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

Constructors

Name Description
ConversionEvents() The default constructor.

Properties

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.
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.

See Also