Cmdlet

Test-OfficeExcelAccessibility

Aliases: ExcelAccessibility

Module PSWriteOffice

Aliases

ExcelAccessibility

Inputs

OfficeIMO.Excel.ExcelDocument

Outputs

System.Management.Automation.PSObject

Source

TestOfficeExcelAccessibilityCommand.cs:22 Edit on GitHub

Checks workbook accessibility and compliance signals.

Syntax

Test-OfficeExcelAccessibility [-Path] <String> [-Quiet] [<CommonParameters>]

Parameter set: Path

Test-OfficeExcelAccessibility -Document <ExcelDocument> [-Quiet] [<CommonParameters>]

Parameter set: Document

Examples

Authored help example

Review workbook accessibility signals before exporting a report.

$accessibility = Test-OfficeExcelAccessibility -Path .\Dashboard.xlsx
$accessibility.Findings |
    Sort-Object Severity,Category,SheetName,Address |
    Format-Table Severity,Category,SheetName,Address,Message

Reports OfficeIMO accessibility findings such as missing image alt text, hidden sheets, merged ranges, and tables without header rows.

Parameters

-Path String requiredposition: 0aliases: FilePath, InputPathsets: Path: Workbook path.
-Quiet SwitchParameter optional: Return only a Boolean pass/fail value.
-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

Review workbook accessibility signals before exporting a report.

Parameters

Common Parameters