C# API reference

This page is not available in the language you requested. You have been redirected to the English version of the page.

Link to this page copied to clipboard

API reference for the Axe DevTools for Web C# classes and methods

Not for use with personal data

Axe DevTools C# Classes

This page documents the classes which make up Axe DevTools C#

`Deque.AxeDevtools.Selenium`

The interface to the accessibility analysis. Contains configurations that change how the analysis runs, as well as the ability to run it.

static Field	Type	Description
defaultAxeSource	string	The default axe-core string that will be used.

AxeSelenium(OpenQA.Selenium.Remote.RemoteWebDriver, ReportConfiguration?, string)

Create a new AxeSelenium object for a page with specific configuration.

Param	Description
webdriver	Selenium object of the page to test. Should be in the state ready to test.
reportConfiguration	Configuration for various report-specific information. Defaults to `ReportConfiguration.GetDefault()`
axeSource	axe-core source to use. Defaults to `AxeSelenium.defaultAxeSource`

Run the accessibility analysis on the page.

Returns: The report from running axe-core on the page.

var report = new AxeSelenium(driver).Analyze();

Configure axe. Done via axe.configure

Param	Description
spec	Spec object to pass.

Returns: This object for chaining.

var spec = new Spec.Spec