C#-API-Referenz

Axe DevTools C#-Klassen

Diese Seite dokumentiert die Klassen, aus denen axe DevTools C# besteht.

class Deque.AxeDevtools.Selenium.AxeSelenium

Die Schnittstelle zu axe. Enthält Konfigurationen zum Ändern der Ausführung von axe sowie die Fähigkeit, axe auszuführen.

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

Erstellen Sie ein neues AxeSelenium-Objekt für eine Seite mit spezifischer Konfiguration.

ReportResultsAnalyze()

Führen Sie „Axe“ auf der Seite aus.

Gibt zurück: Der Bericht vom Ausführen von Axe-Core auf der Seite.

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

AxeSelenium Configure(Spec)

axe konfigurieren. Fertig über axe.configure

Gibt dieses Objekt zur Verkettung zurück.

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

AxeSeleniumRegelnDeaktivieren(Zeichenfolge[])

Deaktivieren Sie einige Regeln, wenn Sie Axe ausführen.

Gibt dieses Objekt zur Verkettung zurück.

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

AxeSeleniumAusschließen(Zeichenfolge[])

Geben Sie den Teil der Seite an, der beim Ausführen von axe ausgeschlossen werden soll.

Gibt dieses Objekt zur Verkettung zurück.

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

AxeSeleniumEinschließen(Zeichenfolge[])

Geben Sie den Teil der Seite an, auf dem axe ausgeführt werden soll.

Gibt dieses Objekt zur Verkettung zurück.

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

AxeSelenium Ausführungsoptionen(Ausführungsoptionen)

Spezifizieren Sie RunOptions was beim Aufruf an Axe übergeben werden soll axe.run.

Gibt dieses Objekt zur Verkettung zurück.

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. Der Standardpfad ist config/axe-ruleset.json oder $AXE_RULESET_PATH.

Gibt dieses Objekt zur Verkettung zurück.

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

AxeSeleniumMitRegeln(string[])

Geben Sie die Regeln (nach ID) an, die beim Ausführen von Axe verwendet werden sollen.

Gibt dieses Objekt zur Verkettung zurück.

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

AxeSeleniumWithRuleset(string, bool)

Verwenden Sie einen bestimmten Regelsatz (z. B. wcag2.1, 508).

Gibt dieses Objekt zur Verkettung zurück.

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

AxeSelenium WithTags(TagType[])

Geben Sie (per Tag) die Regeln an, die beim Ausführen von axe verwendet werden sollen.

Gibt dieses Objekt zur Verkettung zurück.

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

Umgebungsvariablen

Mit dieser Methode können Benutzer bestimmte Werte des Nutzungsdienstes über Umgebungsvariablen ändern.

AxeSeleniumEnableTracking(bool)

Entscheiden Sie, ob Sie Daten an den Nutzungsdienst senden möchten oder nicht.

Gibt dieses Objekt zur Verkettung zurück.

AxeSeleniumSetTrackingUrl(string)

Legen Sie fest, wohin die Daten zu Nutzungsmetriken gesendet werden. Standardmäßig auf https://usage.deque.com

Gibt dieses Objekt zur Verkettung zurück.

AxeSeleniumSetDistinctId(string)

Legen Sie eine eindeutige ID fest, die beim Senden von Nutzungsmetriken verwendet wird.

Gibt dieses Objekt zur Verkettung zurück.

class Deque.AxeDevtools.Selenium.ReportConfiguration

Konfiguriert berichtsspezifische Informationen wie den Namen der Testsuite oder Benutzeragentinformationen.

static ReportConfigurationGetDefault()

Gets the current default configuration. Note that the default can be changed.

Gibt zurück: Der aktuelle Standard.

static void ResetDefault()

Resets the default to its initial state.

void SetAsDefault()

Sets this object as the default.

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

ReportConfigurationTestMachine(Zeichenfolge)

Sets the machine these tests were run on.

Gibt dieses Objekt zur Verkettung zurück.

ReportConfigurationTestSuiteName(Zeichenfolge)

Sets the test suite name.

Gibt dieses Objekt zur Verkettung zurück.

ReportConfigurationUIState(Zeichenfolge)

Specify the ui-state for this set of tests. Used as ID.

Gibt dieses Objekt zur Verkettung zurück.

ReportConfigurationUserAgent(Zeichenfolge)

Set the user agent used when testing.

Gibt dieses Objekt zur Verkettung zurück.

class Deque.AxeDevtools.Selenium.Results.Check

The result of running an axe check.

class Deque.AxeDevtools.Selenium.Results.CheckedNode

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

class Deque.AxeDevtools.Selenium.Results.Node

Gibt einen bestimmten HTML-Knoten an.

class Deque.AxeDevtools.Selenium.Results.Platform

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

class Deque.AxeDevtools.Selenium.Results.ReportResults

Ergebnisse eines Tests, die mit dem Reporterformat 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 zur Axe-Core-Engine, auf der der Test ausgefü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 von „axe“ auf der Seite zurückgegeben werden.

class Deque.AxeDevtools.Selenium.Results.TestRunner

Name des Testrunners.

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 soll und welches nicht.

void Excluding(string[])

Fügen Sie einen Auswahlsatz für Elemente hinzu, die nicht getestet werden sollen.

void Including(string[])

Fügen Sie einen Selektorsatz für Elemente hinzu, die getestet werden sollen.

enum Deque.AxeDevtools.Selenium.RunOptions.ResultGroup

• Bestanden
• Verstöße
• Unvollständig
• Nicht anwendbar

class Deque.AxeDevtools.Selenium.RunOptions.RuleStatus

Aktiviert oder deaktiviert eine Regel.

class Deque.AxeDevtools.Selenium.RunOptions.RunOnly

Beschränken Sie, welche Regeln anhand von Namen oder Tags ausgeführt werden.

statisch RunOnlyRegeln(Zeichenfolge[])

Erstellen Sie einen Begrenzer für Regeln, die auf IDs basieren.

Gibt: Das RunOnly Objekt zurück.

Statisch Nur ausführen Tags(TagType[])

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

Gibt: Das RunOnly Objekt zurück.

enum Deque.AxeDevtools.Selenium.RunOptions.RunOnlyType

• Regel
• Regeln
• Tag
• Schlagwörter

class Deque.AxeDevtools.Selenium.RunOptions.RunOptions

Eine flexible Konfiguration für die Funktionsweise von Axe.

enum Deque.AxeDevtools.Selenium.RunOptions.TagType

• Wcag2a
• Wcag2aa
• Wcag2aaa
• Wcag21a
• Wcag21aa
• Wcag21aaa
• Wcag22a
• Wcag22aa
• Wcag22aaa
• Section508
• TTv5
• EN301549
• Beste Praxis

class Deque.AxeDevtools.Selenium.Spec.Check

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

class Deque.AxeDevtools.Selenium.Spec.Rule

Wird verwendet, um dem vorhandenen Regelsatz Regeln hinzuzufügen oder die Eigenschaften vorhandener Regeln zu überschreiben.

Klasse Deque.AxeDevtools.Selenium.Spec.Spec

Konfiguriert das Format der von Axe verwendeten Daten. Hiermit können neue Regeln hinzugefügt werden, die zur Ausführung bei der Bibliothek registriert werden müssen.