Get Started

API Reference

Cmdlet

Test-OfficeExcelWorkbook

Aliases: ExcelDoctor, ExcelWorkbookDoctor
Namespace PSWriteOffice
Aliases
ExcelDoctor ExcelWorkbookDoctor
Inputs
OfficeIMO.Excel.ExcelDocument
Outputs
System.Management.Automation.PSObject
Source
Sources/PSWriteOffice/Cmdlets/Excel/TestOfficeExcelWorkbookCommand.cs:22 Edit on GitHub

Runs OfficeIMO workbook diagnostics and optional safe repairs.

Remarks

Runs OfficeIMO workbook diagnostics and optional safe repairs.

Examples

Authored help example

Gate a generated workbook before sending it to a user.

PS>


$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.

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

Test-OfficeExcelWorkbook -InputPath <String> [-Quiet] [-RepairDefinedNames] [-SkipOpenXmlValidation] [<CommonParameters>]
#
Parameter set: Path

Parameters

InputPath String requiredposition: 0pipeline: Falsealiases: FilePath, Path
Workbook path.
Quiet SwitchParameter optionalposition: namedpipeline: False
Return only a Boolean pass/fail value.
RepairDefinedNames SwitchParameter optionalposition: namedpipeline: False
Repair duplicate, invalid, or broken defined names before reporting.
SkipOpenXmlValidation SwitchParameter optionalposition: namedpipeline: False
Skip Open XML validator checks.

Outputs

System.Management.Automation.PSObject

Test-OfficeExcelWorkbook -Document <ExcelDocument> [-Quiet] [-RepairDefinedNames] [-SkipOpenXmlValidation] [<CommonParameters>]
#
Parameter set: Document

Parameters

Document ExcelDocument requiredposition: namedpipeline: True (ByValue)
Workbook document.
Quiet SwitchParameter optionalposition: namedpipeline: False
Return only a Boolean pass/fail value.
RepairDefinedNames SwitchParameter optionalposition: namedpipeline: False
Repair duplicate, invalid, or broken defined names before reporting.
SkipOpenXmlValidation SwitchParameter optionalposition: namedpipeline: False
Skip Open XML validator checks.

Outputs

System.Management.Automation.PSObject