API Reference

Class

PdfUnderstandingPageContext

Namespace OfficeIMO.Pdf
Assembly OfficeIMO.Pdf
Modifiers sealed

Page and option context shared by understanding stages.

Inheritance

  • Object
  • PdfUnderstandingPageContext

Usage

This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.

Accepted by parameters

Methods

public Void ConsumeWork(Int64 units = 1) #
Returns: Void

Charges comparison or traversal work and observes cancellation.

Parameters

units System.Int64 = 1 optionalposition: 0
public Void ThrowIfCancellationRequested() #
Returns: Void

Throws when semantic reconstruction has been cancelled.

Properties

public PdfReadPage Page { get; } #

Parsed source page.

public Int32 PageNumber { get; } #

One-based source page number.

public Double Width { get; } #

Page width in PDF points.

public Double Height { get; } #

Page height in PDF points.

public PdfTextLayoutOptions LayoutOptions { get; } #

Layout options supplied to the pipeline.

public Int32 MaxTextCharactersPerPage { get; } #

Maximum decoded text characters accepted for this page.

public Int32 MaxWordsPerPage { get; } #

Maximum word artifacts accepted for this page.

public Int32 MaxTableCandidatesPerPage { get; set; } #

Maximum table candidates accepted for this page.

public Int32 MaxImageCaptionCandidatesPerPage { get; set; } #

Maximum viable image-caption association edges retained before deterministic matching.

public CancellationToken CancellationToken { get; } #

Cancellation token observed by built-in and cooperative custom stages.

public Int64 MaxWorkUnitsPerPage { get; } #

Maximum comparison and traversal work units available to this page.

public Int64 WorkUnitsConsumed { get; } #

Work units consumed so far by semantic reconstruction for this page.

public IReadOnlyList<PdfUnderstandingTableCandidate> TableCandidates { get; set; } #

Table candidates available to page segmentation and later stages.

public IReadOnlyList<PdfImagePlacement> ImagePlacements { get; set; } #

Image placement invocations available to semantic stages in stable paint order.