RichEditBoxAutomationPeer class
TOC
Collapse the table of content
Expand the table of content

RichEditBoxAutomationPeer class

Exposes RichEditBox types to Microsoft UI Automation.

Inheritance

Object
  DependencyObject
    AutomationPeer
      FrameworkElementAutomationPeer
        RichEditBoxAutomationPeer

Syntax


public class RichEditBoxAutomationPeer : FrameworkElementAutomationPeer

Members

The RichEditBoxAutomationPeer class has these types of members:

Constructors

The RichEditBoxAutomationPeer class has these constructors.

ConstructorDescription
RichEditBoxAutomationPeer Initializes a new instance of the RichEditBoxAutomationPeer class.

 

Remarks

The Windows Runtime RichEditBox class creates a new RichEditBoxAutomationPeer as its OnCreateAutomationPeer definition. Derive your automation peer from RichEditBoxAutomationPeer if you are deriving a custom class from RichEditBox 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.

Default peer implementation and overrides in RichEditBoxAutomationPeer

RichEditBoxAutomationPeer has overrides of Core methods such that the associated AutomationPeer methods provide peer-specific information to a UI Automation client.

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.

TextPattern support

RichEditBoxAutomationPeer supports the TextPattern UI Automation pattern. The support for this pattern is implemented as native code by the peer, so you won't see public API for the RichEditBoxAutomationPeer peer class that exposes the pattern implementation for extension. And you won't see ITextRangeProvider and the similar managed interfaces in the RichEditBoxAutomationPeer inheritance. But UI Automation clients can use the TextPattern pattern implemented by this peer and call its native API surface.

Requirements (Windows 10 device family)

Device family

Universal, introduced version 10.0.10240.0

API contract

Windows.Foundation.UniversalApiContract, introduced version 1.0

Namespace

Windows.UI.Xaml.Automation.Peers
Windows::UI::Xaml::Automation::Peers [C++]

Metadata

Windows.Foundation.UniversalApiContract.winmd

Requirements (Windows 8.x and Windows Phone 8.x)

Minimum supported client

Windows 8 [Windows Store apps only]

Minimum supported server

Windows Server 2012 [Windows Store apps only]

Minimum supported phone

Windows Phone 8.1 [Windows Runtime apps only]

Namespace

Windows.UI.Xaml.Automation.Peers
Windows::UI::Xaml::Automation::Peers [C++]

Metadata

Windows.winmd

Attributes

[MarshalingBehavior(Agile)]
[Threading(Both)]
[Version(0x06020000)]
[WebHostHidden()]

See also

Object
RichEditBox
FrameworkElementAutomationPeer
Custom automation peers

 

 

Show:
© 2016 Microsoft