Microsoft.UI.Xaml.Automation.Peers Namespace

Defines support types for the Microsoft UI Automation infrastructure.

Note

This namespace requires the Microsoft.UI.Xaml.Controls NuGet package, a part of the Microsoft Windows UI Library.

This documentation applies to WinUI 2 for UWP (for WinUI in the Windows App SDK, see the Windows App SDK namespaces).

Classes

AnimatedVisualPlayerAutomationPeer

Exposes AnimatedVisualPlayer types to Microsoft UI Automation.

This documentation applies to WinUI 2 for UWP (for WinUI in the Windows App SDK, see the Windows App SDK namespaces).

BreadcrumbBarItemAutomationPeer

Exposes BreadcrumbBar types to Microsoft UI Automation.

This documentation applies to WinUI 2 for UWP (for WinUI in the Windows App SDK, see the Windows App SDK namespaces).

ColorPickerSliderAutomationPeer

Exposes ColorPickerSlider types to Microsoft UI Automation.

This documentation applies to WinUI 2 for UWP (for WinUI in the Windows App SDK, see the Windows App SDK namespaces).

ColorSpectrumAutomationPeer

Exposes ColorSpectrum types to Microsoft UI Automation.

This documentation applies to WinUI 2 for UWP (for WinUI in the Windows App SDK, see the Windows App SDK namespaces).

DropDownButtonAutomationPeer

Exposes DropDownButton types to Microsoft UI Automation.

This documentation applies to WinUI 2 for UWP (for WinUI in the Windows App SDK, see the Windows App SDK namespaces).

ExpanderAutomationPeer

Exposes Expander types to Microsoft UI Automation.

This documentation applies to WinUI 2 for UWP (for WinUI in the Windows App SDK, see the Windows App SDK namespaces).

InfoBarAutomationPeer

Exposes InfoBar types to Microsoft UI Automation.

This documentation applies to WinUI 2 for UWP (for WinUI in the Windows App SDK, see the Windows App SDK namespaces).

MenuBarAutomationPeer

Exposes MenuBar types to Microsoft UI Automation.

This documentation applies to WinUI 2 for UWP (for WinUI in the Windows App SDK, see the Windows App SDK namespaces).

MenuBarItemAutomationPeer

Exposes MenuBarItem types to Microsoft UI Automation.

This documentation applies to WinUI 2 for UWP (for WinUI in the Windows App SDK, see the Windows App SDK namespaces).

NavigationViewAutomationPeer

Exposes NavigationView types to Microsoft UI Automation.

This documentation applies to WinUI 2 for UWP (for WinUI in the Windows App SDK, see the Windows App SDK namespaces).

NavigationViewItemAutomationPeer

Exposes NavigationViewItem types to Microsoft UI Automation.

This documentation applies to WinUI 2 for UWP (for WinUI in the Windows App SDK, see the Windows App SDK namespaces).

NumberBoxAutomationPeer

Exposes NumberBox types to Microsoft UI Automation.

This documentation applies to WinUI 2 for UWP (for WinUI in the Windows App SDK, see the Windows App SDK namespaces).

PagerControlAutomationPeer

Exposes PagerControl types to Microsoft UI Automation. (Not supported.)

This documentation applies to WinUI 2 for UWP (for WinUI in the Windows App SDK, see the Windows App SDK namespaces).

PersonPictureAutomationPeer

Exposes PersonPicture types to Microsoft UI Automation.

This documentation applies to WinUI 2 for UWP (for WinUI in the Windows App SDK, see the Windows App SDK namespaces).

PipsPagerAutomationPeer

Exposes PipsPager types to Microsoft UI Automation.

This documentation applies to WinUI 2 for UWP (for WinUI in the Windows App SDK, see the Windows App SDK namespaces).

ProgressBarAutomationPeer

Exposes ProgressBar types to Microsoft UI Automation.

This documentation applies to WinUI 2 for UWP (for WinUI in the Windows App SDK, see the Windows App SDK namespaces).

