blob: 99ffb09b07512df31e5ff27d7bf77c8cb22b29ad [file] [edit]
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>Class AccessibilityAdapter </title>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="title" content="Class AccessibilityAdapter ">
<meta name="description" content="Represents an adapter for the Accessibility domain to simplify the command interface.">
<link rel="icon" href="../images/favicon.ico">
<link rel="stylesheet" href="../public/docfx.min.css">
<link rel="stylesheet" href="../public/main.css">
<meta name="docfx:navrel" content="../toc.html">
<meta name="docfx:tocrel" content="toc.html">
<meta name="docfx:rel" content="../">
<meta name="docfx:docurl" content="https://github.com/SeleniumHQ/selenium/new/docfix/apiSpec/new?filename=OpenQA_Selenium_DevTools_V146_Accessibility_AccessibilityAdapter.md&amp;value=---%0Auid%3A%20OpenQA.Selenium.DevTools.V146.Accessibility.AccessibilityAdapter%0Asummary%3A%20&#39;*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax&#39;%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">
<meta name="loc:inThisArticle" content="In this article">
<meta name="loc:searchResultsCount" content="{count} results for &quot;{query}&quot;">
<meta name="loc:searchNoResults" content="No results for &quot;{query}&quot;">
<meta name="loc:tocFilter" content="Filter by title">
<meta name="loc:nextArticle" content="Next">
<meta name="loc:prevArticle" content="Previous">
<meta name="loc:themeLight" content="Light">
<meta name="loc:themeDark" content="Dark">
<meta name="loc:themeAuto" content="Auto">
<meta name="loc:changeTheme" content="Change theme">
<meta name="loc:copy" content="Copy">
<meta name="loc:downloadPdf" content="Download PDF">
<script type="module" src="./../public/docfx.min.js"></script>
<script>
const theme = localStorage.getItem('theme') || 'auto'
document.documentElement.setAttribute('data-bs-theme', theme === 'auto' ? (window.matchMedia('(prefers-color-scheme: dark)').matches ? 'dark' : 'light') : theme)
</script>
</head>
<body class="tex2jax_ignore" data-layout="" data-yaml-mime="ManagedReference">
<header class="bg-body border-bottom">
<nav id="autocollapse" class="navbar navbar-expand-md" role="navigation">
<div class="container-xxl flex-nowrap">
<a class="navbar-brand" href="../index.html">
<img id="logo" class="svg" src="../images/logo.svg" alt="Selenium .NET API">
Selenium .NET API
</a>
<button class="btn btn-lg d-md-none border-0" type="button" data-bs-toggle="collapse" data-bs-target="#navpanel" aria-controls="navpanel" aria-expanded="false" aria-label="Toggle navigation">
<i class="bi bi-three-dots"></i>
</button>
<div class="collapse navbar-collapse" id="navpanel">
<div id="navbar">
<form class="search" role="search" id="search">
<i class="bi bi-search"></i>
<input class="form-control" id="search-query" type="search" disabled placeholder="Search" autocomplete="off" aria-label="Search">
</form>
</div>
</div>
</div>
</nav>
</header>
<main class="container-xxl">
<div class="toc-offcanvas">
<div class="offcanvas-md offcanvas-start" tabindex="-1" id="tocOffcanvas" aria-labelledby="tocOffcanvasLabel">
<div class="offcanvas-header">
<h5 class="offcanvas-title" id="tocOffcanvasLabel">Table of Contents</h5>
<button type="button" class="btn-close" data-bs-dismiss="offcanvas" data-bs-target="#tocOffcanvas" aria-label="Close"></button>
</div>
<div class="offcanvas-body">
<nav class="toc" id="toc"></nav>
</div>
</div>
</div>
<div class="content">
<div class="actionbar">
<button class="btn btn-lg border-0 d-md-none" type="button" data-bs-toggle="offcanvas" data-bs-target="#tocOffcanvas" aria-controls="tocOffcanvas" aria-expanded="false" aria-label="Show table of contents">
<i class="bi bi-list"></i>
</button>
<nav id="breadcrumb"></nav>
</div>
<article data-uid="OpenQA.Selenium.DevTools.V146.Accessibility.AccessibilityAdapter">
<h1 id="OpenQA_Selenium_DevTools_V146_Accessibility_AccessibilityAdapter" data-uid="OpenQA.Selenium.DevTools.V146.Accessibility.AccessibilityAdapter" class="text-break">
Class AccessibilityAdapter <a class="header-action link-secondary" title="View source" href="https://github.com/SeleniumHQ/selenium/blob/docfix/bazel-bin/dotnet/src/webdriver/DevTools/v146/Accessibility/AccessibilityAdapter.cs/#L16"><i class="bi bi-code-slash"></i></a>
</h1>
<div class="facts text-secondary">
<dl><dt>Namespace</dt><dd><a class="xref" href="OpenQA.html">OpenQA</a>.<a class="xref" href="OpenQA.Selenium.html">Selenium</a>.<a class="xref" href="OpenQA.Selenium.DevTools.html">DevTools</a>.<a class="xref" href="OpenQA.Selenium.DevTools.V146.html">V146</a>.<a class="xref" href="OpenQA.Selenium.DevTools.V146.Accessibility.html">Accessibility</a></dd></dl>
<dl><dt>Assembly</dt><dd>Selenium.WebDriver.dll</dd></dl>
</div>
<div class="markdown summary"><p>Represents an adapter for the Accessibility domain to simplify the command interface.</p>
</div>
<div class="markdown conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public class AccessibilityAdapter</code></pre>
</div>
<dl class="typelist inheritance">
<dt>Inheritance</dt>
<dd>
<div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a></div>
<div><span class="xref">AccessibilityAdapter</span></div>
</dd>
</dl>
<dl class="typelist inheritedMembers">
<dt>Inherited Members</dt>
<dd>
<div>
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.tostring">object.ToString()</a>
</div>
<div>
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)">object.Equals(object)</a>
</div>
<div>
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)">object.Equals(object, object)</a>
</div>
<div>
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.referenceequals">object.ReferenceEquals(object, object)</a>
</div>
<div>
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.gethashcode">object.GetHashCode()</a>
</div>
<div>
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.gettype">object.GetType()</a>
</div>
<div>
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone">object.MemberwiseClone()</a>
</div>
</dd></dl>
<h2 class="section" id="constructors">Constructors
</h2>
<a id="OpenQA_Selenium_DevTools_V146_Accessibility_AccessibilityAdapter__ctor_" data-uid="OpenQA.Selenium.DevTools.V146.Accessibility.AccessibilityAdapter.#ctor*"></a>
<h3 id="OpenQA_Selenium_DevTools_V146_Accessibility_AccessibilityAdapter__ctor_OpenQA_Selenium_DevTools_IDevToolsSession_" data-uid="OpenQA.Selenium.DevTools.V146.Accessibility.AccessibilityAdapter.#ctor(OpenQA.Selenium.DevTools.IDevToolsSession)">
AccessibilityAdapter(IDevToolsSession)
<a class="header-action link-secondary" title="View source" href="https://github.com/SeleniumHQ/selenium/blob/docfix/bazel-bin/dotnet/src/webdriver/DevTools/v146/Accessibility/AccessibilityAdapter.cs/#L26"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"><p>Initializes a new instance of the AccessibilityAdapter class.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public AccessibilityAdapter(IDevToolsSession session)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>session</code> <a class="xref" href="OpenQA.Selenium.DevTools.IDevToolsSession.html">IDevToolsSession</a></dt>
<dd><p>The IDevToolsSession to be used with this adapter.</p>
</dd>
</dl>
<h4 class="section">Exceptions</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.argumentnullexception">ArgumentNullException</a></dt>
<dd><p>If <code class="paramref">session</code> is <a href="https://learn.microsoft.com/dotnet/csharp/language-reference/keywords/null">null</a>.</p>
</dd>
</dl>
<h2 class="section" id="properties">Properties
</h2>
<a id="OpenQA_Selenium_DevTools_V146_Accessibility_AccessibilityAdapter_Session_" data-uid="OpenQA.Selenium.DevTools.V146.Accessibility.AccessibilityAdapter.Session*"></a>
<h3 id="OpenQA_Selenium_DevTools_V146_Accessibility_AccessibilityAdapter_Session" data-uid="OpenQA.Selenium.DevTools.V146.Accessibility.AccessibilityAdapter.Session">
Session
<a class="header-action link-secondary" title="View source" href="https://github.com/SeleniumHQ/selenium/blob/docfix/bazel-bin/dotnet/src/webdriver/DevTools/v146/Accessibility/AccessibilityAdapter.cs/#L37"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"><p>Gets the DevToolsSession associated with the adapter.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public IDevToolsSession Session { get; }</code></pre>
</div>
<h4 class="section">Property Value</h4>
<dl class="parameters">
<dt><a class="xref" href="OpenQA.Selenium.DevTools.IDevToolsSession.html">IDevToolsSession</a></dt>
<dd></dd>
</dl>
<h2 class="section" id="methods">Methods
</h2>
<a id="OpenQA_Selenium_DevTools_V146_Accessibility_AccessibilityAdapter_Disable_" data-uid="OpenQA.Selenium.DevTools.V146.Accessibility.AccessibilityAdapter.Disable*"></a>
<h3 id="OpenQA_Selenium_DevTools_V146_Accessibility_AccessibilityAdapter_Disable_OpenQA_Selenium_DevTools_V146_Accessibility_DisableCommandSettings_System_Threading_CancellationToken_System_Nullable_System_Int32__System_Boolean_" data-uid="OpenQA.Selenium.DevTools.V146.Accessibility.AccessibilityAdapter.Disable(OpenQA.Selenium.DevTools.V146.Accessibility.DisableCommandSettings,System.Threading.CancellationToken,System.Nullable{System.Int32},System.Boolean)">
Disable(DisableCommandSettings?, CancellationToken, int?, bool)
<a class="header-action link-secondary" title="View source" href="https://github.com/SeleniumHQ/selenium/blob/docfix/bazel-bin/dotnet/src/webdriver/DevTools/v146/Accessibility/AccessibilityAdapter.cs/#L55"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"><p>Disables the accessibility domain.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public Task&lt;DisableCommandResponse?&gt; Disable(DisableCommandSettings? command = null, CancellationToken cancellationToken = default, int? millisecondsTimeout = null, bool throwExceptionIfResponseNotReceived = true)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>command</code> <a class="xref" href="OpenQA.Selenium.DevTools.V146.Accessibility.DisableCommandSettings.html">DisableCommandSettings</a></dt>
<dd></dd>
<dt><code>cancellationToken</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken">CancellationToken</a></dt>
<dd></dd>
<dt><code>millisecondsTimeout</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a>?</dt>
<dd></dd>
<dt><code>throwExceptionIfResponseNotReceived</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></dt>
<dd></dd>
</dl>
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.threading.tasks.task-1">Task</a>&lt;<a class="xref" href="OpenQA.Selenium.DevTools.V146.Accessibility.DisableCommandResponse.html">DisableCommandResponse</a>&gt;</dt>
<dd></dd>
</dl>
<a id="OpenQA_Selenium_DevTools_V146_Accessibility_AccessibilityAdapter_Enable_" data-uid="OpenQA.Selenium.DevTools.V146.Accessibility.AccessibilityAdapter.Enable*"></a>
<h3 id="OpenQA_Selenium_DevTools_V146_Accessibility_AccessibilityAdapter_Enable_OpenQA_Selenium_DevTools_V146_Accessibility_EnableCommandSettings_System_Threading_CancellationToken_System_Nullable_System_Int32__System_Boolean_" data-uid="OpenQA.Selenium.DevTools.V146.Accessibility.AccessibilityAdapter.Enable(OpenQA.Selenium.DevTools.V146.Accessibility.EnableCommandSettings,System.Threading.CancellationToken,System.Nullable{System.Int32},System.Boolean)">
Enable(EnableCommandSettings?, CancellationToken, int?, bool)
<a class="header-action link-secondary" title="View source" href="https://github.com/SeleniumHQ/selenium/blob/docfix/bazel-bin/dotnet/src/webdriver/DevTools/v146/Accessibility/AccessibilityAdapter.cs/#L64"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"><p>Enables the accessibility domain which causes <code>AXNodeId</code>s to remain consistent between method calls.
This turns on accessibility for the page, which can impact performance until accessibility is disabled.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public Task&lt;EnableCommandResponse?&gt; Enable(EnableCommandSettings? command = null, CancellationToken cancellationToken = default, int? millisecondsTimeout = null, bool throwExceptionIfResponseNotReceived = true)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>command</code> <a class="xref" href="OpenQA.Selenium.DevTools.V146.Accessibility.EnableCommandSettings.html">EnableCommandSettings</a></dt>
<dd></dd>
<dt><code>cancellationToken</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken">CancellationToken</a></dt>
<dd></dd>
<dt><code>millisecondsTimeout</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a>?</dt>
<dd></dd>
<dt><code>throwExceptionIfResponseNotReceived</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></dt>
<dd></dd>
</dl>
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.threading.tasks.task-1">Task</a>&lt;<a class="xref" href="OpenQA.Selenium.DevTools.V146.Accessibility.EnableCommandResponse.html">EnableCommandResponse</a>&gt;</dt>
<dd></dd>
</dl>
<a id="OpenQA_Selenium_DevTools_V146_Accessibility_AccessibilityAdapter_GetAXNodeAndAncestors_" data-uid="OpenQA.Selenium.DevTools.V146.Accessibility.AccessibilityAdapter.GetAXNodeAndAncestors*"></a>
<h3 id="OpenQA_Selenium_DevTools_V146_Accessibility_AccessibilityAdapter_GetAXNodeAndAncestors_OpenQA_Selenium_DevTools_V146_Accessibility_GetAXNodeAndAncestorsCommandSettings_System_Threading_CancellationToken_System_Nullable_System_Int32__System_Boolean_" data-uid="OpenQA.Selenium.DevTools.V146.Accessibility.AccessibilityAdapter.GetAXNodeAndAncestors(OpenQA.Selenium.DevTools.V146.Accessibility.GetAXNodeAndAncestorsCommandSettings,System.Threading.CancellationToken,System.Nullable{System.Int32},System.Boolean)">
GetAXNodeAndAncestors(GetAXNodeAndAncestorsCommandSettings, CancellationToken, int?, bool)
<a class="header-action link-secondary" title="View source" href="https://github.com/SeleniumHQ/selenium/blob/docfix/bazel-bin/dotnet/src/webdriver/DevTools/v146/Accessibility/AccessibilityAdapter.cs/#L98"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"><p>Fetches a node and all ancestors up to and including the root.
Requires <code>enable()</code> to have been called previously.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public Task&lt;GetAXNodeAndAncestorsCommandResponse&gt; GetAXNodeAndAncestors(GetAXNodeAndAncestorsCommandSettings command, CancellationToken cancellationToken = default, int? millisecondsTimeout = null, bool throwExceptionIfResponseNotReceived = true)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>command</code> <a class="xref" href="OpenQA.Selenium.DevTools.V146.Accessibility.GetAXNodeAndAncestorsCommandSettings.html">GetAXNodeAndAncestorsCommandSettings</a></dt>
<dd></dd>
<dt><code>cancellationToken</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken">CancellationToken</a></dt>
<dd></dd>
<dt><code>millisecondsTimeout</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a>?</dt>
<dd></dd>
<dt><code>throwExceptionIfResponseNotReceived</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></dt>
<dd></dd>
</dl>
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.threading.tasks.task-1">Task</a>&lt;<a class="xref" href="OpenQA.Selenium.DevTools.V146.Accessibility.GetAXNodeAndAncestorsCommandResponse.html">GetAXNodeAndAncestorsCommandResponse</a>&gt;</dt>
<dd></dd>
</dl>
<a id="OpenQA_Selenium_DevTools_V146_Accessibility_AccessibilityAdapter_GetChildAXNodes_" data-uid="OpenQA.Selenium.DevTools.V146.Accessibility.AccessibilityAdapter.GetChildAXNodes*"></a>
<h3 id="OpenQA_Selenium_DevTools_V146_Accessibility_AccessibilityAdapter_GetChildAXNodes_OpenQA_Selenium_DevTools_V146_Accessibility_GetChildAXNodesCommandSettings_System_Threading_CancellationToken_System_Nullable_System_Int32__System_Boolean_" data-uid="OpenQA.Selenium.DevTools.V146.Accessibility.AccessibilityAdapter.GetChildAXNodes(OpenQA.Selenium.DevTools.V146.Accessibility.GetChildAXNodesCommandSettings,System.Threading.CancellationToken,System.Nullable{System.Int32},System.Boolean)">
GetChildAXNodes(GetChildAXNodesCommandSettings, CancellationToken, int?, bool)
<a class="header-action link-secondary" title="View source" href="https://github.com/SeleniumHQ/selenium/blob/docfix/bazel-bin/dotnet/src/webdriver/DevTools/v146/Accessibility/AccessibilityAdapter.cs/#L107"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"><p>Fetches a particular accessibility node by AXNodeId.
Requires <code>enable()</code> to have been called previously.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public Task&lt;GetChildAXNodesCommandResponse&gt; GetChildAXNodes(GetChildAXNodesCommandSettings command, CancellationToken cancellationToken = default, int? millisecondsTimeout = null, bool throwExceptionIfResponseNotReceived = true)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>command</code> <a class="xref" href="OpenQA.Selenium.DevTools.V146.Accessibility.GetChildAXNodesCommandSettings.html">GetChildAXNodesCommandSettings</a></dt>
<dd></dd>
<dt><code>cancellationToken</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken">CancellationToken</a></dt>
<dd></dd>
<dt><code>millisecondsTimeout</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a>?</dt>
<dd></dd>
<dt><code>throwExceptionIfResponseNotReceived</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></dt>
<dd></dd>
</dl>
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.threading.tasks.task-1">Task</a>&lt;<a class="xref" href="OpenQA.Selenium.DevTools.V146.Accessibility.GetChildAXNodesCommandResponse.html">GetChildAXNodesCommandResponse</a>&gt;</dt>
<dd></dd>
</dl>
<a id="OpenQA_Selenium_DevTools_V146_Accessibility_AccessibilityAdapter_GetFullAXTree_" data-uid="OpenQA.Selenium.DevTools.V146.Accessibility.AccessibilityAdapter.GetFullAXTree*"></a>
<h3 id="OpenQA_Selenium_DevTools_V146_Accessibility_AccessibilityAdapter_GetFullAXTree_OpenQA_Selenium_DevTools_V146_Accessibility_GetFullAXTreeCommandSettings_System_Threading_CancellationToken_System_Nullable_System_Int32__System_Boolean_" data-uid="OpenQA.Selenium.DevTools.V146.Accessibility.AccessibilityAdapter.GetFullAXTree(OpenQA.Selenium.DevTools.V146.Accessibility.GetFullAXTreeCommandSettings,System.Threading.CancellationToken,System.Nullable{System.Int32},System.Boolean)">
GetFullAXTree(GetFullAXTreeCommandSettings, CancellationToken, int?, bool)
<a class="header-action link-secondary" title="View source" href="https://github.com/SeleniumHQ/selenium/blob/docfix/bazel-bin/dotnet/src/webdriver/DevTools/v146/Accessibility/AccessibilityAdapter.cs/#L80"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"><p>Fetches the entire accessibility tree for the root Document</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public Task&lt;GetFullAXTreeCommandResponse&gt; GetFullAXTree(GetFullAXTreeCommandSettings command, CancellationToken cancellationToken = default, int? millisecondsTimeout = null, bool throwExceptionIfResponseNotReceived = true)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>command</code> <a class="xref" href="OpenQA.Selenium.DevTools.V146.Accessibility.GetFullAXTreeCommandSettings.html">GetFullAXTreeCommandSettings</a></dt>
<dd></dd>
<dt><code>cancellationToken</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken">CancellationToken</a></dt>
<dd></dd>
<dt><code>millisecondsTimeout</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a>?</dt>
<dd></dd>
<dt><code>throwExceptionIfResponseNotReceived</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></dt>
<dd></dd>
</dl>
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.threading.tasks.task-1">Task</a>&lt;<a class="xref" href="OpenQA.Selenium.DevTools.V146.Accessibility.GetFullAXTreeCommandResponse.html">GetFullAXTreeCommandResponse</a>&gt;</dt>
<dd></dd>
</dl>
<a id="OpenQA_Selenium_DevTools_V146_Accessibility_AccessibilityAdapter_GetPartialAXTree_" data-uid="OpenQA.Selenium.DevTools.V146.Accessibility.AccessibilityAdapter.GetPartialAXTree*"></a>
<h3 id="OpenQA_Selenium_DevTools_V146_Accessibility_AccessibilityAdapter_GetPartialAXTree_OpenQA_Selenium_DevTools_V146_Accessibility_GetPartialAXTreeCommandSettings_System_Threading_CancellationToken_System_Nullable_System_Int32__System_Boolean_" data-uid="OpenQA.Selenium.DevTools.V146.Accessibility.AccessibilityAdapter.GetPartialAXTree(OpenQA.Selenium.DevTools.V146.Accessibility.GetPartialAXTreeCommandSettings,System.Threading.CancellationToken,System.Nullable{System.Int32},System.Boolean)">
GetPartialAXTree(GetPartialAXTreeCommandSettings, CancellationToken, int?, bool)
<a class="header-action link-secondary" title="View source" href="https://github.com/SeleniumHQ/selenium/blob/docfix/bazel-bin/dotnet/src/webdriver/DevTools/v146/Accessibility/AccessibilityAdapter.cs/#L72"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"><p>Fetches the accessibility node and partial accessibility tree for this DOM node, if it exists.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public Task&lt;GetPartialAXTreeCommandResponse&gt; GetPartialAXTree(GetPartialAXTreeCommandSettings command, CancellationToken cancellationToken = default, int? millisecondsTimeout = null, bool throwExceptionIfResponseNotReceived = true)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>command</code> <a class="xref" href="OpenQA.Selenium.DevTools.V146.Accessibility.GetPartialAXTreeCommandSettings.html">GetPartialAXTreeCommandSettings</a></dt>
<dd></dd>
<dt><code>cancellationToken</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken">CancellationToken</a></dt>
<dd></dd>
<dt><code>millisecondsTimeout</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a>?</dt>
<dd></dd>
<dt><code>throwExceptionIfResponseNotReceived</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></dt>
<dd></dd>
</dl>
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.threading.tasks.task-1">Task</a>&lt;<a class="xref" href="OpenQA.Selenium.DevTools.V146.Accessibility.GetPartialAXTreeCommandResponse.html">GetPartialAXTreeCommandResponse</a>&gt;</dt>
<dd></dd>
</dl>
<a id="OpenQA_Selenium_DevTools_V146_Accessibility_AccessibilityAdapter_GetRootAXNode_" data-uid="OpenQA.Selenium.DevTools.V146.Accessibility.AccessibilityAdapter.GetRootAXNode*"></a>
<h3 id="OpenQA_Selenium_DevTools_V146_Accessibility_AccessibilityAdapter_GetRootAXNode_OpenQA_Selenium_DevTools_V146_Accessibility_GetRootAXNodeCommandSettings_System_Threading_CancellationToken_System_Nullable_System_Int32__System_Boolean_" data-uid="OpenQA.Selenium.DevTools.V146.Accessibility.AccessibilityAdapter.GetRootAXNode(OpenQA.Selenium.DevTools.V146.Accessibility.GetRootAXNodeCommandSettings,System.Threading.CancellationToken,System.Nullable{System.Int32},System.Boolean)">
GetRootAXNode(GetRootAXNodeCommandSettings, CancellationToken, int?, bool)
<a class="header-action link-secondary" title="View source" href="https://github.com/SeleniumHQ/selenium/blob/docfix/bazel-bin/dotnet/src/webdriver/DevTools/v146/Accessibility/AccessibilityAdapter.cs/#L89"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"><p>Fetches the root node.
Requires <code>enable()</code> to have been called previously.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public Task&lt;GetRootAXNodeCommandResponse&gt; GetRootAXNode(GetRootAXNodeCommandSettings command, CancellationToken cancellationToken = default, int? millisecondsTimeout = null, bool throwExceptionIfResponseNotReceived = true)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>command</code> <a class="xref" href="OpenQA.Selenium.DevTools.V146.Accessibility.GetRootAXNodeCommandSettings.html">GetRootAXNodeCommandSettings</a></dt>
<dd></dd>
<dt><code>cancellationToken</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken">CancellationToken</a></dt>
<dd></dd>
<dt><code>millisecondsTimeout</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a>?</dt>
<dd></dd>
<dt><code>throwExceptionIfResponseNotReceived</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></dt>
<dd></dd>
</dl>
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.threading.tasks.task-1">Task</a>&lt;<a class="xref" href="OpenQA.Selenium.DevTools.V146.Accessibility.GetRootAXNodeCommandResponse.html">GetRootAXNodeCommandResponse</a>&gt;</dt>
<dd></dd>
</dl>
<a id="OpenQA_Selenium_DevTools_V146_Accessibility_AccessibilityAdapter_QueryAXTree_" data-uid="OpenQA.Selenium.DevTools.V146.Accessibility.AccessibilityAdapter.QueryAXTree*"></a>
<h3 id="OpenQA_Selenium_DevTools_V146_Accessibility_AccessibilityAdapter_QueryAXTree_OpenQA_Selenium_DevTools_V146_Accessibility_QueryAXTreeCommandSettings_System_Threading_CancellationToken_System_Nullable_System_Int32__System_Boolean_" data-uid="OpenQA.Selenium.DevTools.V146.Accessibility.AccessibilityAdapter.QueryAXTree(OpenQA.Selenium.DevTools.V146.Accessibility.QueryAXTreeCommandSettings,System.Threading.CancellationToken,System.Nullable{System.Int32},System.Boolean)">
QueryAXTree(QueryAXTreeCommandSettings, CancellationToken, int?, bool)
<a class="header-action link-secondary" title="View source" href="https://github.com/SeleniumHQ/selenium/blob/docfix/bazel-bin/dotnet/src/webdriver/DevTools/v146/Accessibility/AccessibilityAdapter.cs/#L119"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"><p>Query a DOM node's accessibility subtree for accessible name and role.
This command computes the name and role for all nodes in the subtree, including those that are
ignored for accessibility, and returns those that match the specified name and role. If no DOM
node is specified, or the DOM node does not exist, the command returns an error. If neither
<code>accessibleName</code> or <code>role</code> is specified, it returns all the accessibility nodes in the subtree.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public Task&lt;QueryAXTreeCommandResponse&gt; QueryAXTree(QueryAXTreeCommandSettings command, CancellationToken cancellationToken = default, int? millisecondsTimeout = null, bool throwExceptionIfResponseNotReceived = true)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>command</code> <a class="xref" href="OpenQA.Selenium.DevTools.V146.Accessibility.QueryAXTreeCommandSettings.html">QueryAXTreeCommandSettings</a></dt>
<dd></dd>
<dt><code>cancellationToken</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken">CancellationToken</a></dt>
<dd></dd>
<dt><code>millisecondsTimeout</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a>?</dt>
<dd></dd>
<dt><code>throwExceptionIfResponseNotReceived</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></dt>
<dd></dd>
</dl>
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.threading.tasks.task-1">Task</a>&lt;<a class="xref" href="OpenQA.Selenium.DevTools.V146.Accessibility.QueryAXTreeCommandResponse.html">QueryAXTreeCommandResponse</a>&gt;</dt>
<dd></dd>
</dl>
<h2 class="section" id="events">Events
</h2>
<h3 id="OpenQA_Selenium_DevTools_V146_Accessibility_AccessibilityAdapter_LoadComplete" data-uid="OpenQA.Selenium.DevTools.V146.Accessibility.AccessibilityAdapter.LoadComplete">
LoadComplete
<a class="header-action link-secondary" title="View source" href="https://github.com/SeleniumHQ/selenium/blob/docfix/bazel-bin/dotnet/src/webdriver/DevTools/v146/Accessibility/AccessibilityAdapter.cs/#L43"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"><p>The loadComplete event mirrors the load complete event sent by the browser to assistive
technology when the web page has finished loading.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public event EventHandler&lt;LoadCompleteEventArgs&gt;? LoadComplete</code></pre>
</div>
<h4 class="section">Event Type</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.eventhandler-1">EventHandler</a>&lt;<a class="xref" href="OpenQA.Selenium.DevTools.V146.Accessibility.LoadCompleteEventArgs.html">LoadCompleteEventArgs</a>&gt;</dt>
<dd></dd>
</dl>
<h3 id="OpenQA_Selenium_DevTools_V146_Accessibility_AccessibilityAdapter_NodesUpdated" data-uid="OpenQA.Selenium.DevTools.V146.Accessibility.AccessibilityAdapter.NodesUpdated">
NodesUpdated
<a class="header-action link-secondary" title="View source" href="https://github.com/SeleniumHQ/selenium/blob/docfix/bazel-bin/dotnet/src/webdriver/DevTools/v146/Accessibility/AccessibilityAdapter.cs/#L48"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"><p>The nodesUpdated event is sent every time a previously requested node has changed the in tree.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public event EventHandler&lt;NodesUpdatedEventArgs&gt;? NodesUpdated</code></pre>
</div>
<h4 class="section">Event Type</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.eventhandler-1">EventHandler</a>&lt;<a class="xref" href="OpenQA.Selenium.DevTools.V146.Accessibility.NodesUpdatedEventArgs.html">NodesUpdatedEventArgs</a>&gt;</dt>
<dd></dd>
</dl>
</article>
<div class="contribution d-print-none">
<a href="https://github.com/SeleniumHQ/selenium/blob/docfix/bazel-bin/dotnet/src/webdriver/DevTools/v146/Accessibility/AccessibilityAdapter.cs/#L16" class="edit-link">Edit this page</a>
</div>
</div>
<div class="affix">
<nav id="affix"></nav>
</div>
</main>
<div class="container-xxl search-results" id="search-results"></div>
<footer class="border-top text-secondary">
<div class="container-xxl">
<div class="flex-fill">
<span>Made with <a href="https://dotnet.github.io/docfx">docfx</a></span>
</div>
</div>
</footer>
</body>
</html>