Class OverallReportBuilder

Builder to be used to build overall report. Overall report represents all scanned pages within a user journey.

Inheritance

object

OverallReportBuilder

Namespace: AxaFrance.AxeExtended.HtmlReport

Assembly: AxaFrance.AxeExtended.HtmlReport.dll

Syntax

public class OverallReportBuilder

Constructors

OverallReportBuilder()

Initialize OverallReportBuilder with default options.

Declaration

public OverallReportBuilder()

OverallReportBuilder(PageReportOptions)

Initialize OverallReportBuilder with options. This options will be applied to all page reports.

Declaration

public OverallReportBuilder(PageReportOptions options)

Parameters

Type	Name	Description
PageReportOptions	options

Properties

Options

Options that will be used for all page reports.

Declaration

public PageReportOptions Options { get; }

Property Value

Type	Description
PageReportOptions

PageBuilders

The list of page builders used to hold evaluations of each pages.

Declaration

public List<PageReportBuilder> PageBuilders { get; }

Property Value

Type	Description
List<PageReportBuilder>

Result

Overall result of all scanned pages.

Declaration

public AxeOverallResult Result { get; }

Property Value

Type	Description
AxeOverallResult

Methods

Build()

Build overall report from scanned pages which are built by PageReportBuilder.

Declaration

public OverallReportBuilder Build()

Returns

Type	Description
OverallReportBuilder	The builder

Export(string)

Export overall report to HTML or Zip format.

Declaration

public string Export(string fileName = null)

Parameters

Type	Name	Description
string	fileName	the filename of export report, default value "index.html"

Returns

Type	Description
string	the complete path of report

WithDefaultOptions(PageReportOptions)

Set default options for all page report

Declaration

public OverallReportBuilder WithDefaultOptions(PageReportOptions options)

Parameters

Type	Name	Description
PageReportOptions	options	The default options for each page report to be applied.

Returns

Type	Description
OverallReportBuilder