Skip to main content
SearchCtrl K
Community

Source code

OfficeIMO.NET libraries, PowerShell module, CLI, Studio and browser tools 579 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

PdfDocumentRenderer

Edit on GitHub
Namespace OfficeIMO.Pdf
Assembly OfficeIMO.Pdf
Source revision e31b305980e3 with working tree changes
Source PdfDocumentRenderer.cs:21
Modifiers sealed

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

Inheritance

  • Object
  • PdfDocumentRenderer

Usage

Explore 1 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 1

Methods

CapabilityDiagnostics 2 overloads
public IReadOnlyList<PdfRenderCapabilityDiagnostic> CapabilityDiagnostics(Int32 pageNumber) #
PdfDocumentRenderer.cs:42
Returns: IReadOnlyList<PdfRenderCapabilityDiagnostic>

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

Parameters

pageNumber System.Int32 requiredposition: 0
public IReadOnlyList<PdfRenderCapabilityDiagnostic> CapabilityDiagnostics(Int32 pageNumber, PdfPageRenderOptions? options) #
PdfDocumentRenderer.cs:47
Returns: IReadOnlyList<PdfRenderCapabilityDiagnostic>

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

Parameters

pageNumber System.Int32 requiredposition: 0
options OfficeIMO.Pdf.PdfPageRenderOptions? requiredposition: 1
public PdfPageRenderResult DisplayPage(Int32 pageNumber, PdfPageDisplayOptions? options = null, CancellationToken cancellationToken = default) #
PdfDocumentRenderer.cs:21
Returns: PdfPageRenderResult

Renders one authenticated page to bounded PNG pixels for on-screen viewing, including when content copying is restricted. The result contains no editable drawing objects, embedded source images, fonts, or text model. Extraction and printing remain separate permission-checked operations.

Parameters

pageNumber System.Int32 requiredposition: 0
options OfficeIMO.Pdf.PdfPageDisplayOptions? = null optionalposition: 1
cancellationToken System.Threading.CancellationToken = default optionalposition: 2
public OfficeDrawing Drawing(Int32 pageNumber) #
PdfDocumentRenderer.cs:30
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 = default) #
PdfDocumentRenderer.cs:62
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 = default optionalposition: 3
public PdfPageInteractionMap Interactions(Int32 pageNumber, PdfPageInteractionOptions? options = null, PdfLoadOptions? loadOptions = null) #
PdfDocumentRenderer.cs:54
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) #
PdfDocumentRenderer.cs:38
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 = default) #
PdfDocumentRenderer.cs:69
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 = default optionalposition: 2
public IReadOnlyList<PdfPageRenderResult> Pages(String pageRanges, PdfPageRenderOptions? options = null, CancellationToken cancellationToken = default) #
PdfDocumentRenderer.cs:76
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 = default optionalposition: 2
public PdfPageRenderResult PrintPage(Int32 pageNumber, PdfPagePrintOptions? options = null, CancellationToken cancellationToken = default) #
PdfDocumentRenderer.cs:27
Returns: PdfPageRenderResult

Renders the managed page appearance to PNG after checking printing permissions.

Parameters

pageNumber System.Int32 requiredposition: 0
options OfficeIMO.Pdf.PdfPagePrintOptions? = null optionalposition: 1
cancellationToken System.Threading.CancellationToken = default optionalposition: 2