C#-API-Referenz

Axe DevTools C#-Klassen

Diese Seite dokumentiert die Klassen, die Axe DevTools C# ausmachen.

class Deque.AxeDevtools.Selenium.AxeSelenium

Die Schnittstelle zur Zugänglichkeitsanalyse. Beinhaltet Konfigurationen, die ändern, wie die Analyse abläuft, sowie die Möglichkeit, sie auszuführen.

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

Ein neues AxeSelenium-Objekt für eine Seite mit spezifischer Konfiguration erstellen.

ReportResultsAnalyze()

Führen Sie die Zugänglichkeitsanalyse auf der Seite durch.

Rückgaben: Der Bericht von der Ausführung von axe-core auf der Seite.

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

AxeSelenium Configure(Spec)

Konfigurieren Sie axe. Erledigt über axe.configure

Rückgaben: Dieses Objekt zur Verkettung.

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()

AxeSeleniumDisablingRules(string[])

Deaktivieren Sie einige Regeln beim Ausführen der Analyse.

Rückgaben: Dieses Objekt zur Verkettung.

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

AxeSeleniumAusschließen(string)

Geben Sie einen Teil der Seite an, der von der Analyse ausgeschlossen werden soll. Um mehrere nicht zusammenhängende Teile der Seite auszuschließen, rufen Sie Excluding für jeden einzeln auf.

Rückgaben: Dieses Objekt zur Verkettung.

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

AxeSeleniumAusschließen(params string[])

Geben Sie ein Element an, das sich in einem oder mehreren verschachtelten iframes befindet, um es auszuschließen. Jeder Selektor mit Ausnahme des letzten passt zu einer Verschachtelungsstufe des iframes; der letzte passt zu dem auszuschließenden Element im innersten iframe.

Weil der Parameter als params deklariert ist, sind Excluding(".iframe1", ".third-party-ad") und Excluding(new[] { ".iframe1", ".third-party-ad" }) derselbe Aufruf. In beiden Fällen bilden die Selektoren einen iframe-Selektor, keine getrennten Ausschlüsse. Um mehrere nicht zusammenhängende Teile der Seite auszuschließen, rufen Sie Excluding(string) für jeden einzeln auf.

Rückgaben: Dieses Objekt zur Verkettung.

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

AxeSeleniumAusschließen(string[][])

Geben Sie ein Element an, das sich in einem oder mehreren verschachtelten Shadow-DOM-Bäumen befindet, um es auszuschließen. Übergeben Sie pro Aufruf ein inneres Array. Innerhalb dieses Arrays passt jeder Selektor mit Ausnahme des letzten zu einem Schatten-Host, und der letzte passt zu dem auszuschließenden Element im innersten Schatten-Root.

Rückgaben: Dieses Objekt zur Verkettung.

// 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 Ausschließen(VonFrames)

Geben Sie ein Element an, das sich in einem oder mehreren verschachtelten iframes befindet, um es unter Verwendung eines expliziten FromFrames-Selektors auszuschließen.

Rückgaben: Dieses Objekt zur Verkettung.

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

AxeSelenium Ausschließen(VonShadowDom)

Geben Sie ein Element an, das sich in einem oder mehreren verschachtelten Shadow-DOM-Bäumen befindet, um es unter Verwendung eines expliziten FromShadowDom-Selektors auszuschließen.

Da axe-core Elemente gegen den abgeflachten DOM-Baum abgleicht, wählt das Auswählen eines Shadow-DOM-Knotens auch alle Nachkommen aus, die über ein <slot>-Element eingefügt wurden.

Rückgaben: Dieses Objekt zur Verkettung.

// 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()

AxeSeleniumAusschließen(params object[])

Geben Sie einen Selektor an, der einfache CSS-Selektoren mit FromFrames- oder FromShadowDom-Objekten mischt, für Fälle, die die anderen Overloads nicht ausdrücken können.

Dieser Overload wird nur ausgewählt, wenn der Aufruf mehr als ein Argument übergibt oder ein einzelnes Argument, das nicht einer der oben genannten Typen ist. Das Übergeben eines einzelnen FromFrames- oder FromShadowDom-Werte wählt stattdessen Excluding(FromFrames) oder Excluding(FromShadowDom) aus.

Um ein iframe zu erreichen, das sich in einem Schatten-Root befindet, muss der FromShadowDom-Selektor innerhalb des FromFrames-Selektors verschachtelt sein; das Umgekehrte verursacht einen Fehler.

Rückgaben: Dieses Objekt zur Verkettung.

// 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()

AxeSeleniumEinbeziehen(string)

Geben Sie einen Teil der Seite an, der analysiert werden soll. Um mehrere nicht zusammenhängende Teile der Seite zu analysieren, rufen Sie Including für jeden einzeln auf.

Rückgaben: Dieses Objekt zur Verkettung.

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

AxeSeleniumEinbeziehen(params string[])

Geben Sie ein Element an, das sich in einem oder mehreren verschachtelten iframes befindet, um es zu testen. Jeder Selektor mit Ausnahme des letzten passt zu einer Verschachtelungsstufe des iframes; der letzte passt zu dem zu testenden Element im innersten iframe.

