Skip to main content

Search OfficeIMO

Enter a topic, API type, or PowerShell command.

Documentation Search all OfficeIMO/
Class

ExcelAccessibilityOptions

OfficeIMO.Excel

Namespace
OfficeIMO.Excel
Assembly
OfficeIMO.Excel
Source revision
ba882f6b0d07 with working tree changes
Modifiers
sealed

Options controlling Excel workbook accessibility inspection.

Inheritance

  • object
  • ExcelAccessibilityOptions

Remarks

The rules follow the Excel checks in Microsoft's Office Accessibility Checker: alternative text, table header rows, merged cells, default sheet names, hidden sheets, hyperlink text, text contrast and blank cells used for layout.

Usage

Explore 2 API references to this type

This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.

Returned or exposed by 1

Accepted by parameters 1

Constructors

public ExcelAccessibilityOptions() #

Methods

public static ExcelAccessibilityOptions ForProfile(OfficeAccessibilityPolicyProfile profile) #

Creates options initialized for a built-in profile.

Parameters

profile OfficeIMO.OfficeAccessibilityPolicyProfile required

Properties

public OfficeAccessibilityPolicyProfile Profile { get; set; } #

Selected policy profile. Strict turns structural warnings into errors; heuristic findings stay warnings.

public bool RequireDocumentTitle { get; set; } #

Whether the workbook must define a document title. Defaults to false; the Strict profile turns it on.

public bool RequireAlternativeText { get; set; } #

Whether pictures, charts and shapes need alternative text unless marked decorative. Defaults to true.

public bool RequireTableHeaders { get; set; } #

Whether Excel tables need a header row. Defaults to true.

public bool CheckMergedCells { get; set; } #

Whether merged cell ranges are reported. Defaults to true.

public bool CheckDefaultSheetNames { get; set; } #

Whether worksheets with content that keep a default name such as Sheet1 are reported. Defaults to true.

public bool CheckHiddenSheets { get; set; } #

Whether hidden or very hidden worksheets that contain cell values are reported. Defaults to true.

public bool CheckContrast { get; set; } #

Whether cell font colours are checked against the cell fill. Defaults to true.

public bool CheckBlankCellLayout { get; set; } #

Whether blank rows and columns inside a sheet's data area are reported as likely spacing. Defaults to true.

public double MinimumTextContrastRatio { get; set; } #

Minimum contrast ratio for normal text. Defaults to the WCAG AA value 4.5.

public double MinimumLargeTextContrastRatio { get; set; } #

Minimum contrast ratio for large text (18 pt, or 14 pt bold). Defaults to the WCAG AA value 3.

public int MaximumCellCount { get; set; } #

Maximum number of cells read per worksheet by the contrast, content and blank-layout checks. Defaults to 1,000,000.