Skip to main content

Search OfficeIMO

Enter a topic, API type, or PowerShell command.

Documentation Search all OfficeIMO/
Cmdlet

New-OfficeWordComparisonOptions

Module
PSWriteOffice
Inputs
None
Outputs
OfficeIMO.Word.WordComparisonOptions

Creates discoverable structural comparison settings for Compare-OfficeDocument.

Syntax

New-OfficeWordComparisonOptions
[-ExcludeScope <WordComparisonScope[]>]
[-IgnoreCase]
[-IgnoreWhitespace]
[-IncludeScope <WordComparisonScope[]>]
[-NoBlockOrder]
[-NoBookmarks]
[-NoCommentAuthors]
[-NoCommentReplies]
[-NoCommentResolvedState]
[-NoComments]
[-NoCommentTargets]
[-NoCommentText]
[-NoContentControls]
[-NoEffectiveFormatting]
[-NoFields]
[-NoGeneratedIds]
[-NoHyperlinks]
[-NoImages]
[-NoLists]
[-NoParagraphStyleIds]
[-NoRevisionAuthors]
[-NoRevisionLocations]
[-NoRevisions]
[-NoRevisionText]
[-NoRunFormatting]
[-NoRunStyleIds]
[-NoShapes]
[-NoVolatileMetadata]
[<CommonParameters>]
#
Parameter set: Default

Examples

Ignore text normalization differences and exclude volatile metadata.

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

Parameters

-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
-NoBlockOrder SwitchParameter optional
Compare document block order.
-NoBookmarks SwitchParameter optional
Compare bookmarks.
-NoCommentAuthors SwitchParameter optional
Compare comment authors.
-NoCommentReplies SwitchParameter optional
Compare comment replies.
-NoCommentResolvedState SwitchParameter optional
Compare comment resolved state.
-NoComments SwitchParameter optional
Compare comments.
-NoCommentTargets SwitchParameter optional
Compare comment targets.
-NoCommentText SwitchParameter optional
Compare comment text.
-NoContentControls SwitchParameter optional
Compare content controls.
-NoEffectiveFormatting SwitchParameter optional
Compare resolved effective formatting.
-NoFields SwitchParameter optional
Compare fields.
-NoGeneratedIds SwitchParameter optional
Compare generated identifiers.
Compare hyperlinks.
-NoImages SwitchParameter optional
Compare images.
-NoLists SwitchParameter optional
Compare lists.
-NoParagraphStyleIds SwitchParameter optional
Compare paragraph style identifiers.
-NoRevisionAuthors SwitchParameter optional
Compare revision authors.
-NoRevisionLocations SwitchParameter optional
Compare revision locations.
-NoRevisions SwitchParameter optional
Compare tracked revisions.
-NoRevisionText SwitchParameter optional
Compare revision text.
-NoRunFormatting SwitchParameter optional
Compare direct run formatting.
-NoRunStyleIds SwitchParameter optional
Compare run style identifiers.
-NoShapes SwitchParameter optional
Compare supported shapes.
-NoVolatileMetadata SwitchParameter optional
Compare volatile timestamps and metadata.

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.