Class
OfficeAccessibilityReport
OfficeIMO
Structured accessibility inspection result for a Word or PowerPoint document.
Inheritance
- object
- OfficeAccessibilityReport
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 2
Methods
public OfficeAccessibilityReport EnsureCompliant(bool includeWarnings = false) #Throws OfficeAccessibilityException when the report contains errors, or warnings when requested.
Parameters
- includeWarnings bool = false
Returns
OfficeAccessibilityReportpublic void SaveJson(string path, bool indented = true) #Writes the JSON report to disk, creating the destination directory when needed.
Parameters
- path string
- indented bool = true
public string ToJson(bool indented = true) #Serializes the report as dependency-free JSON.
Parameters
- indented bool = true
Returns
stringInherited Methods
Properties
public int SchemaVersion { get; } #Version of the OfficeAccessibilityReport.ToJson schema.
public string Format { get; } #The inspected format, such as Word or PowerPoint.
public OfficeAccessibilityPolicyProfile Profile { get; } #Policy profile used for inspection.
public IReadOnlyList<OfficeAccessibilityFinding> Findings { get; } #Findings in document order, after the document-level findings.
public bool IsSuccessful { get; } #Whether no policy errors were found.