Weil der Parameter als params deklariert ist, sind Including(".sidebar-frame", ".some-class") und Including(new[] { ".sidebar-frame", ".some-class" }) derselbe Aufruf. In beiden Fällen bilden die Selektoren einen iframe-Selektor, keine getrennten Einbeziehungen. Um mehrere nicht zusammenhängende Teile der Seite zu testen, rufen Sie Including(string) für jeden einzeln auf.

Rückgaben: Dieses Objekt zur Verkettung.

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

AxeSeleniumEinbeziehen(string[][])

Geben Sie ein Element an, das sich in einem oder mehreren verschachtelten Shadow-DOM-Bäumen befindet, um es zu testen. Übergeben Sie pro Aufruf ein inneres Array. Innerhalb dieses Arrays passt jeder Selektor mit Ausnahme des letzten zu einem Schatten-Host, und der letzte passt zu dem zu testenden Element im innersten Schatten-Root.

Rückgaben: Dieses Objekt zur Verkettung.

// 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 Einbeziehen(VonFrames)

Geben Sie ein Element an, das sich in einem oder mehreren verschachtelten iframes befindet, um es unter Verwendung eines expliziten FromFrames-Selektors zu testen.

Rückgaben: Dieses Objekt zur Verkettung.

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

AxeSelenium Einschließlich(VonShadowDom)

Geben Sie ein Element innerhalb eines oder mehrerer geschachtelter Shadow-DOM-Bäume an, das getestet werden soll, indem Sie einen expliziten FromShadowDom-Selector verwenden.

Da axe-core Elemente mit dem abgeflachten DOM-Baum abgleicht, wählt das Selektieren eines Shadow-DOM-Knotens auch alle über ein <slot>-Element eingefügten Nachkommen aus.

Rückgaben: Dieses Objekt zur Verkettung.

// 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()

AxeSeleniumEinschließlich(params object[])

Geben Sie einen Selector an, der einfache CSS-Selektoren mit FromFrames- oder FromShadowDom-Objekten mischt, für Fälle, die die anderen Überladungen nicht ausdrücken können.

Diese Überladung wird nur ausgewählt, wenn der Aufruf mehr als ein Argument oder ein einzelnes Argument übergibt, das keiner der oben genannten Typen ist. Das Übergeben eines einzelnen FromFrames- oder FromShadowDom-Arguments wählt stattdessen Including(FromFrames) oder Including(FromShadowDom) aus.

Um ein iframe zu erreichen, das sich innerhalb einer Shadow-Root befindet, muss der FromShadowDom-Selector innerhalb des FromFrames-Selectors geschachtelt sein; das Umkehren verursacht einen Fehler.

Rückgaben: Dieses Objekt zur Verkettung.

// 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 RunOptions(RunOptions)

Geben Sie RunOptions an, um durchzuleiten, wenn axe.run aufgerufen wird.

Rückgaben: Dieses Objekt zur Verkettung.

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

AxeSeleniumWithConfigFile(string)

Legen Sie fest, wo eine Konfigurationsdatei gefunden werden soll. Standardpfad ist config/axe-ruleset.json oder $AXE_RULESET_PATH.

Rückgaben: Dieses Objekt zur Verkettung.

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

AxeSeleniumWithRules(string[])

Geben Sie Regeln (nach ID) an, die bei der Durchführung der Analyse verwendet werden sollen.

Rückgaben: Dieses Objekt zur Verkettung.

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

AxeSeleniumWithRuleset(string, bool)

Verwenden Sie ein spezifisches Regelset (d. h. wcag2.1, 508).

Rückgaben: Dieses Objekt zur Verkettung.

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

AxeSelenium MitTags(TagTyp[])

Geben Sie Regeln (nach Tag) an, die bei der Durchführung der Analyse verwendet werden sollen.

Rückgaben: Dieses Objekt zur Verkettung.

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

Umgebungsvariablen

Diese Umgebungsvariablen ermöglichen es Ihnen, den Verwendungsdienst zu konfigurieren und die Eigenschaften der gemeldeten Ereignisse zu ändern.

AxeSeleniumTrackingAktivieren(bool)

Wählen Sie, ob Sie der Übermittlung von Daten an den Nutzungsdienst zustimmen oder nicht. Die Übermittlung ist standardmäßig aktiviert.

Rückgaben: Dieses Objekt zur Verkettung.

AxeSeleniumTrackingUrlSetzen(string)

Bestimmen Sie, wohin die Verwendungsmetriken gesendet werden. Standardmäßig an https://usage.deque.com

Rückgaben: Dieses Objekt zur Verkettung.

AxeSeleniumSetDistinctId(string)

Setzen Sie die eindeutige ID, die beim Senden von Verwendungsmetriken verwendet wird.

Rückgaben: Dieses Objekt zur Verkettung.

class Deque.AxeDevtools.Selenium.ReportConfiguration

Konfiguriert berichtsspezifische Informationen wie den Namen der Testsuite oder Informationen zum Benutzeragenten

statisch ReportConfigurationGetDefault()

