C# API-referentie

Axe DevTools C# Klassen

Deze pagina documenteert de klassen die deel uitmaken van Axe DevTools C#

class Deque.AxeDevtools.Selenium.AxeSelenium

De interface naar axe. Bevat configuraties om te wijzigen hoe axe draait en de mogelijkheid om axe te draaien.

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

Creëer een nieuw AxeSelenium-object voor een pagina met specifieke configuratie.

RapportResultatenAnalyseer()

Voer axe uit op de pagina.

Retourneert: Het rapport van het uitvoeren van axe-core op de pagina.

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

AxeSelenium Configureer(Spec)

Configureer axe. Gedaane via axe.configure

Retourneert: Dit object voor chaining.

var spec = new Spec.Spec {
    Checks = new Spec.Check[] {
        new Spec.Check() {
            Id = "dylang",
            Options = (object) new string[] { "dylan" },
            Evaluate = @"function (node, options) {
              var lang = (node.getAttribute('lang') || '').trim().toLowerCase();
              var xmlLang = (node.getAttribute('xml:lang') || '').trim().toLowerCase();
              var invalid = [];
              (options || []).forEach(function(cc) {
                cc = cc.toLowerCase();
                if (lang && (lang === cc || lang.indexOf(cc.toLowerCase() + '-') === 0)) {
                  lang = null;
                }
                if (xmlLang && (xmlLang === cc || xmlLang.indexOf(cc.toLowerCase() + '-') === 0)) {
                  xmlLang = null;
                }
              });
              if (xmlLang) {
                invalid.push('xml:lang='' + xmlLang + ''');
              }
              if (lang) {
                invalid.push('lang='' + lang + ''');
              }
              if (invalid.length) {
                this.data(invalid);
                return true;
              }
              return false;
            }"
        }
    },
    Rules = new Spec.Rule[] {
        new Spec.Rule() {
            Id = "dylang",
            Selector = "html",
            Tags = new string[] { "wcag2aa" },
            All = new string[0],
            Any = new string[0],
            None = new string[] { "dylang" }
        }
    }
};
var report = new AxeSelenium(driver)
  .Configure(spec)
  .Analyze()

AxeSeleniumDesactiverenRegels(string[])

Schakel enkele regels uit bij het uitvoeren van axe.

Retourneert: Dit object voor chaining.

var report = new AxeSelenium(driver)
  .DisablingRules("html-has-lang", "label")
  .Analyze()

AxeSeleniumUitzonderen(string[])

Specificeer een deel van de pagina om uit te zonderen bij het uitvoeren van axe.

Resultaten: Dit object is bedoeld voor chaining.

var report = new AxeSelenium(driver)
  .Excluding(".third-party-ad", ".iframe1")
  .Analyze()

AxeSeleniumInclusief(string[])

Specificeer een deel van de pagina om axe op uit te voeren.

Resultaten: Dit object is bedoeld voor chaining.

var report = new AxeSelenium(driver)
  .Including(".sidebar", ".some-class")
  .Analyze()

AxeSelenium RunOpties(RunOpties)

Specificeer RunOptions om door te geven aan axe bij het aanroepen van axe.run.

Resultaten: Dit object is bedoeld voor chaining.

var options = new RunOptions.RunOptions {
  IFrames = false,
  RunOnly = RunOptions.RunOnly.Tags(RunOptions.TagType.Wcag2a)
};
var report = new AxeSelenium(driver)
  .RunOptions(options)
  .Analyze()

AxeSeleniumMetConfigBestand(string)

Stel in waar het configuratiebestand te vinden is. Standaardpad is config/axe-ruleset.json of $AXE_RULESET_PATH.

Resultaten: Dit object is bedoeld voor chaining.

var report = new AxeSelenium(driver)
  .WithConfigFile("path/to/file.json")
  .Analyze();

AxeSeleniumMetRegels(string[])

Specificeer regels (op id) om te gebruiken bij het uitvoeren van axe.

Resultaten: Dit object is bedoeld voor chaining.

var report = new AxeSelenium(driver)
  .WithRules("document-title", "label")
  .WithRules("html-has-lang")
  .Analyze()

AxeSeleniumMetRegelet(string, bool)

Gebruik een specifieke set (d.w.z. wcag2.1, 508).

Retourneert: Dit object voor chaining.

var report = new AxeSelenium(driver)
  .WithRuleset("508", true)
  .Analyze()

AxeSelenium MetTags(TagType[])

Specificeer regels (op tag) om te gebruiken bij het uitvoeren van axe.

Retourneert: Dit object voor chaining.

var report = new AxeSelenium(driver)
  .WithTags(RunTagType.BestPractice)
  .Analyze()

Omgevingsvariabelen

Deze omgevingsvariabelen stellen je in staat om de gebruiksdienst te configureren en de eigenschappen van gerapporteerde gebeurtenissen te wijzigen.

AxeSeleniumTrackingInschakelen(bool)

Kies ervoor om gegevens al dan niet naar de gebruiksdienst te verzenden.

Retourneert: Dit object voor chaining.

AxeSeleniumTrackingUrlInstellen(string)

Stel in waar gebruiksstatistieken worden verzonden. Standaard is https://usage.deque.com

Retourneert: Dit object voor chaining.

