C# API リファレンス

Axe DevTools C# クラス

このページでは、Axe DevTools C# を構成するクラスを記述しています

class Deque.AxeDevtools.Selenium.AxeSelenium

アクセシビリティ分析のインターフェース。分析の実行方法を変更するための設定や、分析を実行する機能を含みます。

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

特定の設定を持つページのために新しい AxeSelenium オブジェクトを作成します。

ReportResultsAnalyze()

ページ上でアクセシビリティ分析を実行します。

戻り値: axe-core をページで実行した時のレポート。

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

AxeSelenium Configure(Spec)

axe を設定します。これは axe.configure 経由で行われます。

戻り値: チェイン用のこのオブジェクト。

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

分析を実行する際にいくつかのルールを無効にします。

戻り値: チェイン用のこのオブジェクト。

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

AxeSelenium除外(string)

分析から除外するページの部分を指定します。ページのいくつかの無関係な部分を除外するには、それぞれに対してExcludingを一度呼び出します。

戻り値: チェイン用のこのオブジェクト。

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

AxeSelenium除外(params string[])

除外するために、1つまたは複数のネストしたiframeの中にある要素を指定します。セレクタの最後を除いて、全てのセレクタはiframeのネストレベルに一致し、最後のセレクタが最も内側のiframe内の除外する要素に一致します。

パラメータがparamsとして宣言されているため、Excluding(".iframe1", ".third-party-ad")とExcluding(new[] { ".iframe1", ".third-party-ad" })は同じ呼び出しです。どちらの場合でも、セレクタは1つのiframeセレクタを形成し、個別の除外とはなりません。ページのいくつかの無関係な部分を除外するには、それぞれに対してExcluding(string)を一度呼び出します。

戻り値: チェイン用のこのオブジェクト。

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

AxeSelenium除外(string[][])

除外するために、1つまたは複数のネストしたシャドウDOMツリーの中にある要素を指定します。その配列内で、最後のセレクタを除き、全てのセレクタはシャドウホストに一致し、最後のセレクタが最も内側のシャドウルート内で除外する要素に一致します。

戻り値: チェイン用のこのオブジェクト。

// 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 除外(FromFrames)

明示的なFromFramesセレクタを使って、1つまたは複数のネストしたiframeの中にある要素を除外するよう指定します。

戻り値: チェイン用のこのオブジェクト。

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

AxeSelenium 除外(FromShadowDom)

明示的なFromShadowDomセレクタを使って、1つまたは複数のネストしたシャドウDOMツリーの中にある要素を除外するよう指定します。

axe-coreはフラット化されたDOMツリーに対して要素を一致させるため、シャドウDOMノードを選択すると、<slot>要素を通じて挿入された子孫も同時に選択されます。

戻り値: チェイン用のこのオブジェクト。

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

AxeSelenium除外(params object[])

他のオーバーロードでは表現できないケースのために、FromFramesまたはFromShadowDomオブジェクトと組み合わせたシンプルなCSSセレクタを指定します。

このオーバーロードは、呼び出しが複数の引数、または上記のタイプのいずれでもない単一の引数を渡すときにのみ選択されます。単一のFromFramesまたはFromShadowDomを渡すと、代わりにExcluding(FromFrames)またはExcluding(FromShadowDom)が選択されます。

シャドウルート内に存在するiframeにアクセスするには、FromShadowDomセレクタがFromFramesセレクタの内側にネストされなければならず、逆にするとエラーが発生します。

戻り値: チェイン用のこのオブジェクト。

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

AxeSelenium含む(string)

分析するページの部分を指定します。ページのいくつかの無関係な部分を分析するには、それぞれに対してIncludingを一度呼び出します。

戻り値: チェイン用のこのオブジェクト。

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

AxeSelenium含む(params string[])

テストするために、1つまたは複数のネストしたiframeの中にある要素を指定します。セレクタの最後を除いて、全てのセレクタはiframeのネストレベルに一致し、最後のセレクタが最も内側のiframe内のテストする要素に一致します。

