blob: 4f8f53eea0cc84a5aafa0f9a65bd1bd4c976723b [file] [edit]
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>Namespace OpenQA.Selenium.DevTools.V144.Accessibility </title>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="title" content="Namespace OpenQA.Selenium.DevTools.V144.Accessibility ">
<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="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.V144.Accessibility">
<h1 id="OpenQA_Selenium_DevTools_V144_Accessibility" data-uid="OpenQA.Selenium.DevTools.V144.Accessibility" class="text-break">Namespace OpenQA.Selenium.DevTools.V144.Accessibility</h1>
<div class="markdown level0 summary"></div>
<div class="markdown level0 conceptual"></div>
<div class="markdown level0 remarks"></div>
<h3 id="classes">
Classes
</h3>
<dl class="jumplist">
<dt><a class="xref" href="OpenQA.Selenium.DevTools.V144.Accessibility.AXNode.html">AXNode</a></dt>
<dd><p>A node in the accessibility tree.</p>
</dd>
</dl>
<dl class="jumplist">
<dt><a class="xref" href="OpenQA.Selenium.DevTools.V144.Accessibility.AXProperty.html">AXProperty</a></dt>
<dd><p>AXProperty</p>
</dd>
</dl>
<dl class="jumplist">
<dt><a class="xref" href="OpenQA.Selenium.DevTools.V144.Accessibility.AXRelatedNode.html">AXRelatedNode</a></dt>
<dd><p>AXRelatedNode</p>
</dd>
</dl>
<dl class="jumplist">
<dt><a class="xref" href="OpenQA.Selenium.DevTools.V144.Accessibility.AXValue.html">AXValue</a></dt>
<dd><p>A single computed AX property.</p>
</dd>
</dl>
<dl class="jumplist">
<dt><a class="xref" href="OpenQA.Selenium.DevTools.V144.Accessibility.AXValueSource.html">AXValueSource</a></dt>
<dd><p>A single source for a computed AX property.</p>
</dd>
</dl>
<dl class="jumplist">
<dt><a class="xref" href="OpenQA.Selenium.DevTools.V144.Accessibility.AccessibilityAdapter.html">AccessibilityAdapter</a></dt>
<dd><p>Represents an adapter for the Accessibility domain to simplify the command interface.</p>
</dd>
</dl>
<dl class="jumplist">
<dt><a class="xref" href="OpenQA.Selenium.DevTools.V144.Accessibility.DisableCommandResponse.html">DisableCommandResponse</a></dt>
<dd><p>Response for Disables the accessibility domain.</p>
</dd>
</dl>
<dl class="jumplist">
<dt><a class="xref" href="OpenQA.Selenium.DevTools.V144.Accessibility.DisableCommandSettings.html">DisableCommandSettings</a></dt>
<dd><p>Disables the accessibility domain.</p>
</dd>
</dl>
<dl class="jumplist">
<dt><a class="xref" href="OpenQA.Selenium.DevTools.V144.Accessibility.EnableCommandResponse.html">EnableCommandResponse</a></dt>
<dd><p>Response for 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>
</dd>
</dl>
<dl class="jumplist">
<dt><a class="xref" href="OpenQA.Selenium.DevTools.V144.Accessibility.EnableCommandSettings.html">EnableCommandSettings</a></dt>
<dd><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>
</dd>
</dl>
<dl class="jumplist">
<dt><a class="xref" href="OpenQA.Selenium.DevTools.V144.Accessibility.GetAXNodeAndAncestorsCommandResponse.html">GetAXNodeAndAncestorsCommandResponse</a></dt>
<dd><p>Response for Fetches a node and all ancestors up to and including the root.
Requires <code>enable()</code> to have been called previously.</p>
</dd>
</dl>
<dl class="jumplist">
<dt><a class="xref" href="OpenQA.Selenium.DevTools.V144.Accessibility.GetAXNodeAndAncestorsCommandSettings.html">GetAXNodeAndAncestorsCommandSettings</a></dt>
<dd><p>Fetches a node and all ancestors up to and including the root.
Requires <code>enable()</code> to have been called previously.</p>
</dd>
</dl>
<dl class="jumplist">
<dt><a class="xref" href="OpenQA.Selenium.DevTools.V144.Accessibility.GetChildAXNodesCommandResponse.html">GetChildAXNodesCommandResponse</a></dt>
<dd><p>Response for Fetches a particular accessibility node by AXNodeId.
Requires <code>enable()</code> to have been called previously.</p>
</dd>
</dl>
<dl class="jumplist">
<dt><a class="xref" href="OpenQA.Selenium.DevTools.V144.Accessibility.GetChildAXNodesCommandSettings.html">GetChildAXNodesCommandSettings</a></dt>
<dd><p>Fetches a particular accessibility node by AXNodeId.
Requires <code>enable()</code> to have been called previously.</p>
</dd>
</dl>
<dl class="jumplist">
<dt><a class="xref" href="OpenQA.Selenium.DevTools.V144.Accessibility.GetFullAXTreeCommandResponse.html">GetFullAXTreeCommandResponse</a></dt>
<dd><p>Response for Fetches the entire accessibility tree for the root Document</p>
</dd>
</dl>
<dl class="jumplist">
<dt><a class="xref" href="OpenQA.Selenium.DevTools.V144.Accessibility.GetFullAXTreeCommandSettings.html">GetFullAXTreeCommandSettings</a></dt>
<dd><p>Fetches the entire accessibility tree for the root Document</p>
</dd>
</dl>
<dl class="jumplist">
<dt><a class="xref" href="OpenQA.Selenium.DevTools.V144.Accessibility.GetPartialAXTreeCommandResponse.html">GetPartialAXTreeCommandResponse</a></dt>
<dd><p>Response for Fetches the accessibility node and partial accessibility tree for this DOM node, if it exists.</p>
</dd>
</dl>
<dl class="jumplist">
<dt><a class="xref" href="OpenQA.Selenium.DevTools.V144.Accessibility.GetPartialAXTreeCommandSettings.html">GetPartialAXTreeCommandSettings</a></dt>
<dd><p>Fetches the accessibility node and partial accessibility tree for this DOM node, if it exists.</p>
</dd>
</dl>
<dl class="jumplist">
<dt><a class="xref" href="OpenQA.Selenium.DevTools.V144.Accessibility.GetRootAXNodeCommandResponse.html">GetRootAXNodeCommandResponse</a></dt>
<dd><p>Response for Fetches the root node.
Requires <code>enable()</code> to have been called previously.</p>
</dd>
</dl>
<dl class="jumplist">
<dt><a class="xref" href="OpenQA.Selenium.DevTools.V144.Accessibility.GetRootAXNodeCommandSettings.html">GetRootAXNodeCommandSettings</a></dt>
<dd><p>Fetches the root node.
Requires <code>enable()</code> to have been called previously.</p>
</dd>
</dl>
<dl class="jumplist">
<dt><a class="xref" href="OpenQA.Selenium.DevTools.V144.Accessibility.LoadCompleteEventArgs.html">LoadCompleteEventArgs</a></dt>
<dd><p>The loadComplete event mirrors the load complete event sent by the browser to assistive
technology when the web page has finished loading.</p>
</dd>
</dl>
<dl class="jumplist">
<dt><a class="xref" href="OpenQA.Selenium.DevTools.V144.Accessibility.NodesUpdatedEventArgs.html">NodesUpdatedEventArgs</a></dt>
<dd><p>The nodesUpdated event is sent every time a previously requested node has changed the in tree.</p>
</dd>
</dl>
<dl class="jumplist">
<dt><a class="xref" href="OpenQA.Selenium.DevTools.V144.Accessibility.QueryAXTreeCommandResponse.html">QueryAXTreeCommandResponse</a></dt>
<dd><p>Response for 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>
</dd>
</dl>
<dl class="jumplist">
<dt><a class="xref" href="OpenQA.Selenium.DevTools.V144.Accessibility.QueryAXTreeCommandSettings.html">QueryAXTreeCommandSettings</a></dt>
<dd><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>
</dd>
</dl>
<h3 id="enums">
Enums
</h3>
<dl class="jumplist">
<dt><a class="xref" href="OpenQA.Selenium.DevTools.V144.Accessibility.AXPropertyName.html">AXPropertyName</a></dt>
<dd><p>Values of AXProperty name:</p>
<ul>
<li>from 'busy' to 'roledescription': states which apply to every AX node</li>
<li>from 'live' to 'root': attributes which apply to nodes in live regions</li>
<li>from 'autocomplete' to 'valuetext': attributes which apply to widgets</li>
<li>from 'checked' to 'selected': states which apply to widgets</li>
<li>from 'activedescendant' to 'owns': relationships between elements other than parent/child/sibling</li>
<li>from 'activeFullscreenElement' to 'uninteresting': reasons why this noode is hidden</li>
</ul>
</dd>
</dl>
<dl class="jumplist">
<dt><a class="xref" href="OpenQA.Selenium.DevTools.V144.Accessibility.AXValueNativeSourceType.html">AXValueNativeSourceType</a></dt>
<dd><p>Enum of possible native property sources (as a subtype of a particular AXValueSourceType).</p>
</dd>
</dl>
<dl class="jumplist">
<dt><a class="xref" href="OpenQA.Selenium.DevTools.V144.Accessibility.AXValueSourceType.html">AXValueSourceType</a></dt>
<dd><p>Enum of possible property sources.</p>
</dd>
</dl>
<dl class="jumplist">
<dt><a class="xref" href="OpenQA.Selenium.DevTools.V144.Accessibility.AXValueType.html">AXValueType</a></dt>
<dd><p>Enum of possible property types.</p>
</dd>
</dl>
</article>
<div class="contribution d-print-none">
</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>