Class PdfRenderProgressEventArgs

Namespace: LMKit.Document.Pdf

Assembly: LM-Kit.NET.dll

Progress data reported by PdfRenderer multi-page methods after each page is processed.

public sealed class PdfRenderProgressEventArgs : EventArgs

Inheritance: object

EventArgs

PdfRenderProgressEventArgs

Inherited Members: EventArgs.Empty

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Remarks

Set Cancel to true from a progress callback to abort the operation. Pages already saved stay on disk; subsequent pages are not rendered.

Properties

Cancel: Set to true to abort processing of remaining pages. The pages already processed are preserved in the output.

Height: Pixel height of the page just rendered.

OutputPath: Output path the page was written to, or null when the operation does not write per-page files (for example SavePagesAsMultipageTiff(string, string, PdfRenderOptions, IProgress<PdfRenderProgressEventArgs>, CancellationToken)).

PageIndex: Zero-based index of the page just processed (within the source PDF, not the iteration index).

TotalPages: Total number of pages this operation will process.

Width: Pixel width of the page just rendered.