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 voor de toegankelijkheidsanalyse. Bevat configuraties die veranderen hoe de analyse wordt uitgevoerd, evenals de mogelijkheid om deze uit te voeren.

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

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

RapportResultatenAnalyseer()

Voer de toegankelijkheidsanalyse op de pagina uit.

Geeft: 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

Geeft: 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 de analyse.

Geeft: Dit object voor chaining.

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

AxeSeleniumUitsluiten(string)

Specificeer een deel van de pagina om uit te sluiten van de analyse. Om meerdere niet-gerelateerde delen van de pagina uit te sluiten, roep Excluding één keer aan voor elk deel.

Geeft: Dit object voor chaining.

var report = new AxeSelenium(driver)
  .Excluding(".cookie-banner")
  .Excluding(".ad-slot")
  .Analyze()

AxeSeleniumUitsluiten(params string[])

Specificeer een element binnen een of meer geneste iframes om uit te sluiten. Elke selector behalve de laatste komt overeen met één niveau van iframe-nesting; de laatste komt overeen met het element dat in het binnenste iframe moet worden uitgesloten.

Omdat de parameter is gedeclareerd als params, zijn Excluding(".iframe1", ".third-party-ad") en Excluding(new[] { ".iframe1", ".third-party-ad" }) dezelfde oproep. Hoe dan ook vormen de selectors een enkele iframe-selector, geen afzonderlijke uitsluitingen. Om meerdere niet-gerelateerde delen van de pagina uit te sluiten, roep Excluding(string) één keer aan voor elk deel.

Geeft: Dit object voor chaining.

// Exclude .third-party-ad inside the iframe matched by .iframe1
var report = new AxeSelenium(driver)
  .Excluding(".iframe1", ".third-party-ad")
  .Analyze()

AxeSeleniumUitsluiten(string[][])

Specificeer een element binnen een of meer geneste shadow-DOM-bomen om uit te sluiten. Passeer per oproep een innerlijke array. Binnen die array komt elke selector, behalve de laatste, overeen met een shadow-host, en de laatste komt overeen met het element dat in de binnenste shadow-root moet worden uitgesloten.

Geeft: Dit object voor chaining.

// Exclude #shadow-button inside the shadow root attached to #shadow-host
var selector = new string[][] {
  new string[] { "#shadow-host", "#shadow-button" }
};
var report = new AxeSelenium(driver)
  .Excluding(selector)
  .Analyze()

AxeSelenium Uitsluiten(FromFrames)

Specificeer een element binnen een of meer geneste iframes om uit te sluiten, met gebruik van een expliciete FromFrames-selector.

Geeft: Dit object voor chaining.

// Exclude the form inside the #payment-frame iframe
var report = new AxeSelenium(driver)
  .Excluding(new FromFrames("#payment-frame", "form"))
  .Analyze()

AxeSelenium Uitsluiten(FromShadowDom)

Specificeer een element binnen een of meer geneste shadow-DOM-bomen om uit te sluiten, met gebruik van een expliciete FromShadowDom-selector.

Omdat axe-core elementen vergelijkt met de afgevlakte DOM-boom, selecteert het kiezen van een shadow-DOM-knoop ook de eventuele afstammelingen die door een <slot>-element zijn ingevoegd.

Geeft: Dit object voor chaining.

// Exclude the #search form inside the shadow root attached to .app-header
var report = new AxeSelenium(driver)
  .Excluding(new FromShadowDom(".app-header", "form#search"))
  .Analyze()

AxeSeleniumUitsluiten(params object[])

Specificeer een selector die gewone CSS-selectors met FromFrames of FromShadowDom objecten vermengt, voor situaties die de andere overloads niet kunnen uitdrukken.

Deze overload wordt alleen geselecteerd wanneer de oproep meer dan één argument doorgeeft, of een enkel argument dat niet een van de bovengenoemde typen is. Door één enkele FromFrames of FromShadowDom door te geven, selecteert men in plaats daarvan Excluding(FromFrames) of Excluding(FromShadowDom).

Om een iframe te bereiken dat zich binnen een shadow-root bevindt, moet de FromShadowDom-selector genest zijn binnen de FromFrames-selector; het omgekeerde veroorzaakt een fout.

Geeft: Dit object voor chaining.

// Exclude .target inside the shadow root attached to #host, inside the #frame iframe
var report = new AxeSelenium(driver)
  .Excluding("#frame", new FromShadowDom("#host", ".target"))
  .Analyze()

AxeSeleniumInclusief(string)

Specificeer een deel van de pagina om te analyseren. Om verschillende niet-gerelateerde delen van de pagina te analyseren, roep Including één keer aan voor elk deel.

Geeft: Dit object voor chaining.

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

AxeSeleniumInclusief(params string[])

Specificeer een element binnen een of meer geneste iframes om te testen. Elke selector behalve de laatste komt overeen met één niveau van iframe-nesting; de laatste komt overeen met het element dat in het binnenste iframe moet worden getest.

Omdat de parameter is gedeclareerd als params, zijn Including(".sidebar-frame", ".some-class") en Including(new[] { ".sidebar-frame", ".some-class" }) dezelfde oproep. Hoe dan ook vormen de selectors een enkele iframe-selector, geen afzonderlijke inclusies. Om meerdere niet-gerelateerde delen van de pagina te testen, roep Including(string) één keer aan voor elk deel.