AxeSeleniumOnderscheidIdInstellen(string)

Stel een onderscheidend id in dat wordt gebruikt bij het verzenden van gebruiksstatistieken.

Retourneert: Dit object voor chaining.

class Deque.AxeDevtools.Selenium.ReportConfiguration

Configureert rapport-specifieke informatie zoals de naam van de testreeks of gebruikersagent-informatie

statisch RapportConfiguratieGetDefault()

Haalt de huidige standaardconfiguratie op. Let op dat de standaard kan worden gewijzigd.

Retourneert: De huidige standaard.

statisch void ResetDefault()

Herstelt de standaard naar de oorspronkelijke staat.

void SetAsDefault()

Stelt dit object in als de standaard.

ReportConfiguration.GetDefault()
  .TestSuiteName("my-tests")
  .UIState("home-page")
  .SetAsDefault();

RapportConfiguratieTestMachine(string)

Stelt de machine in waarop deze tests zijn uitgevoerd.

Retourneert: Dit object voor chaining.

RapportConfiguratieTestSuiteName(string)

Stelt de naam van de test suite in.

Retourneert: Dit object voor chaining.

RapportConfiguratieUIState(string)

Specificeer de UI-status voor deze reeks tests. Gebruikt als ID.

Retourneert: Dit object voor chaining.

RapportConfiguratieUserAgent(string)

Stel de user agent in die gebruikt wordt bij het testen.

Retourneert: Dit object voor chaining.

class Deque.AxeDevtools.Selenium.Results.Check

Het resultaat van het uitvoeren van een axe-check.

class Deque.AxeDevtools.Selenium.Results.CheckedNode

Een HTML-node die door een regel is gecontroleerd.

class Deque.AxeDevtools.Selenium.Results.Node

Specificeert een specifieke HTML-node.

class Deque.AxeDevtools.Selenium.Results.Platform

Het platform waarop een test is uitgevoerd.

class Deque.AxeDevtools.Selenium.Results.ReportResults

Resultaten van een test die compatibel zijn met het rapportageformaat.

var axe = new AxeSelenium(driver, ReportConfiguration.GetDefault().UIState("UIState"));
var res = axe.Analyze();
File.WriteAllText(reportPath, JsonConvert.SerializeObject(res));

class Deque.AxeDevtools.Selenium.Results.Rule

Resultaat voor een enkele regel.

class Deque.AxeDevtools.Selenium.Results.TestEngine

Informatie over de axe-core engine waarop de test werd uitgevoerd.

class Deque.AxeDevtools.Selenium.Results.TestEnvironment

Informatie over de omgeving waarin de test werd uitgevoerd.

class Deque.AxeDevtools.Selenium.Results.TestResults

Resultaten verkregen door het uitvoeren van axe op de pagina.

class Deque.AxeDevtools.Selenium.Results.TestRunner

Naam van de testrunner.

class Deque.AxeDevtools.Selenium.Results.TestSubject

Informatie over wat getest wordt.

class Deque.AxeDevtools.Selenium.RunOptions.Context

Specificeer welk element wel en welk niet getest moet worden.

void Excluding(string[])

Voeg een selectorset toe voor elementen die niet getest moeten worden.

void Including(string[])

Voeg een selectorset toe voor elementen die getest moeten worden.

enum Deque.AxeDevtools.Selenium.RunOptions.ResultGroup

• Geslaagd
• Overtredingen
• Onvolledig
• Niet van toepassing

class Deque.AxeDevtools.Selenium.RunOptions.RuleStatus

Schakelt een regel in of uit.

class Deque.AxeDevtools.Selenium.RunOptions.RunOnly

Beperk welke regels worden uitgevoerd, op basis van namen of tags.

static AlleenUitvoerenRegels(string[])

Maak een beperker voor regels op basis van id's.

Retourneert: Het RunOnly-object.

statische AlleenUitvoeren Tags(TypeTag[])

Construeer een beperking voor regels op basis van tags.

Geeft: Het RunOnly object.

enum Deque.AxeDevtools.Selenium.RunOptions.RunOnlyType

• Regel
• Regels
• Tag
• Tags

class Deque.AxeDevtools.Selenium.RunOptions.RunOptions

Een flexibele configuratie voor hoe axe werkt.

enum Deque.AxeDevtools.Selenium.RunOptions.TagType

• Wcag2a
• Wcag2aa
• Wcag2aaa
• Wcag21a
• Wcag21aa
• Wcag21aaa
• Wcag22a
• Wcag22aa
• Wcag22aaa
• Section508
• TTv5
• EN301549
• RGAAv4
• BestPractice

class Deque.AxeDevtools.Selenium.Spec.Check

Wordt gebruikt om controles toe te voegen aan de lijst met controles die door regels worden gebruikt, of om de eigenschappen van bestaande controles te overschrijven.

class Deque.AxeDevtools.Selenium.Spec.Rule

Wordt gebruikt om regels toe te voegen aan de bestaande set regels, of om de eigenschappen van bestaande regels te overschrijven.

class Deque.AxeDevtools.Selenium.Spec.Spec

Confi gureert het formaat van de gegevens die door axe worden gebruikt. Dit kan worden gebruikt om nieuwe regels toe te voegen, die moeten worden geregistreerd bij de bibliotheek om uit te voeren.