API Reference

Class

PdfVisualComparisonReport

Namespace OfficeIMO.Pdf
Assembly OfficeIMO.Pdf
Modifiers sealed

Rendered visual and structural comparison report for two PDFs.

Inheritance

  • Object
  • PdfVisualComparisonReport

Usage

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

Methods

ToHtmlGallery 2 overloads
public String ToHtmlGallery(String title = null) #
Returns: String

Builds a self-contained HTML human-review gallery with expected, actual, and highlighted diff images.

Parameters

title System.String = null optionalposition: 0
public String ToHtmlGallery(String title, Int64 maximumOutputBytes, CancellationToken cancellationToken = null) #
Returns: String

Builds a self-contained HTML gallery without allowing its UTF-8 representation to exceed the supplied byte limit.

Parameters

title System.String requiredposition: 0
maximumOutputBytes System.Int64 requiredposition: 1
cancellationToken System.Threading.CancellationToken = null optionalposition: 2

Properties

public IReadOnlyList<PdfVisualPageComparison> Pages { get; } #

Per-page comparisons.

public IReadOnlyList<String> StructuralDifferences { get; } #

Document/page structural differences.

public Boolean IsMatch { get; } #

True when all compared pages satisfy thresholds and no structural differences remain.