Skip to main content
SearchCtrl K
Community

Source code

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

PdfVisualComparer

Edit on GitHub
Namespace OfficeIMO.Pdf
Assembly OfficeIMO.Pdf
Source revision 804a7612eee4 with working tree changes
Source PdfVisualComparer.cs:16
Modifiers static

Dependency-free rendered PDF comparison with structural evidence and review artifacts.

Inheritance

  • Object
  • PdfVisualComparer

Guides & Samples

Authored walkthroughs and practical samples linked to this API.

  • Compare two PDF files visually Guide

    Compare two PDFs locally, review structural findings, and download an HTML gallery containing expected, actual, and highlighted page-difference images.

Methods

Compare 2 overloads
public static PdfVisualComparisonReport Compare(Byte[] expectedPdf, Byte[] actualPdf, PdfPageSelection? selection = null, PdfVisualComparisonOptions? options = null, PdfLoadOptions? expectedReadOptions = null, PdfLoadOptions? actualReadOptions = null) #
PdfVisualComparer.cs:16
Returns: PdfVisualComparisonReport

Compares whole documents, a shared page set, or independent ordered page selections.

Parameters

expectedPdf System.Byte[] requiredposition: 0
actualPdf System.Byte[] requiredposition: 1
selection OfficeIMO.Pdf.PdfPageSelection? = null optionalposition: 2
options OfficeIMO.Pdf.PdfVisualComparisonOptions? = null optionalposition: 3
expectedReadOptions OfficeIMO.Pdf.PdfLoadOptions? = null optionalposition: 4
actualReadOptions OfficeIMO.Pdf.PdfLoadOptions? = null optionalposition: 5
public static PdfVisualComparisonReport Compare(Byte[] expectedPdf, Byte[] actualPdf, CancellationToken cancellationToken, PdfPageSelection? selection = null, PdfVisualComparisonOptions? options = null, PdfLoadOptions? expectedReadOptions = null, PdfLoadOptions? actualReadOptions = null) #
PdfVisualComparer.cs:27
Returns: PdfVisualComparisonReport

Compares whole documents, a shared page set, or independent ordered page selections with cooperative cancellation.

Parameters

expectedPdf System.Byte[] requiredposition: 0
actualPdf System.Byte[] requiredposition: 1
cancellationToken System.Threading.CancellationToken requiredposition: 2
selection OfficeIMO.Pdf.PdfPageSelection? = null optionalposition: 3
options OfficeIMO.Pdf.PdfVisualComparisonOptions? = null optionalposition: 4
expectedReadOptions OfficeIMO.Pdf.PdfLoadOptions? = null optionalposition: 5
actualReadOptions OfficeIMO.Pdf.PdfLoadOptions? = null optionalposition: 6
public static PdfVisualPageComparison ComparePages(Byte[] expectedPdf, Int32 expectedPageNumber, Byte[] actualPdf, Int32 actualPageNumber, PdfVisualComparisonOptions? options = null, PdfLoadOptions? expectedReadOptions = null, PdfLoadOptions? actualReadOptions = null, CancellationToken cancellationToken = default) #
PdfVisualComparer.cs:92
Returns: PdfVisualPageComparison

Compares any two one-based pages, including pages aligned after insertion or reordering.

Parameters

expectedPdf System.Byte[] requiredposition: 0
expectedPageNumber System.Int32 requiredposition: 1
actualPdf System.Byte[] requiredposition: 2
actualPageNumber System.Int32 requiredposition: 3
options OfficeIMO.Pdf.PdfVisualComparisonOptions? = null optionalposition: 4
expectedReadOptions OfficeIMO.Pdf.PdfLoadOptions? = null optionalposition: 5
actualReadOptions OfficeIMO.Pdf.PdfLoadOptions? = null optionalposition: 6
cancellationToken System.Threading.CancellationToken = default optionalposition: 7