Get Started

API Reference

Class

PdfReadPage

Edit on GitHub
Namespace OfficeIMO.Pdf
Assembly OfficeIMO.Pdf
Source OfficeIMO.Pdf/Reading/Core/PdfReadPage.cs:41
Modifiers sealed

Represents a single page parsed from the PDF. Provides access to plain text and basic text spans based on content stream operators.

Inheritance

  • Object
  • PdfReadPage

Usage

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

Returned or exposed by

Accepted by parameters

Methods

public String ExtractText() #
OfficeIMO.Pdf/Reading/Core/PdfReadPage.cs:41
Returns: String

Extracts plain text from this page without column reordering.

public IReadOnlyList<PdfAnnotation> GetAnnotations() #
OfficeIMO.Pdf/Reading/Core/PdfReadPage.cs:209
Returns: IReadOnlyList<PdfAnnotation>

Reads generic annotation metadata from this page.

public PdfPageGeometry GetGeometry() #
OfficeIMO.Pdf/Reading/Core/PdfReadPage.Geometry.cs:6
Returns: PdfPageGeometry

Reads page boundary boxes and page-level presentation metadata.

public IReadOnlyList<PdfImagePlacement> GetImagePlacements() #
OfficeIMO.Pdf/Reading/Core/PdfReadPage.cs:368
Returns: IReadOnlyList<PdfImagePlacement>

Extracts image XObject placement invocations from this page.

public IReadOnlyList<PdfExtractedImage> GetImages() #
OfficeIMO.Pdf/Reading/Core/PdfReadPage.cs:323
Returns: IReadOnlyList<PdfExtractedImage>

Extracts image XObjects referenced by this page.

public IReadOnlyList<PdfLinkAnnotation> GetLinkAnnotations() #
OfficeIMO.Pdf/Reading/Core/PdfReadPage.cs:142
Returns: IReadOnlyList<PdfLinkAnnotation>

Reads simple URI, named-destination, direct-destination, named-action, and remote GoTo link annotations from this page.

public IReadOnlyList<PdfPageAction> GetPageActions() #
OfficeIMO.Pdf/Reading/Core/PdfReadPage.PageActions.cs:6
Returns: IReadOnlyList<PdfPageAction>

Reads page-level additional action metadata from this page dictionary.

public ValueTuple<Double, Double> GetPageSize() #
OfficeIMO.Pdf/Reading/Core/PdfReadPage.cs:52
Returns: ValueTuple<Double, Double>

Attempts to read page size from CropBox (or MediaBox) and returns width/height in points. Falls back to 612x792 (US Letter) when not present or malformed.

public Int32 GetRotationDegrees() #
OfficeIMO.Pdf/Reading/Core/PdfReadPage.cs:99
Returns: Int32

Gets inherited page rotation in degrees normalized to 0, 90, 180, or 270.

public IReadOnlyList<PdfTextSpan> GetTextSpans() #
OfficeIMO.Pdf/Reading/Core/PdfReadPage.cs:115
Returns: IReadOnlyList<PdfTextSpan>

Gets text spans (text with position and font info) from this page.

public OfficeDrawing ToDrawing() #
OfficeIMO.Pdf/Reading/Core/PdfReadPage.Visual.cs:45
Returns: OfficeDrawing

Projects supported page drawing operators, text spans, and image placements into a dependency-free drawing scene.

Properties

public Int32 ObjectNumber { get; } #
OfficeIMO.Pdf/Reading/Core/PdfReadPage.cs:37

Underlying object number for the page.

Extension Methods

public static OfficeImageExportResult ExportImage(PdfReadPage page, OfficeImageExportFormat format, PdfImageExportOptions options = null) #
OfficeIMO.Pdf/Rendering/PdfImageExportBuilder.cs:212
Returns: OfficeImageExportResult

Exports one loaded PDF page using the shared five-format result contract.

Parameters

page OfficeIMO.Pdf.PdfReadPage requiredposition: 0
format OfficeIMO.Drawing.OfficeImageExportFormat requiredposition: 1
options OfficeIMO.Pdf.PdfImageExportOptions = null optionalposition: 2
public static StructuredPage ExtractStructured(PdfReadPage page, PdfTextLayoutOptions options = null) #
OfficeIMO.Pdf/Reading/Layout/TextLayoutEngine.cs:493
Returns: StructuredPage

Extracts a simple structured model (lines, TOC entries, list items) for this page.

Parameters

page OfficeIMO.Pdf.PdfReadPage requiredposition: 0
Source page.
options OfficeIMO.Pdf.PdfTextLayoutOptions = null optionalposition: 1
Optional layout options.
public static String ExtractTextWithColumns(PdfReadPage page, PdfTextLayoutOptions options = null) #
OfficeIMO.Pdf/Reading/Layout/TextLayoutEngine.cs:467
Returns: String

Extracts text from a page with simple two-column detection when present.

Parameters

page OfficeIMO.Pdf.PdfReadPage requiredposition: 0
Source page.
options OfficeIMO.Pdf.PdfTextLayoutOptions = null optionalposition: 1
Optional layout options controlling column detection, margins and trimming.

Returns

Plain text for this page in inferred reading order.

ToImage 2 overloads
public static PdfPageImageExportBuilder ToImage(PdfReadPage page) #
OfficeIMO.Pdf/Rendering/PdfImageExportBuilder.cs:252
Returns: PdfPageImageExportBuilder

Starts fluent image export for one loaded PDF page.

Parameters

page OfficeIMO.Pdf.PdfReadPage requiredposition: 0
public static PdfPageImageExportBuilder ToImage(PdfReadPage page, PdfImageExportOptions options) #
OfficeIMO.Pdf/Rendering/PdfImageExportBuilder.cs:256
Returns: PdfPageImageExportBuilder

Starts fluent image export for one loaded PDF page using a cloned options snapshot.

Parameters

page OfficeIMO.Pdf.PdfReadPage requiredposition: 0
options OfficeIMO.Pdf.PdfImageExportOptions requiredposition: 1