Skip to main content
SearchCtrl K
Community

Source code

OfficeIMO.NET libraries, CLI, Studio and browser tools 575 stars PSWriteOfficePowerShell module 165 stars

Talk and help

DiscordQuestions, ideas and show and tell Report an issueBugs and feature requests SponsorFund ongoing development

Mode

Background

Search OfficeIMO

Enter a topic, API type, or PowerShell command.

Search the whole siteOpen search page →
Documentation Search all OfficeIMO/

API Reference

Class

PdfDocumentReaderExtensions

Edit on GitHub
Namespace OfficeIMO.Reader.Pdf
Assembly OfficeIMO.Reader.Pdf
Source revision a0f47aa4f111 with working tree changes
Source PdfDocumentReaderExtensions.cs:22
Modifiers static

Projects an already loaded native PDF result into the normalized Reader model.

Inheritance

  • Object
  • PdfDocumentReaderExtensions

Methods

ReadDocument 2 overloads
public static OfficeDocumentReadResult ReadDocument(PdfDocumentReadResult document, String sourceName = "document.pdf", ReaderOptions? readerOptions = null, ReaderPdfOptions? pdfOptions = null, CancellationToken cancellationToken = default) #
PdfDocumentReaderExtensions.cs:22
Returns: OfficeDocumentReadResult

Reads the supplied logical pages without reopening, parsing, or rendering the PDF.

Parameters

document OfficeIMO.Pdf.PdfDocumentReadResult requiredposition: 0
Caller-owned native logical result to project.
sourceName System.String = "document.pdf" optionalposition: 1
Logical source name used in locations; no file is opened at this path.
readerOptions OfficeIMO.Reader.ReaderOptions? = null optionalposition: 2
Reader projection, inspection, and output budget settings. Null uses the full projection.
pdfOptions OfficeIMO.Reader.Pdf.ReaderPdfOptions? = null optionalposition: 3
PDF projection settings, including page selection and chunk grouping.
cancellationToken System.Threading.CancellationToken = default optionalposition: 4
Cancellation observed during projection.

Returns

A normalized Reader result for the supplied logical source.

public static OfficeDocumentReadResult ReadDocument(PdfInspectionReadResult inspection, String sourceName = "document.pdf", ReaderOptions? readerOptions = null, ReaderPdfOptions? pdfOptions = null, CancellationToken cancellationToken = default) #
PdfDocumentReaderExtensions.cs:46
Returns: OfficeDocumentReadResult

Projects a completed native inspection while preserving every selected page occurrence and failure.

Parameters

inspection OfficeIMO.Pdf.PdfInspectionReadResult requiredposition: 0
Caller-owned inspection result, including its original selection outcomes.
sourceName System.String = "document.pdf" optionalposition: 1
Logical source name; no file is opened at this path.
readerOptions OfficeIMO.Reader.ReaderOptions? = null optionalposition: 2
Projection and output budgets. A null inspection policy uses the default evidence budget.
pdfOptions OfficeIMO.Reader.Pdf.ReaderPdfOptions? = null optionalposition: 3
Projection settings. Select pages when creating the native inspection; reselection here is rejected.
cancellationToken System.Threading.CancellationToken = default optionalposition: 4
Cancellation observed during projection.

Returns

A Reader result with native occurrence identities and located failure evidence.