Riferimento API C#

Classi C# di Axe DevTools

Questa pagina documenta le classi che compongono Axe DevTools C#

class Deque.AxeDevtools.Selenium.AxeSelenium

L'interfaccia per l'analisi dell'accessibilità. Contiene configurazioni che modificano il modo in cui l'analisi viene eseguita, oltre alla possibilità di eseguirla.

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

Crea un nuovo oggetto AxeSelenium per una pagina con configurazione specifica.

ReportResultsAnalyze()

Esegui l'analisi dell'accessibilità sulla pagina.

Restituisce: Il report dall'esecuzione di axe-core sulla pagina.

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

AxeSelenium Configure(Spec)

Configura axe. Fatto tramite axe.configure

Restituisce: Questo oggetto per concatenazione.

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[])

Disabilita alcune regole durante l'esecuzione dell'analisi.

Restituisce: Questo oggetto per concatenazione.

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

AxeSeleniumEscludi(stringa)

Specifica una parte della pagina da escludere dall'analisi. Per escludere diverse parti non correlate della pagina, chiama Excluding una volta per ciascuna.

Restituisce: Questo oggetto per concatenazione.

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

AxeSeleniumEscludi(param string[])

Specifica un elemento all'interno di uno o più iframe nidificati da escludere. Ogni selettore tranne l'ultimo corrisponde a un livello di nidificazione dell'iframe; l'ultimo corrisponde all'elemento da escludere all'interno dell'iframe più interno.

Poiché il parametro è dichiarato params, Excluding(".iframe1", ".third-party-ad") e Excluding(new[] { ".iframe1", ".third-party-ad" }) sono la stessa chiamata. In entrambi i casi, i selettori formano un unico selettore di iframe, non esclusioni separate. Per escludere diverse parti non correlate della pagina, chiama Excluding(string) una volta per ciascuna.

Restituisce: Questo oggetto per concatenazione.

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

AxeSeleniumEscludi(stringa[][])

Specifica un elemento all'interno di uno o più shadow DOM nidificati da escludere. Passa un array interno per chiamata. All'interno di quell'array, ogni selettore tranne l'ultimo corrisponde a un host shadow, e l'ultimo corrisponde all'elemento da escludere all'interno della radice shadow più interna.

Restituisce: Questo oggetto per concatenazione.

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

Specifica un elemento all'interno di uno o più iframe nidificati da escludere, utilizzando un selettore FromFrames esplicito.

Restituisce: Questo oggetto per concatenazione.

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

AxeSelenium Escludi(DaShadowDom)

Specifica un elemento all'interno di uno o più shadow DOM nidificati da escludere, utilizzando un selettore FromShadowDom esplicito.

Poiché axe-core corrisponde agli elementi rispetto all'albero DOM appiattito, selezionare un nodo shadow DOM seleziona anche eventuali discendenti inseriti tramite un elemento <slot>.

Restituisce: Questo oggetto per concatenazione.

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

AxeSeleniumEscludi(param oggetto[])

Specifica un selettore che combina selettori CSS semplici con oggetti FromFrames o FromShadowDom, per casi che gli altri overload non possono esprimere.

Questo overload viene selezionato solo quando la chiamata passa più di un argomento o un singolo argomento che non è uno dei tipi sopra. Passare un singolo FromFrames o FromShadowDom seleziona invece Excluding(FromFrames) o Excluding(FromShadowDom).

Per raggiungere un iframe che si trova all'interno di una radice shadow, il selettore FromShadowDom deve essere nidificato all'interno del selettore FromFrames; l'inverso causa un errore.

Restituisce: Questo oggetto per concatenazione.

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

AxeSeleniumIncludi(stringa)

Specifica una parte della pagina da analizzare. Per analizzare diverse parti non correlate della pagina, chiama Including una volta per ciascuna.

Restituisce: Questo oggetto per concatenazione.

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

AxeSeleniumIncludi(param string[])

Specifica un elemento all'interno di uno o più iframe nidificati da testare. Ogni selettore tranne l'ultimo corrisponde a un livello di nidificazione dell'iframe; l'ultimo corrisponde all'elemento da testare all'interno dell'iframe più interno.

