Test-OfficeExcelAccessibility

Aliases: ExcelAccessibility

Namespace PSWriteOffice

Aliases

ExcelAccessibility

Inputs

OfficeIMO.Excel.ExcelDocument

Outputs

System.Management.Automation.PSObject

Source

Sources/PSWriteOffice/Cmdlets/Excel/TestOfficeExcelAccessibilityCommand.cs:19 Edit on GitHub

Checks workbook accessibility and compliance signals.

Remarks

Checks workbook accessibility and compliance signals.

Examples

Authored help example

Review workbook accessibility signals before exporting a report.

PS>


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

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-OfficeExcelAccessibility -InputPath <String> [-Quiet] [<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.

Outputs

System.Management.Automation.PSObject

Test-OfficeExcelAccessibility -Document <ExcelDocument> [-Quiet] [<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.

Outputs

System.Management.Automation.PSObject