| -api-id | -api-type |
|---|---|
T:Windows.UI.Xaml.Automation.Peers.TextBoxAutomationPeer |
winrt class |
Exposes TextBox types to Microsoft UI Automation.
The Windows Runtime TextBox class creates a new TextBoxAutomationPeer as its OnCreateAutomationPeer definition. Derive your automation peer from TextBoxAutomationPeer if you are deriving a custom class from TextBox and want to add automation support for additional features that you enabled in your custom class. Then override OnCreateAutomationPeer so that it returns your custom peer.
TextBoxAutomationPeer has overrides of Core methods such that the associated AutomationPeer methods provide peer-specific information to a Microsoft UI Automation client.
- GetPattern reports pattern support for TextPattern and ValuePattern, but see "TextPattern support" in this topic for more info.
- GetClassName returns "RichEditBox".
- GetAutomationControlType returns AutomationControlType.Edit.
- IsControlElement returns true.
The peer also has other behaviors that are provided by the base FrameworkElementAutomationPeer class. For more info, see "Base implementation in FrameworkElementAutomationPeer" section of Custom automation peers.
TextBoxAutomationPeer supports the TextPattern and ValuePattern Microsoft UI Automation patterns. The support for these pattern is implemented as native code by the peer, so you won't see public API for the TextBoxAutomationPeer peer class that exposes the pattern implementation for extension. And you won't see ITextRangeProvider and the similar managed interfaces in the TextBoxAutomationPeer inheritance. But Microsoft UI Automation clients can use the TextPattern and ValuePattern patterns implemented by this peer and call the native API surface through Microsoft UI Automation.
TextBox, FrameworkElementAutomationPeer, Custom automation peers