API Reference

Cmdlet

Get-OfficeWordReview

Namespace PSWriteOffice
Inputs
OfficeIMO.Word.WordDocument
Outputs
OfficeIMO.Word.WordReviewReport

Inspects Word comments, threads, tracked revisions, and unsupported review metadata.

Remarks

Inspects Word comments, threads, tracked revisions, and unsupported review metadata.

Examples

Authored help example

Inspect a document review state.

PS>


Get-OfficeWordReview -Path .\Draft.docx
        

Returns a structured WordReviewReport without changing the document.

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

Get-OfficeWordReview -Path <String> [<CommonParameters>]
#
Parameter set: Path

Parameters

Path String requiredposition: 0pipeline: False
Path to the Word document.

Outputs

OfficeIMO.Word.WordReviewReport

Get-OfficeWordReview -Document <WordDocument> [<CommonParameters>]
#
Parameter set: Document

Parameters

Document WordDocument requiredposition: namedpipeline: True (ByValue)
Open Word document instance.

Outputs

OfficeIMO.Word.WordReviewReport