Poiché il parametro è dichiarato params, Including(".sidebar-frame", ".some-class") e Including(new[] { ".sidebar-frame", ".some-class" }) sono la stessa chiamata. In entrambi i casi, i selettori formano un unico selettore di iframe, non inclusioni separate. Per testare diverse parti non correlate della pagina, chiama Including(string) una volta per ciascuna.

Restituisce: Questo oggetto per concatenazione.

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

AxeSeleniumIncludi(stringa[][])

Specifica un elemento all'interno di uno o più shadow DOM nidificati da testare. Passa un array interno per chiamata. All'interno di quell'array, ogni selettore tranne l'ultimo corrisponde a un host shadow, e l'ultimo corrisponde all'elemento da testare all'interno della radice shadow più interna.

Restituisce: Questo oggetto per concatenazione.

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

Specifica un elemento all'interno di uno o più iframe nidificati da testare, utilizzando un selettore FromFrames esplicito.

Restituisce: Questo oggetto per concatenazione.

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

AxeSelenium Inclusione(DaShadowDom)

Specifica un elemento all'interno di uno o più alberi shadow DOM annidati per testare, utilizzando un selettore FromShadowDom esplicito.

Poiché axe-core confronta gli elementi con l'albero DOM appiattito, selezionare un nodo shadow DOM seleziona anche eventuali discendenti inseriti tramite un elemento <slot>.

Restituisce: Questo oggetto per concatenazione.

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

AxeSeleniumInclusione(oggetti params[])

Specifica un selettore che combini selettori CSS semplici con oggetti FromFrames o FromShadowDom, per i casi che gli altri overload non possono esprimere.

Questo overload è selezionato solo quando la chiamata passa più di un argomento, o un singolo argomento che non è uno dei tipi sopra. Passando un singolo FromFrames o FromShadowDom si seleziona Including(FromFrames) o Including(FromShadowDom) invece.

Per raggiungere un iframe che si trova all'interno di una radice shadow, il selettore FromShadowDom deve essere annidato all'interno del selettore FromFrames; il contrario causa un errore.

Restituisce: Questo oggetto per concatenazione.

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

Specifica RunOptions per passare attraverso quando si chiama axe.run.

Restituisce: Questo oggetto per concatenazione.

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

AxeSeleniumConConfigFile(string)

Impostare dove trovare un file di configurazione. Il percorso predefinito è config/axe-ruleset.json o $AXE_RULESET_PATH.

Restituisce: Questo oggetto per concatenazione.

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

AxeSeleniumConRegole(string[])

Specifica regole (per id) da utilizzare quando si esegue l'analisi.

Restituisce: Questo oggetto per concatenazione.

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

AxeSeleniumConSetDiRegole(string, bool)

Utilizzare un set di regole specifico (cioè wcag2.1, 508).

Restituisce: Questo oggetto per concatenazione.

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

AxeSelenium ConTag(TagType[])

Specifica regole (per tag) da utilizzare quando si esegue l'analisi.

Restituisce: Questo oggetto per concatenazione.

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

Variabili di ambiente

Queste variabili di ambiente ti permettono di configurare il servizio di utilizzo e cambiare le proprietà degli eventi segnalati.

AxeSeleniumAbilitaTracciamento(bool)

Accetta o rifiuta l'invio di dati al servizio di utilizzo. L'invio è abilitato per impostazione predefinita.

Restituisce: Questo oggetto per concatenazione.

AxeSeleniumImpostaUrlTracciamento(string)

Imposta dove vengono inviati i dati sulle metriche di utilizzo. Impostazione predefinita a https://usage.deque.com

Restituisce: Questo oggetto per concatenazione.

AxeSeleniumImpostaIdDistinto(string)

Imposta l'id distinto utilizzato quando si inviano le metriche di utilizzo.

Restituisce: Questo oggetto per concatenazione.

class Deque.AxeDevtools.Selenium.ReportConfiguration

Configura informazioni specifiche del report come il nome del test suite o le informazioni sull'agente utente

static ReportConfigurationGetDefault()

Ottiene la configurazione predefinita corrente. Nota che il predefinito può essere modificato.

Restituisce: Il predefinito corrente.

static void ResetDefault()

Ripristina il predefinito al suo stato iniziale.

void SetAsDefault()

Imposta questo oggetto come predefinito.

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

ReportConfigurationTestMachine(string)

