TextBlockAutomationPeer Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 65536)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
/// [Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
class TextBlockAutomationPeer : FrameworkElementAutomationPeer[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 65536)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
public class TextBlockAutomationPeer : FrameworkElementAutomationPeerPublic Class TextBlockAutomationPeer
Inherits FrameworkElementAutomationPeer- Inheritance
-
Object IInspectable DependencyObject AutomationPeer FrameworkElementAutomationPeer TextBlockAutomationPeer
- Attributes
Windows requirements
| Device family |
Windows 10 (introduced in 10.0.10240.0)
|
| API contract |
Windows.Foundation.UniversalApiContract (introduced in v1.0)
|
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.
- GetPattern reports pattern support for TextPattern, but see "TextPattern support" in this topic for more info.
- GetClassName returns "TextBlock".
- GetAutomationControlType returns AutomationControlType.Text.
- GetName returns a plain-text representation of the TextBlock text content from TextBlock.Text.
- IsControlElement returns a value based on the template parent. If there is a template parent then it returns true, otherwise the value is false. The scenario here is that a templated control may have forwarded to this peer for text support, but normally a TextBlock by itself isn't a full-fledged control. 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
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) |
Initializes a new instance of the TextBlockAutomationPeer class. |
Properties
| Dispatcher |
Gets the CoreDispatcher that this object is associated with. The CoreDispatcher represents a facility that can access the DependencyObject on the UI thread even if the code is initiated by a non-UI thread. (Inherited from DependencyObject) |
| EventsSource |
Gets or sets an AutomationPeer that is reported to the automation client as the source for all the events that come from this AutomationPeer. See Remarks. (Inherited from AutomationPeer) |
| Owner |
Gets the UIElement owner that is associated with this FrameworkElementAutomationPeer. (Inherited from FrameworkElementAutomationPeer) |
Methods
| ClearValue(DependencyProperty) |
Clears the local value of a dependency property. (Inherited from DependencyObject) |
| GetAcceleratorKey() |
Gets the accelerator key combinations for the object that is associated with the UI Automation peer. (Inherited from AutomationPeer) |
| GetAcceleratorKeyCore() |
Provides the peer's behavior when a Microsoft UI Automation client calls GetAcceleratorKey or an equivalent Microsoft UI Automation client API. (Inherited from AutomationPeer) |
| GetAccessKey() |
Gets the access key for the element that is associated with the automation peer. (Inherited from AutomationPeer) |
| GetAccessKeyCore() |
Provides the peer's behavior when a Microsoft UI Automation client calls GetAccessKey or an equivalent Microsoft UI Automation client API. (Inherited from AutomationPeer) |
| GetAnimationBaseValue(DependencyProperty) |
Returns any base value established for a dependency property, which would apply in cases where an animation is not active. (Inherited from DependencyObject) |
| GetAnnotations() |
Gets a reference to the list of UI automation annotations for the current automation peer. (Inherited from AutomationPeer) |
| GetAnnotationsCore() |
Provides the behavior of the peer when a Microsoft UI Automation client calls GetAnnotations or an equivalent Microsoft UI Automation client API. (Inherited from AutomationPeer) |
| GetAutomationControlType() |
Gets the control type for the element that is associated with the UI Automation peer. (Inherited from AutomationPeer) |
| GetAutomationControlTypeCore() |
Provides the peer's behavior when a Microsoft UI Automation client calls GetAutomationControlType or an equivalent Microsoft UI Automation client API. (Inherited from AutomationPeer) |
| GetAutomationId() |
Gets the AutomationId of the element that is associated with the automation peer. (Inherited from AutomationPeer) |
| GetAutomationIdCore() |
Provides the peer's behavior when a Microsoft UI Automation client calls GetAutomationId or an equivalent Microsoft UI Automation client API. (Inherited from AutomationPeer) |
| GetBoundingRectangle() |
Gets the Rect object that represents the screen coordinates of the element that is associated with the automation peer. (Inherited from AutomationPeer) |
| GetBoundingRectangleCore() |
Provides the peer's behavior when a Microsoft UI Automation client calls GetBoundingRectangle or an equivalent Microsoft UI Automation client API. (Inherited from AutomationPeer) |
| GetChildren() |
Gets the collection of child elements that are represented in the UI Automation tree as immediate child elements of the automation peer. (Inherited from AutomationPeer) |
| GetChildrenCore() |
Provides the peer's behavior when a Microsoft UI Automation client calls GetChildren or an equivalent Microsoft UI Automation client API. (Inherited from AutomationPeer) |
| GetClassName() |
Gets a name that is used with AutomationControlType, to differentiate the control that is represented by this AutomationPeer. (Inherited from AutomationPeer) |
| GetClassNameCore() |
Provides the peer's behavior when a Microsoft UI Automation client calls GetClassName or an equivalent Microsoft UI Automation client API. (Inherited from AutomationPeer) |
| GetClickablePoint() |
Gets a point on the element that is associated with the automation peer that responds to a mouse click. (Inherited from AutomationPeer) |
| GetClickablePointCore() |
Provides the peer's behavior when a Microsoft UI Automation client calls GetClickablePoint or an equivalent Microsoft UI Automation client API. (Inherited from AutomationPeer) |
| GetControlledPeers() |
Provides the peer's behavior when a Microsoft UI Automation client calls GetControlledPeers or an equivalent Microsoft UI Automation client API such as getting a property value as identified by UIA_ControllerForPropertyId. (Inherited from AutomationPeer) |
| GetControlledPeersCore() |
Gets a list of the controlled peers for the current automation peer. (Inherited from AutomationPeer) |
| GetCulture() |
Calls GetCultureCore to get the culture value for the element that is associated with the automation peer. (Inherited from AutomationPeer) |
| GetCultureCore() |
Gets the culture value for the element that is associated with the automation peer. (Inherited from AutomationPeer) |
| GetDescribedByCore() |
Gets a collection of elements that provide more information about the automation element. (Inherited from AutomationPeer) |
| GetElementFromPoint(Point) |
Gets an element from the specified point. (Inherited from AutomationPeer) |
| GetElementFromPointCore(Point) |
Provides the behavior of the peer when a Microsoft UI Automation client calls GetElementFromPoint or an equivalent Microsoft UI Automation client API. (Inherited from AutomationPeer) |
| GetFlowsFromCore() |
Provides the peer's behavior when a Microsoft UI Automation client calls GetFlowsFrom or an equivalent Microsoft UI Automation client API. (Inherited from AutomationPeer) |
| GetFlowsToCore() |
Provides the peer's behavior when a Microsoft UI Automation client calls GetFlowsTo or an equivalent Microsoft UI Automation client API. (Inherited from AutomationPeer) |
| GetFocusedElement() |
Gets the element that currently has the focus. (Inherited from AutomationPeer) |
| GetFocusedElementCore() |
Provides the behavior of the peer when a Microsoft UI Automation client calls GetFocusedElement or an equivalent Microsoft UI Automation client API. (Inherited from AutomationPeer) |
| GetFullDescription() |
Gets a localized string that describes the actual visual appearance or contents of something such as an image or image control. (Inherited from AutomationPeer) |
| GetFullDescriptionCore() |
Provides the peer's behavior when a Microsoft UI Automation client calls GetFullDescription or an equivalent Microsoft UI Automation client API. (Inherited from AutomationPeer) |
| GetHeadingLevel() |
Gets the heading level of the UI Automation element that is associated with this automation peer. (Inherited from AutomationPeer) |
| GetHeadingLevelCore() |
Provides the peer's behavior when a Microsoft UI Automation client calls GetHeadingLevel or an equivalent Microsoft UI Automation client API. (Inherited from AutomationPeer) |
| GetHelpText() |
Gets text that describes the functionality of the control that is associated with the automation peer. (Inherited from AutomationPeer) |
| GetHelpTextCore() |
Provides the peer's behavior when a Microsoft UI Automation client calls GetHelpText or an equivalent Microsoft UI Automation client API. (Inherited from AutomationPeer) |
| GetItemStatus() |
Gets text that conveys the visual status of the element that is associated with this automation peer. (Inherited from AutomationPeer) |
| GetItemStatusCore() |
Provides the peer's behavior when a Microsoft UI Automation client calls GetItemStatus or an equivalent Microsoft UI Automation client API. (Inherited from AutomationPeer) |
| GetItemType() |
Gets a string that describes what kind of item an element represents. (Inherited from AutomationPeer) |
| GetItemTypeCore() |
Provides the peer's behavior when a Microsoft UI Automation client calls GetItemType or an equivalent Microsoft UI Automation client API. (Inherited from AutomationPeer) |
| GetLabeledBy() |
Gets the AutomationPeer for the UIElement that is targeted to the element. (Inherited from AutomationPeer) |
| GetLabeledByCore() |
Provides the peer's behavior when a Microsoft UI Automation client calls GetLabeledBy or an equivalent Microsoft UI Automation client API. (Inherited from AutomationPeer) |
| GetLandmarkType() |
Gets the landmark type for this automation peer. (Inherited from AutomationPeer) |
| GetLandmarkTypeCore() |
Provides the peer's behavior when a Microsoft UI Automation client calls GetLandmarkType or an equivalent Microsoft UI Automation client API. (Inherited from AutomationPeer) |
| GetLevel() |
Returns the 1-based integer for the level (hierarchy) of the element that is associated with the automation peer. (Inherited from AutomationPeer) |
| GetLevelCore() |
Provides the behavior of the peer when a Microsoft UI Automation client calls GetLevel or an equivalent Microsoft UI Automation client API. (Inherited from AutomationPeer) |
| GetLiveSetting() |
Gets the live setting notification behavior information for the object that is associated with the UI Automation peer. (Inherited from AutomationPeer) |
| GetLiveSettingCore() |
Provides the peer's behavior when a Microsoft UI Automation client calls GetLiveSetting or an equivalent Microsoft UI Automation client API. (Inherited from AutomationPeer) |
| GetLocalizedControlType() |
Gets a localized string that represents the AutomationControlType value for the control that is associated with this automation peer. (Inherited from AutomationPeer) |
| GetLocalizedControlTypeCore() |
Provides the peer's behavior when a Microsoft UI Automation client calls GetLocalizedControlType or an equivalent Microsoft UI Automation client API. (Inherited from AutomationPeer) |
| GetLocalizedLandmarkType() |
Gets a localized string that represents the AutomationLandmarkType value for the element that is associated with this automation peer. (Inherited from AutomationPeer) |
| GetLocalizedLandmarkTypeCore() |
Provides the peer's behavior when a Microsoft UI Automation client calls GetLocalizedLandmarkType or an equivalent Microsoft UI Automation client API. (Inherited from AutomationPeer) |
| GetName() |
Gets text that describes the element that is associated with this automation peer. The Microsoft UI Automation Name value is the primary identifier used by most assistive technology when they represent your app's UI by interacting with the Microsoft UI Automation framework. (Inherited from AutomationPeer) |
| GetNameCore() |
Provides the peer's behavior when a Microsoft UI Automation client calls GetName or an equivalent Microsoft UI Automation client API. (Inherited from AutomationPeer) |
| GetOrientation() |
Gets a value that indicates the explicit control orientation, if any. (Inherited from AutomationPeer) |
| GetOrientationCore() |
Provides the peer's behavior when a Microsoft UI Automation client calls GetOrientation or an equivalent Microsoft UI Automation client API. (Inherited from AutomationPeer) |
| GetParent() |
Gets the AutomationPeer that is the parent of this AutomationPeer. (Inherited from AutomationPeer) |
| GetPattern(PatternInterface) |
Gets the control pattern that is associated with the specified PatternInterface. (Inherited from AutomationPeer) |
| GetPatternCore(PatternInterface) |
Provides the peer's behavior when a Microsoft UI Automation client calls GetPattern or an equivalent Microsoft UI Automation client API. (Inherited from AutomationPeer) |
| GetPeerFromPoint(Point) |
Gets an AutomationPeer from the specified point. (Inherited from AutomationPeer) |
| GetPeerFromPointCore(Point) |
Provides the peer's behavior when a Microsoft UI Automation client calls GetPeerFromPoint or an equivalent Microsoft UI Automation client API. (Inherited from AutomationPeer) |
| GetPositionInSet() |
Returns the 1-based integer for the ordinal position in the set for the element that is associated with the automation peer. (Inherited from AutomationPeer) |
| GetPositionInSetCore() |
Provides the peer’s behavior when a Microsoft UI Automation client calls GetPositionInSet or an equivalent Microsoft UI Automation client API. (Inherited from AutomationPeer) |
| GetSizeOfSet() |
Returns the 1-based integer for the size of the set where the element that is associated with the automation peer is located. (Inherited from AutomationPeer) |
| GetSizeOfSetCore() |
Provides the peer’s behavior when a Microsoft UI Automation client calls GetSizeOfSet or an equivalent Microsoft UI Automation client API. (Inherited from AutomationPeer) |
| GetValue(DependencyProperty) |
Returns the current effective value of a dependency property from a DependencyObject. (Inherited from DependencyObject) |
| HasKeyboardFocus() |
Gets a value that indicates whether the element that is associated with this automation peer currently has keyboard focus. (Inherited from AutomationPeer) |
| HasKeyboardFocusCore() |
Provides the peer's behavior when a Microsoft UI Automation client calls HasKeyboardFocus or an equivalent Microsoft UI Automation client API. (Inherited from AutomationPeer) |
| InvalidatePeer() |
Triggers recalculation of the main properties of the AutomationPeer and raises the PropertyChanged notification to the automation client if the properties have changed. (Inherited from AutomationPeer) |
| IsContentElement() |
Gets a value that indicates whether the element that is associated with this automation peer contains data that is presented to the user. (Inherited from AutomationPeer) |
| IsContentElementCore() |
Provides the peer's behavior when a Microsoft UI Automation client calls IsContentElement or an equivalent Microsoft UI Automation client API. (Inherited from AutomationPeer) |
| IsControlElement() |
Gets a value that indicates whether the element is understood by the user as interactive or as contributing to the logical structure of the control in the GUI. (Inherited from AutomationPeer) |
| IsControlElementCore() |
Provides the peer's behavior when a Microsoft UI Automation client calls IsControlElement or an equivalent Microsoft UI Automation client API. (Inherited from AutomationPeer) |
| IsDataValidForForm() |
Gets a Boolean value that indicates whether the entered or selected value is valid for the form rule associated with the automation element. (Inherited from AutomationPeer) |
| IsDataValidForFormCore() |
Provides the peer’s behavior when a Microsoft UI Automation client accesses IsDataValidForForm or an equivalent Microsoft UI Automation client API. (Inherited from AutomationPeer) |
| IsDialog() |
Gets a value that indicates whether the element associated with this automation peer is a dialog window. (Inherited from AutomationPeer) |
| IsDialogCore() |
Provides the peer's behavior when a Microsoft UI Automation client calls IsDialog or an equivalent Microsoft UI Automation client API. (Inherited from AutomationPeer) |
| IsEnabled() |
Gets a value that indicates whether the element associated with this automation peer supports interaction. (Inherited from AutomationPeer) |
| IsEnabledCore() |
Provides the peer's behavior when a Microsoft UI Automation client calls IsEnabled or an equivalent Microsoft UI Automation client API. (Inherited from AutomationPeer) |
| IsKeyboardFocusable() |
Gets a value that indicates whether the element can accept keyboard focus. (Inherited from AutomationPeer) |
| IsKeyboardFocusableCore() |
Provides the peer's behavior when a Microsoft UI Automation client calls IsKeyboardFocusable or an equivalent Microsoft UI Automation client API. (Inherited from AutomationPeer) |
| IsOffscreen() |
Gets a value that indicates whether an element is off the screen. (Inherited from AutomationPeer) |
| IsOffscreenCore() |
Provides the peer's behavior when a Microsoft UI Automation client calls IsOffscreen or an equivalent Microsoft UI Automation client API. (Inherited from AutomationPeer) |
| IsPassword() |
Gets a value that indicates whether the element contains sensitive content. (Inherited from AutomationPeer) |
| IsPasswordCore() |
Provides the peer's behavior when a Microsoft UI Automation client calls IsPassword or an equivalent Microsoft UI Automation client API. (Inherited from AutomationPeer) |
| IsPeripheral() |
Gets a Boolean value that indicates whether the automation element represents peripheral UI. (Inherited from AutomationPeer) |
| IsPeripheralCore() |
Provides the peer’s behavior when a Microsoft UI Automation client accesses IsPeripheral or an equivalent Microsoft UI Automation client API. (Inherited from AutomationPeer) |
| IsRequiredForForm() |
Gets a value that indicates whether the element that is associated with this peer must be completed on a form. (Inherited from AutomationPeer) |
| IsRequiredForFormCore() |
Provides the peer's behavior when a Microsoft UI Automation client calls IsRequiredForForm or an equivalent Microsoft UI Automation client API. (Inherited from AutomationPeer) |
| Navigate(AutomationNavigationDirection) |
Gets the element in the specified direction within the UI automation tree. (Inherited from AutomationPeer) |
| NavigateCore(AutomationNavigationDirection) |
Provides the peer’s behavior when a Microsoft UI Automation client calls Navigate or an equivalent Microsoft UI Automation client API. (Inherited from AutomationPeer) |
| PeerFromProvider(IRawElementProviderSimple) |
Gets an AutomationPeer for the specified IRawElementProviderSimple proxy. (Inherited from AutomationPeer) |
| ProviderFromPeer(AutomationPeer) |
Gets the IRawElementProviderSimple proxy for the specified AutomationPeer. (Inherited from AutomationPeer) |
| RaiseAutomationEvent(AutomationEvents) |
Raises an automation event. (Inherited from AutomationPeer) |
| RaiseNotificationEvent(AutomationNotificationKind, AutomationNotificationProcessing, String, String) |
Initiates a notification event. (Inherited from AutomationPeer) |
| RaisePropertyChangedEvent(AutomationProperty, Object, Object) |
Raises an event to notify the automation client of a changed property value. (Inherited from AutomationPeer) |
| RaiseStructureChangedEvent(AutomationStructureChangeType, AutomationPeer) |
Raises an event to notify the Microsoft UI Automation core that the tree structure has changed. (Inherited from AutomationPeer) |
| RaiseTextEditTextChangedEvent(AutomationTextEditChangeType, IVectorView<String>) |
Raises an event to notify the Microsoft UI Automation core that a text control has programmatically changed text. (Inherited from AutomationPeer) |
| ReadLocalValue(DependencyProperty) |
Returns the local value of a dependency property, if a local value is set. (Inherited from DependencyObject) |
| RegisterPropertyChangedCallback(DependencyProperty, DependencyPropertyChangedCallback) |
Registers a notification function for listening to changes to a specific DependencyProperty on this DependencyObject instance. (Inherited from DependencyObject) |
| SetFocus() |
Sets the keyboard focus on the element that is associated with this automation peer. (Inherited from AutomationPeer) |
| SetFocusCore() |
Provides the peer's behavior when a Microsoft UI Automation client calls SetFocus or an equivalent Microsoft UI Automation client API. (Inherited from AutomationPeer) |
| SetParent(AutomationPeer) |
Sets the AutomationPeer that is the parent of this AutomationPeer. (Inherited from AutomationPeer) |
| SetValue(DependencyProperty, Object) |
Sets the local value of a dependency property on a DependencyObject. (Inherited from DependencyObject) |
| ShowContextMenu() |
Shows the available context menu for the owner element. (Inherited from AutomationPeer) |
| ShowContextMenuCore() |
Provides the peer's behavior when a Microsoft UI Automation client calls ShowContextMenu or an equivalent Microsoft UI Automation client API. (Inherited from AutomationPeer) |
| UnregisterPropertyChangedCallback(DependencyProperty, Int64) |
Cancels a change notification that was previously registered by calling RegisterPropertyChangedCallback. (Inherited from DependencyObject) |