Get-OfficeExcelCommentAudit

Aliases: ExcelCommentAudit, ExcelCommentsAudit

Namespace PSWriteOffice

Aliases

ExcelCommentAudit ExcelCommentsAudit

Inputs

OfficeIMO.Excel.ExcelDocument

Outputs

System.Management.Automation.PSObject

Source

Sources/PSWriteOffice/Cmdlets/Excel/GetOfficeExcelCommentAuditCommand.cs:18 Edit on GitHub

Audits legacy notes and threaded comments preserved in an Excel workbook.

Remarks

Audits legacy notes and threaded comments preserved in an Excel workbook.

Examples

Authored help example

Review comments before distributing a workbook.

PS>


$audit = Get-OfficeExcelCommentAudit -Path .\ReviewWorkbook.xlsx -IncludeComments
            $audit.Comments | Sort-Object SheetName,CellReference | Format-Table SheetName,CellReference,Author,Text
            $audit.Issues | Format-Table Severity,Category,SheetName,Address,Message

Returns workbook-level note/threaded-comment counts, optional comment records, and metadata issues such as missing authors or orphaned threaded replies.

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-OfficeExcelCommentAudit [-IncludeComments] -InputPath <String> [<CommonParameters>]

Parameter set: Path

Parameters

IncludeComments SwitchParameter optionalposition: namedpipeline: False: Include legacy and threaded comment records in the output.
InputPath String requiredposition: 0pipeline: Falsealiases: FilePath, Path: Workbook path.

Outputs

System.Management.Automation.PSObject

Get-OfficeExcelCommentAudit -Document <ExcelDocument> [-IncludeComments] [<CommonParameters>]

Parameter set: Document

Parameters

Document ExcelDocument requiredposition: namedpipeline: True (ByValue): Workbook document.
IncludeComments SwitchParameter optionalposition: namedpipeline: False: Include legacy and threaded comment records in the output.

Outputs

System.Management.Automation.PSObject