Skip to main content

Search OfficeIMO

Enter a topic, API type, or PowerShell command.

Documentation Search all OfficeIMO/
Cmdlet

New-OfficePdfVisualComparisonOptions

Module
PSWriteOffice
Inputs
None
Outputs
PSWriteOffice.Services.Comparison.OfficePdfVisualComparisonOptions

Creates native PDF comparison settings and independent bounded policies for both inputs.

Syntax

New-OfficePdfVisualComparisonOptions
[-Alignment <TopLeft|Center>]
[-AllowedDifferenceRatio <Double>]
[-BackgroundColor <OfficeColor>]
[-ChannelTolerance <Int32>]
[-DifferenceLoadOptions <PdfLoadOptions>]
[-IgnoreDifferencePermissionRestrictions]
[-IgnorePermissionRestrictions]
[-MaximumPixelCountPerImage <Int64>]
[-MaximumTotalPixelCount <Int64>]
[-MaxPages <Int32>]
[-MaxTotalOutputBytes <Int64>]
[-ReferenceLoadOptions <PdfLoadOptions>]
[-Scale <Double>]
[<CommonParameters>]
#
Parameter set: Default

Examples

Example 1

New-OfficePdfVisualComparisonOptions -Alignment 'Value'

Parameters

-Alignment PdfVisualPageAlignment optional
Native page-image alignment.
Possible values: TopLeft, Center
-AllowedDifferenceRatio Double optional
Maximum differing-pixel ratio accepted as equal.
-BackgroundColor OfficeColor optional
Raster background.
-ChannelTolerance Int32 optional
Maximum per-channel difference treated as equal.
-DifferenceLoadOptions PdfLoadOptions optional
Bounded policy for the difference input.
-IgnoreDifferencePermissionRestrictions SwitchParameter optional
Explicitly ignore authenticated owner-imposed restrictions on the difference PDF.
-IgnorePermissionRestrictions SwitchParameter optional
Explicitly ignore authenticated owner-imposed restrictions on the reference PDF.
-MaximumPixelCountPerImage Int64 optional
Maximum pixels in one expected, actual or difference image.
-MaximumTotalPixelCount Int64 optional
Maximum aggregate raster pixels.
-MaxPages Int32 optional
Maximum pages on either side.
-MaxTotalOutputBytes Int64 optional
Maximum retained PNG bytes.
-ReferenceLoadOptions PdfLoadOptions optional
Bounded policy for the reference input.
-Scale Double optional
Native render scale.

Common Parameters

This command supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable.

For more information, see about_CommonParameters.

Outputs

PSWriteOffice.Services.Comparison.OfficePdfVisualComparisonOptions: Native comparison settings and distinct bounded input policies for the two PDF roles.