Cmdlet

Compare-OfficeDocument

Module: PSWriteOffice
Inputs: None
Outputs: PSWriteOffice.Models.OfficeComparisonReport
Source: CompareOfficeDocumentCommand.cs:23 Edit on GitHub

Compares native document content or rendered pages and optionally publishes a review artifact.

Syntax

Compare-OfficeDocument
[-DifferencePassword <SecureString>]
[-DifferencePath] <String>
[-MaximumDifferences <Int32>]
[-Options <Object[]>]
[-OutputPath <String>]
[-Page <OfficePageRange>]
[-Password <SecureString>]
[-ReferencePath] <String>
[-Visual]
[<CommonParameters>]

Parameter set: Path

Compare-OfficeDocument
[-DifferenceDocument] <Object>
[-MaximumDifferences <Int32>]
[-Options <Object[]>]
[-OutputPath <String>]
[-Page <OfficePageRange>]
[-ReferenceDocument] <Object>
[-Visual]
[<CommonParameters>]

Parameter set: Document

Examples

Example 1

Compare-OfficeDocument -ReferencePath 'C:\Path' -DifferencePath 'C:\Path'

Example 2

Compare-OfficeDocument -ReferenceDocument 'Value' -DifferenceDocument 'Value'

Parameters

-DifferencePassword SecureString optionalsets: Path: Modified file's password; omission reuses Password.
-DifferencePath String requiredposition: 1sets: Path: Modified document path.
-MaximumDifferences Int32 optional: Maximum native findings returned; Excel also enforces this during its comparison.
-Options Object[] optional: Typed native comparison settings or native property overrides.
-OutputPath String optional: Optional Word redline, Excel findings workbook or visual HTML gallery.
-Page OfficePageRange optional: Ordered one-based pages used by visual comparison.
-Password SecureString optionalsets: Path: Original file's password.
-ReferencePath String requiredposition: 0sets: Path: Original document path.
-Visual SwitchParameter optional: Compare native rendered pages instead of semantic content.
-DifferenceDocument Object requiredposition: 1sets: Document: Caller-owned modified native model.
-ReferenceDocument Object requiredposition: 0sets: Document: Caller-owned original native model.

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.Models.OfficeComparisonReport: Common comparison summary retaining the complete native findings and conversion evidence.