パラメータがparamsとして宣言されているため、Including(".sidebar-frame", ".some-class")とIncluding(new[] { ".sidebar-frame", ".some-class" })は同じ呼び出しです。どちらの場合でも、セレクタは1つのiframeセレクタを形成し、個別の含有とはなりません。ページのいくつかの無関係な部分をテストするには、それぞれに対してIncluding(string)を一度呼び出します。

戻り値: チェイン用のこのオブジェクト。

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

AxeSelenium含む(string[][])

テストするために、1つまたは複数のネストしたシャドウDOMツリーの中にある要素を指定します。その配列内で、最後のセレクタを除き、全てのセレクタはシャドウホストに一致し、最後のセレクタが最も内側のシャドウルート内でテストする要素に一致します。

戻り値: チェイン用のこのオブジェクト。

// 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 含む(FromFrames)

明示的なFromFramesセレクタを使って、1つまたは複数のネストしたiframeの中にある要素をテストするよう指定します。

戻り値: チェイン用のこのオブジェクト。

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

AxeSelenium シャドウ DOM から含める (FromShadowDom)

特定の要素をテストするために、1つ以上のネストされたシャドウ DOM ツリー内の要素を明示的な FromShadowDom セレクターを使って指定します。

axe-core は要素をフラット化された DOM ツリーと照合するため、シャドウ DOM ノードを選択すると、<slot> 要素を介して挿入された子孫も選択されます。

戻り値: チェイン用のこのオブジェクト。

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

AxeSeleniumオブジェクトを含める (params object[])

他のオーバーロードでは表現できない場合に備えて、プレーンな CSS セレクターと FromFrames や FromShadowDom オブジェクトを混在させたセレクターを指定します。

このオーバーロードが選択されるのは、1つ以上の引数を渡した場合、または上記の型のいずれでもない単一の引数を渡した場合のみです。単一の FromFrames または FromShadowDom を渡すと Including(FromFrames) または Including(FromShadowDom) が選択されます。

シャドウルート内にある iframe に到達するためには、FromShadowDom セレクターを FromFrames セレクター内にネストする必要があります。逆にするとエラーが発生します。

戻り値: チェイン用のこのオブジェクト。

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

RunOptions を指定して axe.run を呼び出すときに通過させます。

戻り値: チェイン用のこのオブジェクト。

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

AxeSeleniumコンフィグファイル指定(string)

コンフィグファイルを見つける場所を設定します。デフォルトのパスはconfig/axe-ruleset.jsonまたは$AXE_RULESET_PATHです。

戻り値: チェイン用のこのオブジェクト。

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

AxeSeleniumルール指定(string[])

分析を実行する際に使用するルール（IDで指定）を指定します。

戻り値: チェイン用のこのオブジェクト。

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

AxeSeleniumルールセット指定(string, bool)

特定のルールセットを使用します（例えば、wcag2.1、508）。

戻り値: チェイン用のこのオブジェクト。

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

AxeSelenium WithTags(TagType[])

分析を実行する際に使用するルール（タグで指定）を指定します。

戻り値: チェイン用のこのオブジェクト。

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

環境変数

これらの環境変数は、使用サービスを設定し、報告されるイベントのプロパティを変更することができます。

AxeSeleniumEnableTracking(bool)

利用状況サービスへのデータ送信を有効化または無効化します。送信はデフォルトで有効になっています。

戻り値: チェイン用のこのオブジェクト。

AxeSeleniumSetTrackingUrl(string)

使用メトリクスデータが送信される場所を設定します。デフォルトはhttps://usage.deque.comです

戻り値: チェイン用のこのオブジェクト。

AxeSeleniumSetDistinctId(string)

使用メトリクス送信時に使用される異なるIDを設定します。

戻り値: チェイン用のこのオブジェクト。

class Deque.AxeDevtools.Selenium.ReportConfiguration

テストスイート名やユーザーエージェント情報など、レポート固有の情報を設定します。

static ReportConfigurationGetDefault()

現在のデフォルト設定を取得します。デフォルトは変更可能であることに注意してください。

