New-OfficeWordComparisonOptions

Namespace PSWriteOffice

Inputs

None

Outputs

OfficeIMO.Word.WordComparisonOptions

Source

Sources/PSWriteOffice/Cmdlets/Word/NewOfficeWordComparisonOptionsCommand.cs:16 Edit on GitHub

Creates discoverable structural comparison settings for Compare-OfficeWordDocument.

Remarks

Creates discoverable structural comparison settings for Compare-OfficeWordDocument.

Examples

Authored help example

Ignore text normalization differences and exclude volatile metadata.

PS>


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

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.

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 <Paragraph>] [-IgnoreCase] [-IgnoreWhitespace] [-IncludeScope <Paragraph>] [<CommonParameters>]

Parameter set: All Parameter Sets

Parameters

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

Outputs

OfficeIMO.Word.WordComparisonOptions