Cmdlet

Test-OfficeExcelWorkbook

Aliases: ExcelDoctor, ExcelWorkbookDoctor

Module PSWriteOffice

Aliases

ExcelDoctor ExcelWorkbookDoctor

Inputs

OfficeIMO.Excel.ExcelDocument

Outputs

System.Management.Automation.PSObject

Source

TestOfficeExcelWorkbookCommand.cs:25 Edit on GitHub

Runs OfficeIMO workbook diagnostics and optional safe repairs.

Syntax

Test-OfficeExcelWorkbook [-Path] <String> [-Quiet] [-RepairDefinedNames] [-SkipOpenXmlValidation] [<CommonParameters>]

Parameter set: Path

Test-OfficeExcelWorkbook -Document <ExcelDocument> [-Quiet] [-RepairDefinedNames] [-SkipOpenXmlValidation] [<CommonParameters>]

Parameter set: Document

Examples

Authored help example

Gate a generated workbook before sending it to a user.

$doctor = Test-OfficeExcelWorkbook -Path .\Report.xlsx -SkipOpenXmlValidation
if (-not $doctor.Passed) {
    $doctor.Issues |
        Sort-Object Severity,Category,SheetName,Address |
        Format-Table Severity,Category,SheetName,Address,Message,RepairAction
}

Returns OfficeIMO workbook diagnostics for defined names, formulas, tables, drawings, connections, and package validation.

Parameters

-Path String requiredposition: 0aliases: FilePath, InputPathsets: Path: Workbook path.
-Quiet SwitchParameter optional: Return only a Boolean pass/fail value.
-RepairDefinedNames SwitchParameter optional: Repair duplicate, invalid, or broken defined names before reporting.
-SkipOpenXmlValidation SwitchParameter optional: Skip Open XML validator checks.
-Document ExcelDocument requiredpipeline: True (ByValue)sets: Document: Workbook 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

Guides & Samples

Examples

Gate a generated workbook before sending it to a user.

Parameters

Common Parameters