Imposta la macchina su cui sono stati eseguiti questi test.

Restituisce: Questo oggetto per concatenazione.

ReportConfigurationTestSuiteName(string)

Imposta il nome della suite di test.

Restituisce: Questo oggetto per concatenazione.

ReportConfigurationUIState(string)

Specifica lo stato dell'interfaccia per questo insieme di test. Utilizzato come ID.

Restituisce: Questo oggetto per concatenazione.

ReportConfigurationUserAgent(string)

Imposta l'agent utente utilizzato durante il test.

Restituisce: Questo oggetto per concatenazione.

class Deque.AxeDevtools.Selenium.Results.Check

Il risultato dell'esecuzione di un controllo.

class Deque.AxeDevtools.Selenium.Results.CheckedNode

Un nodo HTML che è stato controllato da una regola.

class Deque.AxeDevtools.Results.FromFrames

Un selettore che punta a un elemento all'interno di uno o più iframe annidati. Passalo a Including(FromFrames) o Excluding(FromFrames).

FromFrames(params oggetti[])

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

class Deque.AxeDevtools.Results.FromShadowDom

Un selettore che punta a un elemento all'interno di uno o più alberi shadow DOM annidati. Passalo a Including(FromShadowDom) o Excluding(FromShadowDom).

FromShadowDom(params string[])

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

class Deque.AxeDevtools.Selenium.Results.Node

Specifica un nodo HTML specifico.

class Deque.AxeDevtools.Selenium.Results.Platform

La piattaforma su cui è stato eseguito un test.

class Deque.AxeDevtools.Selenium.Results.ReportResults

Risultati di un test compatibili con il formato del reporter.

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

Risultato per una singola regola.

class Deque.AxeDevtools.Selenium.Results.TestEngine

Informazioni sul motore axe-core su cui è stato eseguito il test.

class Deque.AxeDevtools.Selenium.Results.TestEnvironment

Informazioni sull'ambiente in cui è stato eseguito il test.

class Deque.AxeDevtools.Selenium.Results.TestResults

Risultati restituiti dall'esecuzione dell'analisi sulla pagina.

class Deque.AxeDevtools.Selenium.Results.TestRunner

Nome del runner del test.

class Deque.AxeDevtools.Selenium.Results.TestSubject

Informazioni su ciò che viene testato.

class Deque.AxeDevtools.Selenium.RunOptions.Context

Specifica quale elemento deve essere testato e quale no.

void Escludendo(string[])

Aggiungi un set di selettori per gli elementi che non devono essere testati.

void Includendo(string[])

Aggiungi un set di selettori per gli elementi che devono essere testati.

enum Deque.AxeDevtools.Selenium.RunOptions.ResultGroup

• Passa
• Violazioni
• Incompleto
• Inapplicabile

class Deque.AxeDevtools.Selenium.RunOptions.RuleStatus

Abilita o disabilita una regola.

class Deque.AxeDevtools.Selenium.RunOptions.RunOnly

Limita quali regole vengono eseguite, basandosi su nomi o tag.

static SoloEseguiRegole(string[])

Costruisci un limitatore per le regole basate su ID.

Restituisce: L'oggetto RunOnly.

static SoloEsegui Tag(TagType[])

Costruire un limitatore per regole basate su tag.

Restituisce: L'oggetto RunOnly.

enum Deque.AxeDevtools.Selenium.RunOptions.RunOnlyType

• Regola
• Regole
• Tag
• Tag

class Deque.AxeDevtools.Selenium.RunOptions.RunOptions

Una configurazione flessibile per il funzionamento dell'analisi.

enum Deque.AxeDevtools.Selenium.RunOptions.TagType

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

class Deque.AxeDevtools.Selenium.Spec.Check

Usato per aggiungere verifiche all'elenco delle verifiche utilizzate dalle regole, o per sovrascrivere le proprietà delle verifiche esistenti.

class Deque.AxeDevtools.Selenium.Spec.Rule

Usato per aggiungere regole al set di regole esistenti, o per sovrascrivere le proprietà delle regole esistenti.

class Deque.AxeDevtools.Selenium.Spec.Spec

Configura il formato dei dati delle regole. Questo può essere utilizzato per aggiungere nuove regole, che devono essere registrate con la libreria per essere eseguite.