ProgressRingAutomationPeer

Exposes ProgressRing types to Microsoft UI Automation.

This documentation applies to WinUI 2 for UWP (for WinUI in the Windows App SDK, see the Windows App SDK namespaces).

RadioButtonsAutomationPeer

Exposes RadioButtons types to Microsoft UI Automation.

This documentation applies to WinUI 2 for UWP (for WinUI in the Windows App SDK, see the Windows App SDK namespaces).

RatingControlAutomationPeer

Exposes RatingControl types to Microsoft UI Automation.

This documentation applies to WinUI 2 for UWP (for WinUI in the Windows App SDK, see the Windows App SDK namespaces).

RepeaterAutomationPeer

Exposes ItemsRepeater types to Microsoft UI Automation.

This documentation applies to WinUI 2 for UWP (for WinUI in the Windows App SDK, see the Windows App SDK namespaces).

ScrollPresenterAutomationPeer

Exposes ScrollPresenter types to Microsoft UI Automation.

This documentation applies to WinUI 2 for UWP (for WinUI in the Windows App SDK, see the Windows App SDK namespaces).

SplitButtonAutomationPeer

Exposes SplitButton types to Microsoft UI Automation.

This documentation applies to WinUI 2 for UWP (for WinUI in the Windows App SDK, see the Windows App SDK namespaces).

TabViewAutomationPeer

Exposes TabView types to Microsoft UI Automation.

This documentation applies to WinUI 2 for UWP (for WinUI in the Windows App SDK, see the Windows App SDK namespaces).

TabViewItemAutomationPeer

Exposes TabViewItem types to Microsoft UI Automation.

This documentation applies to WinUI 2 for UWP (for WinUI in the Windows App SDK, see the Windows App SDK namespaces).

TeachingTipAutomationPeer

Exposes TeachingTip types to Microsoft UI Automation.

This documentation applies to WinUI 2 for UWP (for WinUI in the Windows App SDK, see the Windows App SDK namespaces).

ToggleSplitButtonAutomationPeer

Exposes ToggleSplitButton types to Microsoft UI Automation.

This documentation applies to WinUI 2 for UWP (for WinUI in the Windows App SDK, see the Windows App SDK namespaces).

TreeViewItemAutomationPeer

Exposes TreeViewItem types to Microsoft UI Automation.

This documentation applies to WinUI 2 for UWP (for WinUI in the Windows App SDK, see the Windows App SDK namespaces).

TreeViewItemDataAutomationPeer

Exposes TreeViewItem data types to Microsoft UI Automation.

This documentation applies to WinUI 2 for UWP (for WinUI in the Windows App SDK, see the Windows App SDK namespaces).

TreeViewListAutomationPeer

Exposes TreeViewList types to Microsoft UI Automation.

This documentation applies to WinUI 2 for UWP (for WinUI in the Windows App SDK, see the Windows App SDK namespaces).

WebView2AutomationPeer

Exposes WebView2 types to Microsoft UI Automation.

This documentation applies to WinUI 2 for UWP (for WinUI in the Windows App SDK, see the Windows App SDK namespaces).

Examples

Tip

The WinUI 3 Gallery and WinUI 2 Gallery apps include interactive examples of most WinUI 3 and WinUI 2 controls, features, and functionality.

If installed already, open them by clicking the following links: WinUI 3 Gallery or WinUI 2 Gallery.

If they are not installed, you can download the WinUI 3 Gallery and the WinUI 2 Gallery from the Microsoft Store.

You can also get the source code for both from GitHub (use the main branch for WinUI 3 and the winui2 branch for WinUI 2).

Remarks

WinUI controls, and other UI elements, implement UI Automation support to report roles and values. You can use UI Automation tools to examine the role and value information, or you can review the AutomationPeer implementations of each control. The available roles in a UI Automation framework are defined in the AutomationControlType enumeration. UI Automation clients, such as assistive technologies, can obtain role information by calling methods that the UI Automation framework exposes through the control's AutomationPeer.

See also