Class PageReportOptions

Options of generating HTML report

Inheritance
object
PageReportOptions
Namespace: AxaFrance.AxeExtended.HtmlReport
Assembly: AxaFrance.AxeExtended.HtmlReport.dll
Syntax
public sealed class PageReportOptions

Fields

| Edit this page View Source

WcagAATags

A and AA rules defined in WCAG 2.0, 2.1 and 2.2 and EN-301-549

Declaration
public static readonly string[] WcagAATags
Field Value
Type Description
string[]

Properties

| Edit this page View Source

AdditionalTags

In the report, show additional tags
Default value: will use additional tags provider to get equivalent RGAA test tags.

Declaration
public TagsProvider AdditionalTags { get; set; }
Property Value
Type Description
TagsProvider
| Edit this page View Source

HighlightColor

Default highlight color for advanced screenshot. default value is Red.

Declaration
public Color HighlightColor { get; set; }
Property Value
Type Description
Color
| Edit this page View Source

HighlightThickness

Default highlight thickness for advanced screenshot. default value is 2.

Declaration
public int HighlightThickness { get; set; }
Property Value
Type Description
int
| Edit this page View Source

OutputFolder

Gets or sets the output folder of the HTML report. If not set, the report will be generated in default temprary folder.

Declaration
public string OutputFolder { get; set; }
Property Value
Type Description
string
| Edit this page View Source

OutputFormat

Gets or sets the output format of the HTML report: Zip Archive or a folder containing HTML report and all resources.

Declaration
public OutputFormat OutputFormat { get; set; }
Property Value
Type Description
OutputFormat
| Edit this page View Source

ReportLanguage

The language should be used in the report. Default is English.

Declaration
public Language ReportLanguage { get; set; }
Property Value
Type Description
Language
| Edit this page View Source

ScoringMode

The mode to calculate the accessbility scoring, default method = Weighted

Declaration
public ScoringMode ScoringMode { get; set; }
Property Value
Type Description
ScoringMode
| Edit this page View Source

ScreenshotIncomplete

If true, the report will include screenshots for all incomplete. Default is true.

Declaration
public bool ScreenshotIncomplete { get; set; }
Property Value
Type Description
bool
| Edit this page View Source

ScreenshotPasses

If true, the report will include screenshots for all passes. Default is false.

Declaration
public bool ScreenshotPasses { get; set; }
Property Value
Type Description
bool
| Edit this page View Source

ScreenshotViolations

If true, the report will include screenshots for all violations. Default is true.

Declaration
public bool ScreenshotViolations { get; set; }
Property Value
Type Description
bool
| Edit this page View Source

Tags

Tags used to be audited by the tool. Default Value: [empty], all rules will be tested. To get the complete list of all tags, refer to: https://www.deque.com/axe/core-documentation/api-documentation/#api-notes Leaving Tag empty means all rules will be tested.

Declaration
public IEnumerable<string> Tags { get; set; }
Property Value
Type Description
IEnumerable<string>
| Edit this page View Source

Title

Title of the report

Declaration
public string Title { get; set; }
Property Value
Type Description
string
| Edit this page View Source

UseAdvancedScreenshot

Gets or sets the value indicating if advanced screenshot should be used. Default is true.

Declaration
public bool UseAdvancedScreenshot { get; set; }
Property Value
Type Description
bool
Remarks

Advanced screenshot is a screenshot of the whole viewport, and the element in question is highlighted. Otherwise, a screenshot of the element in question is taken. Advanced screenshot marks the element in question more clearly, but it takes more space (images are larger).