Geeft: Dit object voor chaining.

// Test .some-class inside the iframe matched by .sidebar-frame
var report = new AxeSelenium(driver)
  .Including(".sidebar-frame", ".some-class")
  .Analyze()

AxeSeleniumInclusief(string[][])

Specificeer een element binnen een of meer geneste shadow-DOM-bomen om te testen. Passeer per oproep een innerlijke array. Binnen die array komt elke selector, behalve de laatste, overeen met een shadow-host, en de laatste komt overeen met het element dat in de binnenste shadow-root moet worden getest.

Geeft: Dit object voor chaining.

// Test #shadow-button inside the shadow root attached to #shadow-host
var selector = new string[][] {
  new string[] { "#shadow-host", "#shadow-button" }
};
var report = new AxeSelenium(driver)
  .Including(selector)
  .Analyze()

AxeSelenium Inclusief(FromFrames)

Specificeer een element binnen een of meer geneste iframes om te testen, met gebruik van een expliciete FromFrames-selector.

Geeft: Dit object voor chaining.

// Test the form inside the #payment-frame iframe
var report = new AxeSelenium(driver)
  .Including(new FromFrames("#payment-frame", "form"))
  .Analyze()

AxeSelenium Inbegrepen(FromShadowDom)

Specificeer een element binnen één of meer geneste shadow DOM-bomen om te testen, met behulp van een expliciete FromShadowDom selector.

Omdat axe-core elementen vergelijkt met de afgevlakte DOM-boom, selecteert het kiezen van een shadow DOM-knooppunt ook alle afstammelingen die door een <slot> element zijn ingevoegd.

Geeft: Dit object voor chaining.

// Test the #search form inside the shadow root attached to .app-header
var report = new AxeSelenium(driver)
  .Including(new FromShadowDom(".app-header", "form#search"))
  .Analyze()

AxeSeleniumInbegrepen(params object[])

Specificeer een selector die reguliere CSS-selectors mengt met FromFrames of FromShadowDom objecten, voor gevallen die de andere overloads niet kunnen uitdrukken.

Deze overload wordt alleen geselecteerd wanneer de oproep meer dan één argument doorgeeft, of een enkel argument dat niet een van de bovenstaande typen is. Het doorgeven van een enkele FromFrames of FromShadowDom selecteert in plaats daarvan Including(FromFrames) of Including(FromShadowDom).

Om een iframe te bereiken dat zich binnen een shadow root bevindt, moet de FromShadowDom selector genest zijn binnen de FromFrames selector; het omgekeerde veroorzaakt een fout.

Geeft: Dit object voor chaining.

// Test .target inside the shadow root attached to #host, inside the #frame iframe
var report = new AxeSelenium(driver)
  .Including("#frame", new FromShadowDom("#host", ".target"))
  .Analyze()

AxeSelenium RunOpties(RunOpties)

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

Geeft: Dit object 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.

Geeft: Dit object 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 de analyse.

Geeft: Dit object 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).

Geeft: Dit object voor chaining.

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

AxeSelenium MetTags(TypeTag[])

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

Geeft: 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 wel of geen gegevens naar de gebruiksservice te sturen. Verzenden is standaard ingeschakeld.

Geeft: Dit object voor chaining.

AxeSeleniumTrackingUrlInstellen(string)

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

Geeft: Dit object voor chaining.

AxeSeleniumOnderscheidIdInstellen(string)

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

Geeft: 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.

Geeft: 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.

Geeft: Dit object voor chaining.

RapportConfiguratieTestSuiteName(string)

Stelt de naam van de test suite in.

Geeft: Dit object voor chaining.

RapportConfiguratieUIState(string)

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

Geeft: Dit object voor chaining.

RapportConfiguratieUserAgent(string)

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

Geeft: Dit object voor chaining.

class Deque.AxeDevtools.Selenium.Results.Check

Het resultaat van het uitvoeren van een controle.

class Deque.AxeDevtools.Selenium.Results.CheckedNode

Een HTML-node die door een regel is gecontroleerd.

class Deque.AxeDevtools.Results.FromFrames

Een selector die een element binnen één of meer geneste iframes target. Geef deze door aan Including(FromFrames) of Excluding(FromFrames).

FromFrames(params object[])

var report = new AxeSelenium(driver)
  .Including(new FromFrames("iframe#outer", "iframe#inner", "form"))
  .Analyze()

class Deque.AxeDevtools.Results.FromShadowDom

Een selector die een element binnen één of meer geneste shadow DOM-bomen target. Geef deze door aan Including(FromShadowDom) of Excluding(FromShadowDom).

FromShadowDom(params string[])

var report = new AxeSelenium(driver)
  .Including(new FromShadowDom("app-root", ".header", "#search"))
  .Analyze()

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 is uitgevoerd.

class Deque.AxeDevtools.Selenium.Results.TestResults

Resultaten die worden teruggegeven door de analyse op de pagina uit te voeren.

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 RunOnlyRegels(string[])

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

Geeft: Het RunOnly object.

statische RunOnly 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 de analyse 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

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

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

Configureert het formaat van de regelgegevens. Dit kan worden gebruikt om nieuwe regels toe te voegen, die moeten worden geregistreerd bij de bibliotheek om te worden uitgevoerd.