Axe.Windows.Automation

The exception type thrown for all unhandled errors in Axe.Windows.Automation. If an exception was thrown from code not owned by Axe.Windows.Automation, that exception will be wrapped in In the property.

Default constructor

Constructor taking a message

Constructor taking a message string and an optional inner exception to wrap

Serialization constructor

Configuration options for creating an AxeWindows automation session

The process Id of the application to test. If the value is invalid, the automation session will throw an .

The directory to which any output files should be written. This value is ignored if is set to . If this value is null, and if is not set to , files will be written to a directory named "AxeWindowsScanResults" under the current directory. If the value is not null, and the given directory does not exist, the object will attempt to create it. If the directory cannot be created, an will be thrown.

No output files will be written if no errors were found during the automation session.

Flags specifying the type of output file to create. Multiple values may be specified using the '|' (or) operator

No output files will be written if no errors were found during the automation session.

The path to a file containing configuration instructing Axe Windows how to interpret custom UI Automation data.

Override the default behavior of only saving a11ytest files if errors are found.

Override the default behavior of not testing Chromium content.

Custom handling of DPI awareness. The default handling is to set the entire process as DPI-aware before running the scan, and to leave it in that state after the scan completes. If your process needs to be non-DPI aware, create your own implementation of IDPIAwareness that meets your needs.

Builds an instance of the class

Create the builder for the specified process

Specify the directory where any output files should be written

Specifies a custom mechanism to enable/restore DPI awareness during a scan

Specify the type(s) of output files you wish AxeWindows to create

Specify the path to a custom configuration file instructing Axe Windows how to interpret custom UIA data.

Configure Axe.Windows to always save test files in the specified format, even if no errors are found. By default, test files are saved only if errors are found or if multiple top-level windows exist.

Configure Axe.Windows to test all Chromium content. By default, Chromium content is not tested.

Build an instance of

Contains identifying information about an element

This element's parent element.

A string to string dictionary where the key is a UIAutomation property name and the value is the corresponding UI Automation property value.

The key strings are likely to be very stable, so it will be safe to index certain keys without fear of breaking changes. Only properties with values set will be included.

A list of names of supported patterns

The names are likely to be very stable.

Represents the output file(s), if any, associated with a WindowScanOutput object

The A11yTest file that was generated (or null if no file was generated)

The Sarif file that was generated (or null if no file was generated)

Private constructor. Called by the BuildFrom* methods

The A11yTest file that was created (if any) The Sarif file that was created (if any)

Build an OutputFile containing just an A11yTest file

Represents options for methods of . Passing null in place of a ScanOptions object to methods will use default values for all options.

The ID of this scan. Must be null or meet the requirements for a file name.

The window handle for the root of the UIA subtree to scan.

Constructor

The ID of this scan. Must be null or meet the requirements for a file name. The window handle for the root of the UIA subtree to scan.

Contains information, such as WindowScanOutput objects, related to a particular invocation of the IScanner interface. This object currently contains a collection of WindowScanOutput objects. However, additional fields may be added at a future time to add extra information without breaking existing users of the IScanner API.

A collection of WindowScanOutput objects produced from this scan

Constructor

A collection of WindowScanOutput objects produced from this scan

The result of a single rule test on a single element

Information about the rule that evaluated the element specified by

The element which was tested against the rule specified in

Contains information about an AxeWindows automated scan

A object containing paths to any output files written as a result of a scan.

This property's members may be null if no output files were written. That may happen if no was specified or was set to . This property's members will also be null if no errors were found.

A count of all errors across all elements scanned.

This may be useful as a simple test to determine if the number of errors between scans of the same area of an application has increased or (hopefully) decreased.

A collection of errors found during the scan.

Use this to get in-depth information about the rule + element combination for each error.

Bit flags to specify which output file formats a should write

Create no output files

Create output files which can be opened using Accessibility Insights for Windows.

Factory used to create objects for internal use

The Interface representing the boundary between this Automation library and the other parts (in other projects) of AxeWindows which perform the actual scan. The code behind this interface should be unit tested as part of the projects where it is implemented, not as part of this (Automation) project.

