Rich​Text​Block​Overflow​Automation​Peer Rich​Text​Block​Overflow​Automation​Peer Rich​Text​Block​Overflow​Automation​Peer Class

Definition

Exposes RichTextBlockOverflow types to Microsoft UI Automation.

public : class RichTextBlockOverflowAutomationPeer : FrameworkElementAutomationPeer, IRichTextBlockOverflowAutomationPeerpublic class RichTextBlockOverflowAutomationPeer : FrameworkElementAutomationPeer, IRichTextBlockOverflowAutomationPeerPublic Class RichTextBlockOverflowAutomationPeer Inherits FrameworkElementAutomationPeer Implements IRichTextBlockOverflowAutomationPeer
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

Remarks

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

Default peer implementation and overrides in RichTextBlockOverflowAutomationPeer

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

TextPattern support

RichTextBlockOverflowAutomationPeer 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 RichTextBlockOverflowAutomationPeer peer class that exposes the pattern implementation for extension. And you won't see ITextRangeProvider and the similar managed interfaces in the RichTextBlockOverflowAutomationPeer 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 RichTextBlockOverflowAutomationPeer:

  • 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 RichTextBlockOverflow doesn't have its own scrolling behavior. If the RichTextBlockOverflow 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

RichTextBlockOverflowAutomationPeer(RichTextBlockOverflow) RichTextBlockOverflowAutomationPeer(RichTextBlockOverflow) RichTextBlockOverflowAutomationPeer(RichTextBlockOverflow)

Initializes a new instance of the RichTextBlockOverflowAutomationPeer class.

public : RichTextBlockOverflowAutomationPeer(RichTextBlockOverflow owner)public RichTextBlockOverflowAutomationPeer(RichTextBlockOverflow owner)Public Sub New(owner As RichTextBlockOverflow)
Parameters
Attributes

See Also