Get Started

API Reference

Class

PdfUnderstandingPipeline

Edit on GitHub
Namespace OfficeIMO.Pdf
Assembly OfficeIMO.Pdf
Source OfficeIMO.Pdf/Reading/Understanding/PdfUnderstandingPipeline.cs:47
Modifiers sealed

Runs a bounded, typed, pluggable PDF text-understanding pipeline.

Inheritance

  • Object
  • PdfUnderstandingPipeline

Constructors

public PdfUnderstandingPipeline(PdfUnderstandingPipelineOptions options = null) #
OfficeIMO.Pdf/Reading/Understanding/PdfUnderstandingPipeline.cs:47

Creates a pipeline, using the lightweight built-in stage for each unspecified slot.

Parameters

options OfficeIMO.Pdf.PdfUnderstandingPipelineOptions = null optionalposition: 0

Methods

Run 2 overloads
public PdfUnderstandingResult Run(PdfReadDocument document, PdfPageSelection selection = null, CancellationToken cancellationToken = null) #
OfficeIMO.Pdf/Reading/Understanding/PdfUnderstandingPipeline.cs:62
Returns: PdfUnderstandingResult

Runs all stages for all pages or a caller-ordered page selection.

Parameters

document OfficeIMO.Pdf.PdfReadDocument requiredposition: 0
selection OfficeIMO.Pdf.PdfPageSelection = null optionalposition: 1
cancellationToken System.Threading.CancellationToken = null optionalposition: 2
public PdfUnderstandingResult Run(PdfReadDocument document, PdfPageSelector selector, CancellationToken cancellationToken = null) #
OfficeIMO.Pdf/Reading/Understanding/PdfUnderstandingPipeline.cs:76
Returns: PdfUnderstandingResult

Runs all stages for pages resolved by a document-relative selector.

Parameters

document OfficeIMO.Pdf.PdfReadDocument requiredposition: 0
selector OfficeIMO.Pdf.PdfPageSelector requiredposition: 1
cancellationToken System.Threading.CancellationToken = null optionalposition: 2