API Reference
PdfVisualComparisonReport
Rendered visual and structural comparison report for two PDFs.
Inheritance
- Object
- PdfVisualComparisonReport
Usage
Explore 2 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 2
- Method PdfDocumentProof.CompareVisual
- Method PdfVisualComparer.Compare
Methods
public String ToHtmlGallery(String? title = null) #StringBuilds a self-contained HTML human-review gallery with expected, actual, and highlighted diff images.
Parameters
- title System.String? = null
public String ToHtmlGallery(String? title, Int64 maximumOutputBytes, CancellationToken cancellationToken = default) #StringBuilds a self-contained HTML gallery without allowing its UTF-8 representation to exceed the supplied byte limit.
Parameters
- title System.String?
- maximumOutputBytes System.Int64
- cancellationToken System.Threading.CancellationToken = default
Inherited Methods
public virtual Boolean Equals(Object? obj) #BooleanParameters
- obj Object?
Properties
public Int32 ExpectedPageCount { get; } #Total pages in the expected document, including pages outside a selected comparison.
public Int32 ActualPageCount { get; } #Total pages in the actual document, including pages outside a selected comparison.
public IReadOnlyList<Int32> ExpectedPageNumbers { get; } #Ordered expected source pages in the comparison scope, including unmatched pages and repeats.
public IReadOnlyList<Int32> ActualPageNumbers { get; } #Ordered actual source pages in the comparison scope, including unmatched pages and repeats.
public IReadOnlyList<Int32> UnmatchedExpectedPageNumbers { get; } #Selected expected pages with no selected actual partner.
public IReadOnlyList<Int32> UnmatchedActualPageNumbers { get; } #Selected actual pages with no selected expected partner.
public String ExpectedSha256 { get; } #SHA-256 of the exact expected PDF snapshot compared.
public String ActualSha256 { get; } #SHA-256 of the exact actual PDF snapshot compared.
public Boolean IsSelectedScope { get; } #True when the caller explicitly selected a comparison scope.
public IReadOnlyList<PdfVisualPageComparison> Pages { get; } #Per-page comparisons in selected sequence order, retaining original source page numbers.
public IReadOnlyList<String> StructuralDifferences { get; } #Document/page structural differences.
public Boolean IsMatch { get; } #True when all compared pages have complete managed renderings that satisfy thresholds and no structural differences remain.
public Int32 DifferentPageCount { get; } #Compared page pairs with complete managed renderings that fail the configured visual thresholds.
public Int32 IncompletePageCount { get; } #Compared page pairs whose managed rendering is incomplete, so their pixels cannot establish a visual match or difference.