Skip to main content

Search OfficeIMO

Enter a topic, API type, or PowerShell command.

Documentation Search all OfficeIMO/

API Reference

Class

PdfReadOptions

Namespace OfficeIMO.Pdf
Assembly OfficeIMO.Pdf
Source revision 804a7612eee4 with working tree changes
Modifiers sealed

Controls semantic reconstruction performed by PdfDocument.Read.

Inheritance

  • Object
  • PdfReadOptions

Usage

Explore 4 API references to this type

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

Returned or exposed by 2

Accepted by parameters 2

Constructors

public PdfReadOptions() #

Methods

public PdfReadOptions Clone() #
Returns: PdfReadOptions

Creates an independent copy of these semantic read settings. Custom stage instances are reused, while mutable layout and pipeline option containers are copied.

Properties

public static PdfReadOptions Default { get; } #

Creates independent structured-read settings.

public PdfReadProfile Profile { get; init; } #

Semantic reconstruction profile. Structured is the default public contract.

public Boolean IncludeImages { get; init; } #

Includes image placements, image-region analysis and extracted image payloads. Default: true. False retains native text, including text inside Form XObjects, without materializing image assets.

public Boolean IncludeFormWidgets { get; init; } #

Includes logical AcroForm widget projections. Default: true. False retains bounded source field facts and values while omitting secondary widget objects.

public PdfPageSelection? PageSelection { get; init; } #

Optional caller-ordered page selection. Null reads every page in document order.

public PdfTextLayoutOptions LayoutOptions { get; init; } #

Layout and geometry settings shared by every built-in semantic stage.

public PdfUnderstandingPipelineOptions? Pipeline { get; init; } #

Optional semantic-stage customization. Null selects the built-in stages for PdfReadOptions.Profile. Custom stages still run inside the canonical read engine and produce the same result contract.