Runs a scan and calls a callback which can transform the results into another form and/or save output files

The type of results object to be returned by the callback The element from which to start the scan A delegate which can act on results and transform them into a specified type Context for storing action-related data

Takes a screenshot, highlighting the given element

Context for storing action-related data

Saves an a11ytest file to the given path

Context for storing Action-related data

Registers the custom UI Automation properties defined in the configuration file at path

Specify how Chromium content should be evaluated

This can be set to true to allow browser teams to test and debug code that converts from HTML to UIA. It should be set to false for all other scenarios.

UIA operates in physical screen coordinates, so DPI awareness must be enabled while scanning. Methods on this interface will be called before the first scan begins and after the last scan completes.

Enable DPI awareness for the scan

An object that will be passed as a parameter

Restore DPI awareness to its original state

The object returned from the call to

Factory used to create objects for internal use

Runs AxeWindows automated tests

Asynchronously run AxeWindows automated tests

An instance of . If null, default options will be used. A cancellation token. If a value was provided in , output files may be written to the specified directory. (Note: no output files will be written if no errors were found.) An exception may be thrown if the value of is invalid or if the directory provided in cannot be created or accessed. Information about the scan and any issues detected

Synchronously run AxeWindows automated tests

An instance of . If null, default options will be used. If a value was provided in , output files may be written to the specified directory. (Note: no output files will be written if no errors were found.) An exception may be thrown if the value of is invalid or if the directory provided in cannot be created or accessed. Information about the scan and any issues detected

Provides methods used to assemble and objects

Assembles failed scans from the provided element

Root element from which the scan output will be assembled A WindowScanOutput object containing the relevant errors and error count

Encapsulates the set of tools used to scan, assemble results, and write output files

Check if the given path is a well-formed absolute path. If not, throw and .

Ensures the output directory for the file path returned by exists.

If the directory does not exist, the method attempts to create it. This method does not catch any exceptions so that file IO errors are reported to the user.

A strongly-typed resource class, for looking up localized strings, etc.

Returns the cached ResourceManager instance used by this class.

Overrides the current thread's CurrentUICulture property for all resource lookups using this strongly typed resource class.

Looks up a localized string similar to The directory "{0}" was invalid..

Looks up a localized string similar to Failed to get the root element(s) of the specified process({0}).

Looks up a localized string similar to The given path was not an absolute path..

Looks up a localized string similar to {0} not found in {1} dictionary..

Looks up a localized string similar to Unable to set Data context (more than {0:N0} elements were found).

Looks up a localized string similar to Unable to set Data context.

Looks up a localized string similar to Unhandled Exception {0}.

Looks up a localized string similar to The argument must be a non-empty IEnumerable.

Looks up a localized string similar to The Actions property of the given ScanTools object should not be null.

Looks up a localized string similar to The DpiAwareness property of the given ScanTools object should not be null.

Looks up a localized string similar to The OutputFileHelper property of the given ScanTools object should not be null.

Looks up a localized string similar to The ResultsAssembler property of the given ScanTools object should not be null.

Looks up a localized string similar to The TargetElementLocator property of the given ScanTools object should not be null.

Looks up a localized string similar to The given string must not be null or white space.

Looks up a localized string similar to Expected the variable '{0}' not to be null.

Implementation of the interface

Create objects that implement IScanner

Create an object that implements IScanner

Provides methods used to assemble and objects

Assembles failed scans from the provided element

Root element from which the scan output will be assembled A WindowScanOutput object containing the relevant errors and error count

Assembles errors recursively into a list starting at the given element

Where the objects created from errors will be added Root element from which errors will be assembled The parent of element

Class to take a snapshot (via SnapshotCommand.Execute*).

Execute the scan asynchronously

A set of configuration options A set of tools for writing output files, creating the expected results format, and finding the target element to scan A cancellation token A ScanOutput object that describes the result of the command

Execute the scan synchronously

A set of configuration options A set of tools for writing output files, creating the expected results format, and finding the target element to scan A ScanOutput object that describes the result of the command

This method is our atomic scanner. It needs to run within the scope of a single thread.