Skip to main content

Search OfficeIMO

Enter a topic, API type, or PowerShell command.

Documentation Search all OfficeIMO/

API Reference

Class

PdfVisualComparisonOptions

Namespace OfficeIMO.Pdf
Assembly OfficeIMO.Pdf
Source revision 804a7612eee4 with working tree changes
Modifiers sealed

Options for dependency-free rendered PDF comparison.

Inheritance

  • Object
  • PdfVisualComparisonOptions

Usage

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

Accepted by parameters 4

Constructors

public PdfVisualComparisonOptions() #

Properties

public Double Scale { get; set; } #

Render scale.

public Byte ChannelTolerance { get; set; } #

Maximum per-channel difference treated as equal, from 0 through 255.

public Double AllowedDifferenceRatio { get; set; } #

Maximum changed-pixel ratio accepted as equal, from 0 through 1.

public PdfVisualPageAlignment Alignment { get; set; } #

Alignment for pages with differing dimensions.

public OfficeColor Background { get; set; } #

Raster background used for both inputs.

public IList<PdfPixelRegion> IgnoredRegions { get; } #

Ignored comparison regions in output pixel coordinates. At most 4096 regions are accepted.

public PdfPageSelector? ExpectedPages { get; set; } #

Optional ordered, document-relative expected-page selection. Null selects every expected page.

public PdfPageSelector? ActualPages { get; set; } #

Optional ordered, document-relative actual-page selection. Null selects every actual page.

public Int32 MaxPages { get; set; } #

Maximum selected pages on either side, including repeated pages.

public Int64 MaxPixelsPerImage { get; set; } #

Maximum raster pixels allocated for one expected, actual, or diff page image.

public Int64 MaxTotalPixels { get; set; } #

Maximum aggregate raster pixels allocated across the comparison.

public Int64 MaxTotalOutputBytes { get; set; } #

Maximum aggregate PNG bytes retained in the comparison report.