戻り値: 現在のデフォルト。

static void ResetDefault()

デフォルトを初期状態にリセットします。

void SetAsDefault()

このオブジェクトをデフォルトとして設定します。

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

ReportConfigurationTestMachine(string)

これらのテストが実行されたマシンを設定します。

戻り値: チェイン用のこのオブジェクト。

ReportConfigurationTestSuiteName(string)

テストスイート名を設定します。

戻り値: チェイン用のこのオブジェクト。

ReportConfigurationUIState(string)

このテストセットのUI状態を指定します。IDとして使用されます。

戻り値: チェイン用のこのオブジェクト。

ReportConfigurationUserAgent(string)

テスト時に使用されるユーザーエージェントを設定します。

戻り値: チェイン用のこのオブジェクト。

class Deque.AxeDevtools.Selenium.Results.Check

チェックを実行した結果。

class Deque.AxeDevtools.Selenium.Results.CheckedNode

ルールによってチェックされたHTMLノード。

class Deque.AxeDevtools.Results.FromFrames

1つ以上のネストされた iframe 内の要素をターゲットにするセレクター。Including(FromFrames) または Excluding(FromFrames) に渡します。

FromFrames(params object[])

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

class Deque.AxeDevtools.Results.FromShadowDom

1つ以上のネストされたシャドウ DOM ツリー内の要素をターゲットにするセレクター。Including(FromShadowDom) または Excluding(FromShadowDom) に渡します。

FromShadowDom(params string[])

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

class Deque.AxeDevtools.Selenium.Results.Node

特定のHTMLノードを指定する。

class Deque.AxeDevtools.Selenium.Results.Platform

テストが実行されたプラットフォーム。

class Deque.AxeDevtools.Selenium.Results.ReportResults

リポーター形式と互換性のあるテスト結果。

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

単一のルールの結果。

class Deque.AxeDevtools.Selenium.Results.TestEngine

テストが実行されたaxe-coreエンジンに関する情報。

class Deque.AxeDevtools.Selenium.Results.TestEnvironment

テストが行われた環境に関する情報。

class Deque.AxeDevtools.Selenium.Results.TestResults

ページ上で分析を実行した結果。

class Deque.AxeDevtools.Selenium.Results.TestRunner

テストランナーの名前。

class Deque.AxeDevtools.Selenium.Results.TestSubject

テスト対象に関する情報。

class Deque.AxeDevtools.Selenium.RunOptions.Context

テストする要素としない要素を指定します。

void Excluding(string[])

テストしない要素のセレクターセットを追加します。

void Including(string[])

テストする要素のセレクターセットを追加します。

enum Deque.AxeDevtools.Selenium.RunOptions.ResultGroup

• 合格
• 違反
• 不完全
• 不適用

class Deque.AxeDevtools.Selenium.RunOptions.RuleStatus

ルールを有効化または無効化します。

class Deque.AxeDevtools.Selenium.RunOptions.RunOnly

名前またはタグに基づいて実行するルールを制限します。

static RunOnlyRules(string[])

IDに基づいてルールのリミッターを構築します。

戻り値: RunOnly オブジェクト。

static RunOnly タグ(TagType[])

タグに基づくルールの制限を構築します。

戻り値: RunOnly オブジェクト。

enum Deque.AxeDevtools.Selenium.RunOptions.RunOnlyType

• ルール
• ルール
• タグ
• タグ

class Deque.AxeDevtools.Selenium.RunOptions.RunOptions

分析がどのように動作するかの柔軟な構成。

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

ルールで使用されるチェックのリストにチェックを追加するか、既存のチェックのプロパティを上書きするために使用されます。

class Deque.AxeDevtools.Selenium.Spec.Rule

既存のルールセットにルールを追加するか、既存のルールのプロパティを上書きするために使用されます。

class Deque.AxeDevtools.Selenium.Spec.Spec

ルールデータの形式を設定します。これを使用して新しいルールを追加できますが、実行するにはライブラリに登録する必要があります。