TextBlockAutomationPeer TextBlockAutomationPeer TextBlockAutomationPeer Class

Definition

Exposes TextBlock types to Microsoft UI Automation.

public class TextBlockAutomationPeer : FrameworkElementAutomationPeer, ITextBlockAutomationPeerpublic class TextBlockAutomationPeer : FrameworkElementAutomationPeer, ITextBlockAutomationPeerPublic Class TextBlockAutomationPeer Inherits FrameworkElementAutomationPeer Implements ITextBlockAutomationPeer
Inheritance
Attributes
Windows 10 requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

Inherited Members

Inherited methods

Inherited properties

Windows.UI.Xaml.Automation.Peers.AutomationPeer.RaiseTextEditTextChangedEvent(Windows.UI.Xaml.Automation.AutomationTextEditChangeType,Windows.Foundation.Collections.IVectorView<System.String>)Windows.UI.Xaml.Automation.Peers.AutomationPeer.RaiseTextEditTextChangedEvent(Windows.UI.Xaml.Automation.AutomationTextEditChangeType,Windows.Foundation.Collections.IVectorView<System.String>)Windows.UI.Xaml.Automation.Peers.AutomationPeer.RaiseTextEditTextChangedEvent(Windows.UI.Xaml.Automation.AutomationTextEditChangeType,Windows.Foundation.Collections.IVectorView<System.String>)

Remarks

The Windows Runtime TextBlock class creates a new TextBlockAutomationPeer as its OnCreateAutomationPeer definition. TextBlock is sealed, so the normal scenario of deriving from the TextBlock class and its existing peer isn't applicable to TextBlockAutomationPeer.

Default peer implementation and overrides in TextBlockAutomationPeer

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

TextPattern support

TextBlockAutomationPeer supports the TextPattern Microsoft 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 TextBlockAutomationPeer peer class that exposes the pattern implementation for extension. And you won't see ITextRangeProvider and the similar managed interfaces in the TextBlockAutomationPeer inheritance. But Microsoft UI Automation clients can use the TextPattern pattern implemented by this peer and call its native API surface.

Here are some specifics of the TextPattern implementation in TextBlockAutomationPeer:

  • Move, MoveEndpointByUnit and ExpandToEnclosingUnit are supported for all TextUnit units including the Format value.
  • GetAttributeValue returns results within ranges for these text attributes: UIA_FontNameAttributeId, UIA_FontSizeAttributeId, UIA_FontWeightAttributeId, UIA_ForegroundColorAttributeId, UIA_CultureAttributeId, UIA_IsHiddenAttributeId, UIA_IsItalicAttributeId, UIA_IsReadOnlyAttributeId, UIA_CapStyleAttributeId, UIA_HorizontalTextAlignmentAttributeId, UIA_IndentationFirstLineAttributeId, UIA_IndentationLeadingAttributeId, UIA_IsSuperscriptAttributeId, UIA_IsSubscriptAttributeId, UIA_MarginBottomAttributeId, UIA_MarginLeadingAttributeId, UIA_MarginTopAttributeId, UIA_MarginTrailingAttributeId.
  • For the Move, MoveEndpointByUnit and ExpandToEnclosingUnit API when using the Format value, a format change is defined as a change within a range in any of the supported text attributes listed above.
  • ScrollIntoView is exposed in the pattern, but can only result in a behavior if the owner control is contained within a ScrollViewer. Otherwise a TextBlock doesn't have its own scrolling behavior. If the TextBlock does have a ScrollViewer parent, then the ScrollIntoView call fires a system event that requests the parent ScrollViewer to scroll. The alignToTop value is ignored.

Constructors

TextBlockAutomationPeer(TextBlock) TextBlockAutomationPeer(TextBlock) TextBlockAutomationPeer(TextBlock)

Initializes a new instance of the TextBlockAutomationPeer class.

public TextBlockAutomationPeer(TextBlock owner)public TextBlockAutomationPeer(TextBlock owner)Public Sub New(owner As TextBlock)
Parameters
owner
TextBlock TextBlock TextBlock

The TextBlock to create a peer for.

Attributes