Cmdlet

New-OfficeWordComparisonOptions

Module: PSWriteOffice
Inputs: None
Outputs: OfficeIMO.Word.WordComparisonOptions
Source: NewOfficeWordComparisonOptionsCommand.cs:16 Edit on GitHub

Creates discoverable structural comparison settings for Compare-OfficeWordDocument.

Syntax

New-OfficeWordComparisonOptions
[-CompareBlockOrder]
[-CompareBookmarks]
[-CompareCommentAuthors]
[-CompareCommentReplies]
[-CompareCommentResolvedState]
[-CompareComments]
[-CompareCommentTargets]
[-CompareCommentText]
[-CompareContentControls]
[-CompareEffectiveFormatting]
[-CompareFields]
[-CompareGeneratedIds]
[-CompareHyperlinks]
[-CompareImages]
[-CompareLists]
[-CompareParagraphStyleIds]
[-CompareRevisionAuthors]
[-CompareRevisionLocations]
[-CompareRevisions]
[-CompareRevisionText]
[-CompareRunFormatting]
[-CompareRunStyleIds]
[-CompareShapes]
[-CompareVolatileMetadata]
[-ExcludeScope <WordComparisonScope[]>]
[-IgnoreCase]
[-IgnoreWhitespace]
[-IncludeScope <WordComparisonScope[]>]
[<CommonParameters>]

Parameter set: All Parameter Sets

Examples

Ignore text normalization differences and exclude volatile metadata.

$options = New-OfficeWordComparisonOptions -IgnoreWhitespace -IgnoreCase -CompareVolatileMetadata:$false
Compare-OfficeWordDocument -ReferencePath .\Before.docx -DifferencePath .\After.docx -Options $options

Parameters

-CompareBlockOrder SwitchParameter optional: Compare document block order.
-CompareBookmarks SwitchParameter optional: Compare bookmarks.
-CompareCommentAuthors SwitchParameter optional: Compare comment authors.
-CompareCommentReplies SwitchParameter optional: Compare comment replies.
-CompareCommentResolvedState SwitchParameter optional: Compare comment resolved state.
-CompareComments SwitchParameter optional: Compare comments.
-CompareCommentTargets SwitchParameter optional: Compare comment targets.
-CompareCommentText SwitchParameter optional: Compare comment text.
-CompareContentControls SwitchParameter optional: Compare content controls.
-CompareEffectiveFormatting SwitchParameter optional: Compare resolved effective formatting.
-CompareFields SwitchParameter optional: Compare fields.
-CompareGeneratedIds SwitchParameter optional: Compare generated identifiers.
-CompareHyperlinks SwitchParameter optional: Compare hyperlinks.
-CompareImages SwitchParameter optional: Compare images.
-CompareLists SwitchParameter optional: Compare lists.
-CompareParagraphStyleIds SwitchParameter optional: Compare paragraph style identifiers.
-CompareRevisionAuthors SwitchParameter optional: Compare revision authors.
-CompareRevisionLocations SwitchParameter optional: Compare revision locations.
-CompareRevisions SwitchParameter optional: Compare tracked revisions.
-CompareRevisionText SwitchParameter optional: Compare revision text.
-CompareRunFormatting SwitchParameter optional: Compare direct run formatting.
-CompareRunStyleIds SwitchParameter optional: Compare run style identifiers.
-CompareShapes SwitchParameter optional: Compare supported shapes.
-CompareVolatileMetadata SwitchParameter optional: Compare volatile timestamps and metadata.
-ExcludeScope WordComparisonScope[] optional: Remove these comparison scopes from results.; Possible values: Paragraph, Run, Field, ContentControl, Bookmark, Hyperlink, List, Comment, Revision, Table, TableRow, TableCell, Image, Shape
-IgnoreCase SwitchParameter optional: Ignore character casing.
-IgnoreWhitespace SwitchParameter optional: Ignore differences caused only by whitespace runs.
-IncludeScope WordComparisonScope[] optional: Limit results to these comparison scopes.; Possible values: Paragraph, Run, Field, ContentControl, Bookmark, Hyperlink, List, Comment, Revision, Table, TableRow, TableCell, Image, Shape

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.