Ruft die aktuelle Standardkonfiguration ab. Beachten Sie, dass die Standardeinstellung geändert werden kann.

Rückgaben: Die aktuelle Standardeinstellung.

statisch void ResetDefault()

Setzt die Standardeinstellung auf ihren ursprünglichen Zustand zurück.

void SetAsDefault()

Setzt dieses Objekt als Standard.

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

ReportConfigurationTestMachine(string)

Legt die Maschine fest, auf der diese Tests durchgeführt wurden.

Rückgaben: Dieses Objekt zur Verkettung.

ReportConfigurationTestSuiteName(string)

Legt den Namen der Test-Suite fest.

Rückgaben: Dieses Objekt zur Verkettung.

ReportConfigurationUIState(string)

Gibt den UI-Status für diesen Testsatz an. Wird als ID verwendet.

Rückgaben: Dieses Objekt zur Verkettung.

ReportConfigurationUserAgent(string)

Setzt den User-Agent, der beim Testen verwendet wird.

Rückgaben: Dieses Objekt zur Verkettung.

class Deque.AxeDevtools.Selenium.Results.Check

Das Ergebnis des Ausführens einer Überprüfung.

class Deque.AxeDevtools.Selenium.Results.CheckedNode

Ein HTML-Knoten, der durch eine Regel überprüft wurde.

class Deque.AxeDevtools.Results.FromFrames

Ein Selector, der auf ein Element innerhalb eines oder mehrerer geschachtelter iframes abzielt. Übergeben Sie ihn an Including(FromFrames) oder Excluding(FromFrames).

FromFrames(params object[])

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

class Deque.AxeDevtools.Results.FromShadowDom

Ein Selector, der auf ein Element innerhalb eines oder mehrerer geschachtelter Shadow-DOM-Bäume abzielt. Übergeben Sie ihn an Including(FromShadowDom) oder Excluding(FromShadowDom).

FromShadowDom(params string[])

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

class Deque.AxeDevtools.Selenium.Results.Node

Gibt einen spezifischen HTML-Knoten an.

class Deque.AxeDevtools.Selenium.Results.Platform

Die Plattform, auf der ein Test durchgeführt wurde.

class Deque.AxeDevtools.Selenium.Results.ReportResults

Ergebnisse eines Tests, die mit dem Reporter-Format kompatibel sind.

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

Ergebnis für eine einzelne Regel.

class Deque.AxeDevtools.Selenium.Results.TestEngine

Informationen über die axe-core-Engine, auf der der Test durchgeführt wurde.

class Deque.AxeDevtools.Selenium.Results.TestEnvironment

Informationen über die Umgebung, in der der Test durchgeführt wurde.

class Deque.AxeDevtools.Selenium.Results.TestResults

Ergebnisse, die durch Ausführen der Analyse auf der Seite zurückgegeben werden.

class Deque.AxeDevtools.Selenium.Results.TestRunner

Name des Testlaufwerks.

class Deque.AxeDevtools.Selenium.Results.TestSubject

Informationen darüber, was getestet wird.

class Deque.AxeDevtools.Selenium.RunOptions.Context

Geben Sie an, welches Element getestet werden sollte und welches nicht.

void Excluding(string[])

Fügen Sie eine Auswahl von Selektoren für Elemente hinzu, die nicht getestet werden sollen.

void Including(string[])

Fügen Sie eine Auswahl von Selektoren für Elemente hinzu, die getestet werden sollen.

enum Deque.AxeDevtools.Selenium.RunOptions.ResultGroup

• Bestanden
• Verstöße
• Unvollständig
• Unanwendbar

class Deque.AxeDevtools.Selenium.RunOptions.RuleStatus

Aktiviert oder deaktiviert eine Regel.

class Deque.AxeDevtools.Selenium.RunOptions.RunOnly

Begrenzen, welche Regeln basierend auf Namen oder Tags ausgeführt werden.

static RunOnlyRegeln(string[])

Erstellen Sie einen Begrenzer für Regeln basierend auf IDs.

Rückgaben: Das RunOnly-Objekt.

statische RunOnly Tags(TagTyp[])

Konstruiere einen Begrenzer für Regeln basierend auf Tags.

Rückgaben: Das RunOnly-Objekt.

enum Deque.AxeDevtools.Selenium.RunOptions.RunOnlyType

• Regel
• Regeln
• Tag
• Tags

class Deque.AxeDevtools.Selenium.RunOptions.RunOptions

Eine flexible Konfiguration, wie die Analyse ausgeführt wird.

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

Wird verwendet, um Überprüfungen zur Liste der von Regeln verwendeten Überprüfungen hinzuzufügen oder die Eigenschaften bestehender Überprüfungen zu überschreiben.

class Deque.AxeDevtools.Selenium.Spec.Rule

Wird verwendet, um Regeln zum bestehenden Regelset hinzuzufügen oder die Eigenschaften bestehender Regeln zu überschreiben.

class Deque.AxeDevtools.Selenium.Spec.Spec

Konfiguriert das Format der Regel-Daten. Dies kann verwendet werden, um neue Regeln hinzuzufügen, die bei der Bibliothek registriert werden müssen, um ausgeführt zu werden.