Get Started

API Reference

Class

PdfDocumentRenderer

Edit on GitHub
Namespace OfficeIMO.Pdf
Assembly OfficeIMO.Pdf
Source OfficeIMO.Pdf/Core/PdfDocumentRenderer.cs:17
Modifiers sealed

Managed page rendering and drawing projection for a loaded PDF document.

Inheritance

  • Object
  • PdfDocumentRenderer

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

Methods

public IReadOnlyList<PdfRenderCapabilityDiagnostic> CapabilityDiagnostics(Int32 pageNumber) #
OfficeIMO.Pdf/Core/PdfDocumentRenderer.cs:29
Returns: IReadOnlyList<PdfRenderCapabilityDiagnostic>

Returns managed-renderer capability diagnostics for a one-based page.

Parameters

pageNumber System.Int32 requiredposition: 0
public OfficeDrawing Drawing(Int32 pageNumber) #
OfficeIMO.Pdf/Core/PdfDocumentRenderer.cs:17
Returns: OfficeDrawing

Projects a one-based PDF page into the shared editable drawing scene.

Parameters

pageNumber System.Int32 requiredposition: 0
public IReadOnlyList<OfficeImageExportResult> ExportImages(OfficeImageExportFormat format, PdfImageExportOptions options = null, PdfPageSelection selection = null, CancellationToken cancellationToken = null) #
OfficeIMO.Pdf/Core/PdfDocumentRenderer.cs:44
Returns: IReadOnlyList<OfficeImageExportResult>

Exports all pages or a caller-ordered selection through the shared image-export contract.

Parameters

format OfficeIMO.Drawing.OfficeImageExportFormat requiredposition: 0
options OfficeIMO.Pdf.PdfImageExportOptions = null optionalposition: 1
selection OfficeIMO.Pdf.PdfPageSelection = null optionalposition: 2
cancellationToken System.Threading.CancellationToken = null optionalposition: 3
public PdfPageInteractionMap Interactions(Int32 pageNumber, PdfPageInteractionOptions options = null, PdfLoadOptions loadOptions = null) #
OfficeIMO.Pdf/Core/PdfDocumentRenderer.cs:36
Returns: PdfPageInteractionMap

Builds text-selection and interactive hit regions for a one-based page.

Parameters

pageNumber System.Int32 requiredposition: 0
options OfficeIMO.Pdf.PdfPageInteractionOptions = null optionalposition: 1
loadOptions OfficeIMO.Pdf.PdfLoadOptions = null optionalposition: 2
public OfficeDrawing LayoutDebugOverlay(Int32 pageNumber, PdfLayoutDebugOverlayOptions options = null, PdfTextLayoutOptions layoutOptions = null, PdfLoadOptions loadOptions = null) #
OfficeIMO.Pdf/Core/PdfDocumentRenderer.cs:25
Returns: OfficeDrawing

Creates a drawing overlay that visualizes recovered page interactions and layout regions.

Parameters

pageNumber System.Int32 requiredposition: 0
options OfficeIMO.Pdf.PdfLayoutDebugOverlayOptions = null optionalposition: 1
layoutOptions OfficeIMO.Pdf.PdfTextLayoutOptions = null optionalposition: 2
loadOptions OfficeIMO.Pdf.PdfLoadOptions = null optionalposition: 3
Pages 2 overloads
public IReadOnlyList<PdfPageRenderResult> Pages(PdfPageSelection selection = null, PdfPageRenderOptions options = null, CancellationToken cancellationToken = null) #
OfficeIMO.Pdf/Core/PdfDocumentRenderer.cs:51
Returns: IReadOnlyList<PdfPageRenderResult>

Renders all pages or a caller-ordered selection through the managed batch renderer.

Parameters

selection OfficeIMO.Pdf.PdfPageSelection = null optionalposition: 0
options OfficeIMO.Pdf.PdfPageRenderOptions = null optionalposition: 1
cancellationToken System.Threading.CancellationToken = null optionalposition: 2
public IReadOnlyList<PdfPageRenderResult> Pages(String pageRanges, PdfPageRenderOptions options = null, CancellationToken cancellationToken = null) #
OfficeIMO.Pdf/Core/PdfDocumentRenderer.cs:58
Returns: IReadOnlyList<PdfPageRenderResult>

Renders parsed page ranges such as 1-3,5 through the managed batch renderer.

Parameters

pageRanges System.String requiredposition: 0
options OfficeIMO.Pdf.PdfPageRenderOptions = null optionalposition: 1
cancellationToken System.Threading.CancellationToken = null optionalposition: 2