Skip to content

Latest commit

 

History

History
26 lines (18 loc) · 2.09 KB

automationpeer_getautomationcontroltypecore_1718556232.md

File metadata and controls

26 lines (18 loc) · 2.09 KB
-api-id -api-type
M:Microsoft.UI.Xaml.Automation.Peers.AutomationPeer.GetAutomationControlTypeCore
winrt method

Microsoft.UI.Xaml.Automation.Peers.AutomationPeer.GetAutomationControlTypeCore

-description

Provides the peer's behavior when a Microsoft UI Automation client calls GetAutomationControlType or an equivalent Microsoft UI Automation client API.

-returns

The control type.

-remarks

The base implementation for AutomationPeer and FrameworkElementAutomationPeer return Custom. If you keep this behavior, you must override GetLocalizedControlTypeCore.

The more common scenario for defining an automation peer is overriding one of the existing peer classes that pairs with the control class you are overriding. In this case each such peer class reports a practical value of AutomationControlType that makes sense for the original owner control that the peer was implemented for. Often you can leave this behavior alone. It isn't typical to derive from a control-specific peer and use its behavior but then change the AutomationControlType, which is probably the most basic information that a peer reports. Check the existing behavior of the peer class you are overriding, and verify that you're reporting the correct control type. Also, double-check that there isn't a more specific peer class available that could already be reporting the correct control type as well as providing other behavior that's more appropriate for your peer. For more info, see Custom automation peers.

-examples

-see-also

FrameworkElementAutomationPeer, Custom automation peers, Accessibility