DocumentAutomationPeer Class

  • Reference

Definition

Namespace:
System.Windows.Automation.Peers
Assembly:
PresentationFramework.dll

Exposes Document control types to UI Automation.

public ref class DocumentAutomationPeer : System::Windows::Automation::Peers::ContentTextAutomationPeer
public class DocumentAutomationPeer : System.Windows.Automation.Peers.ContentTextAutomationPeer
type DocumentAutomationPeer = class
    inherit ContentTextAutomationPeer
Public Class DocumentAutomationPeer
Inherits ContentTextAutomationPeer
Inheritance
Object
DispatcherObject
AutomationPeer
ContentElementAutomationPeer
FrameworkContentElementAutomationPeer
ContentTextAutomationPeer
DocumentAutomationPeer

Remarks

The DocumentAutomationPeer represents documents and supports the TextPattern. Objects such as a FixedDocument or FlowDocument can contain embedded objects, such as images and hyperlinks. Initially, when you try to get the child elements of the document, DocumentAutomationPeer.GetChildrenCore does not return the embedded objects. To get the embedded elements, obtain a TextPatternRange from the TextPattern and call TextPatternRange.GetChildren. After TextPatternRange.GetChildren is called, any elements in that TextPatternRange are returned by DocumentAutomationPeer.GetChildrenCore.

Note

Unless you know the document is a FlowDocument, you should not call GetChildren on the TextPattern.DocumentRange property. If the document is loaded from a network location, calling GetChildren on the entire document is resource intensive. Instead, you should use one of the methods on TextPattern that returns a TextPatternRange that represents a portion of the document.

Constructors

DocumentAutomationPeer(FrameworkContentElement)

Initializes a new instance of the DocumentAutomationPeer class.

Properties

Dispatcher

Gets the Dispatcher this DispatcherObject is associated with.

(Inherited from DispatcherObject)
EventsSource

Gets or sets an AutomationPeer that is reported to the automation client as a source for all the events that come from this AutomationPeer.

(Inherited from AutomationPeer)
IsHwndHost

Gets a value that indicates whether the element that is associated with this AutomationPeer hosts hwnds in Windows Presentation Foundation (WPF).

(Inherited from AutomationPeer)
Owner

Gets the ContentElement that is associated with this ContentElementAutomationPeer.

(Inherited from ContentElementAutomationPeer)

Methods

CheckAccess()

Determines whether the calling thread has access to this DispatcherObject.

(Inherited from DispatcherObject)
Equals(Object)

Determines whether the specified object is equal to the current object.

(Inherited from Object)
GetAcceleratorKey()

Gets the accelerator key combinations for the element that is associated with the UI Automation peer.

(Inherited from AutomationPeer)
GetAcceleratorKeyCore()

Gets the accelerator key for the element associated with this ContentElementAutomationPeer. Called by GetAcceleratorKey().

(Inherited from ContentElementAutomationPeer)
GetAccessKey()

Gets the access key for the element that is associated with the automation peer.

(Inherited from AutomationPeer)
GetAccessKeyCore()

Gets the access key for the ContentElement that is associated with this ContentElementAutomationPeer. Called by GetAccessKey().

(Inherited from ContentElementAutomationPeer)
GetAutomationControlType()

Gets the control type for the element that is associated with the UI Automation peer.

(Inherited from AutomationPeer)
GetAutomationControlTypeCore()

Gets the control type for the control that is associated with this DocumentAutomationPeer. This method is called by GetAutomationControlType().
GetAutomationId()

Gets the AutomationId of the element that is associated with the automation peer.

(Inherited from AutomationPeer)
GetAutomationIdCore()

Gets the string that uniquely identifies the FrameworkContentElement that is associated with this ContentElementAutomationPeer. This method is called by GetAutomationId().

(Inherited from FrameworkContentElementAutomationPeer)
GetBoundingRectangle()

Gets the Rect object that represents the screen coordinates of the element that is associated with the automation peer.

(Inherited from AutomationPeer)
GetBoundingRectangleCore()

Gets the Rect that represents the screen coordinates of the element that is associated with this DocumentAutomationPeer. This method is called by GetBoundingRectangle().
GetChildren()

Gets the collection of GetChildren() elements that are represented in the UI Automation tree as immediate child elements of the automation peer.

(Inherited from AutomationPeer)
GetChildrenCore()

Gets the collection of child elements for the FrameworkContentElement that is associated with this DocumentAutomationPeer. This method is called by GetChildren().
GetClassName()

Gets a name that is used with AutomationControlType, to differentiate the control that is represented by this AutomationPeer.

(Inherited from AutomationPeer)
GetClassNameCore()

Gets the name of the FrameworkContentElement that is associated with this DocumentAutomationPeer. This method is called by GetClassName().
GetClickablePoint()

Gets a Point on the element that is associated with the automation peer that responds to a mouse click.

(Inherited from AutomationPeer)
GetClickablePointCore()

Gets a Point that represents the clickable space that is on the FrameworkContentElement that is associated with this ContentElementAutomationPeer. This method is called by GetClickablePoint().
GetControlledPeers()

Provides UI Automation with a list of elements affected or controlled by this AutomationPeer.

(Inherited from AutomationPeer)
GetControlledPeersCore()

When overridden in a derived class, provides UI Automation with a list of elements affected or controlled by this AutomationPeer.

(Inherited from AutomationPeer)
GetHashCode()

Serves as the default hash function.

(Inherited from Object)
GetHeadingLevel() (Inherited from AutomationPeer)
GetHeadingLevelCore() (Inherited from ContentElementAutomationPeer)
GetHelpText()

Gets text that describes the functionality of the control that is associated with the automation peer.

(Inherited from AutomationPeer)
GetHelpTextCore()

Gets the string that describes the functionality of the FrameworkContentElement that is associated with this ContentElementAutomationPeer. This method is called by GetHelpText().

(Inherited from FrameworkContentElementAutomationPeer)
GetHostRawElementProviderCore()

Tells UI Automation where in the UI Automation tree to place the hwnd being hosted by a Windows Presentation Foundation (WPF) element.

(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()

Gets a string that conveys the visual status of the ContentElement that is associated with this ContentElementAutomationPeer. Called by GetItemStatus().

(Inherited from ContentElementAutomationPeer)
GetItemType()

Gets a string that describes what kind of item an object represents.

(Inherited from AutomationPeer)
GetItemTypeCore()

Gets a human-readable string that contains the type of the item that the ContentElement that is associated with this ContentElementAutomationPeer represents. Called by GetItemType().

(Inherited from ContentElementAutomationPeer)
GetLabeledBy()

Gets the AutomationPeer for the Label that is targeted to the element.

(Inherited from AutomationPeer)
GetLabeledByCore()

Gets the LabelAutomationPeer for the Label that is targeted to the FrameworkContentElement that is associated with this FrameworkContentElementAutomationPeer. This method is called by GetLabeledBy().

(Inherited from FrameworkContentElementAutomationPeer)
GetLiveSetting()

Gets the notification characteristics of a live region that is associated with this automation peer.

(Inherited from AutomationPeer)
GetLiveSettingCore()

Gets the notification characteristics of the live region of the ContentElement that is associated with this ContentElementAutomationPeer. Called by GetLiveSetting().

(Inherited from ContentElementAutomationPeer)
GetLocalizedControlType()

Gets a human-readable localized string that represents the AutomationControlType value for the control that is associated with this automation peer.

(Inherited from AutomationPeer)
GetLocalizedControlTypeCore()

When overridden in a derived class, is called by GetLocalizedControlType().

(Inherited from AutomationPeer)
GetName()

Gets text that describes the element that is associated with this automation peer.

(Inherited from AutomationPeer)
GetNameCore()

Gets the text label of the ContentElement that is associated with this ContentElementAutomationPeer. Called by GetName().

(Inherited from ContentElementAutomationPeer)
GetOrientation()

Gets a value that indicates the explicit control orientation, if any.

(Inherited from AutomationPeer)
GetOrientationCore()

Gets a value that indicates whether the ContentElement that is associated with this ContentElementAutomationPeer is laid out in a specific direction. Called by GetOrientation().

(Inherited from ContentElementAutomationPeer)
GetParent()

Gets the AutomationPeer that is the parent of this AutomationPeer.

(Inherited from AutomationPeer)
GetPattern(PatternInterface)

Gets the control pattern for the FrameworkContentElement that is associated with this DocumentAutomationPeer.
GetPeerFromPoint(Point)

Gets an AutomationPeer from the specified point.

(Inherited from AutomationPeer)
GetPeerFromPointCore(Point)

When overridden in a derived class, is called from GetPeerFromPoint(Point).

(Inherited from AutomationPeer)
GetPositionInSet()

Attempts to get the value of the PositionInSet property.

(Inherited from AutomationPeer)
GetPositionInSetCore()

Reads PositionInSetProperty and returns the value of the PositionInSet attached property.

(Inherited from ContentElementAutomationPeer)
GetSizeOfSet()

Attempts to get the value of the SizeOfSet property.

(Inherited from AutomationPeer)
GetSizeOfSetCore()

Reads SizeOfSetProperty and returns the value of the SizeOfSet attached property.

(Inherited from ContentElementAutomationPeer)
GetType()

Gets the Type of the current instance.

(Inherited from Object)
HasKeyboardFocus()

Gets a value that indicates whether the element that is associated with this automation peer currently has keyboard focus.

(Inherited from AutomationPeer)
HasKeyboardFocusCore()

Gets a value that indicates whether the ContentElement that is associated with this ContentElementAutomationPeer currently has keyboard input focus. Called by HasKeyboardFocus().

(Inherited from ContentElementAutomationPeer)
InvalidatePeer()

Triggers recalculation of the main properties of the AutomationPeer and raises the PropertyChanged notification to the Automation Client if the properties 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()

Gets a value that indicates whether the ContentElement that is associated with this ContentElementAutomationPeer is an element that contains data that is presented to the user. Called by IsContentElement().

(Inherited from ContentElementAutomationPeer)
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()

Gets or sets a value that indicates whether the FrameworkContentElement that is associated with this DocumentAutomationPeer is understood by the end user as interactive or the user might understand the FrameworkContentElement as contributing to the logical structure of the control in the GUI. This method is called by IsControlElement().
IsDialog() (Inherited from AutomationPeer)
IsDialogCore() (Inherited from ContentElementAutomationPeer)
IsEnabled()

Gets a value that indicates whether the element associated with this automation peer supports interaction.

(Inherited from AutomationPeer)
IsEnabledCore()

Gets a value that indicates whether this automation peer can receive and send events to the associated element. Called by IsEnabled().

(Inherited from ContentElementAutomationPeer)
IsKeyboardFocusable()

Gets a value that indicates whether the element can accept keyboard focus.

(Inherited from AutomationPeer)
IsKeyboardFocusableCore()

Gets a value that indicates whether the ContentElement that is associated with this ContentElementAutomationPeer can accept keyboard focus. Called by IsKeyboardFocusable().

(Inherited from ContentElementAutomationPeer)
IsOffscreen()

Gets a value that indicates whether an element is off the screen.

(Inherited from AutomationPeer)
IsOffscreenCore()

Gets a value that indicates whether the FrameworkContentElement that is associated with this DocumentAutomationPeer is off the screen. This method is called by IsOffscreen().
IsPassword()

Gets a value that indicates whether the element contains sensitive content.

(Inherited from AutomationPeer)
IsPasswordCore()

Gets a value that indicates whether the ContentElement that is associated with this ContentElementAutomationPeer contains protected content. Called by IsPassword().

(Inherited from ContentElementAutomationPeer)
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()

Gets a value that indicates whether the ContentElement that is associated with this ContentElementAutomationPeer is required to be filled out on a form. Called by IsRequiredForForm().

(Inherited from ContentElementAutomationPeer)
MemberwiseClone()

Creates a shallow copy of the current Object.

(Inherited from Object)
PeerFromProvider(IRawElementProviderSimple)

Gets an AutomationPeer for the specified IRawElementProviderSimple proxy.

(Inherited from AutomationPeer)
ProviderFromPeer(AutomationPeer)

Gets the IRawElementProviderSimple for the specified AutomationPeer.

(Inherited from AutomationPeer)
RaiseActiveTextPositionChangedEvent(TextPointer, TextPointer) (Inherited from ContentTextAutomationPeer)
RaiseAsyncContentLoadedEvent(AsyncContentLoadedEventArgs)

Called by the AutomationPeer to raise the AsyncContentLoadedEvent event.

(Inherited from AutomationPeer)
RaiseAutomationEvent(AutomationEvents)

Raises an automation event.

(Inherited from AutomationPeer)
RaiseNotificationEvent(AutomationNotificationKind, AutomationNotificationProcessing, String, String) (Inherited from AutomationPeer)
RaisePropertyChangedEvent(AutomationProperty, Object, Object)

Raises an event to notify the automation client of a changed property value.

(Inherited from AutomationPeer)
ResetChildrenCache()

Synchronously resets the tree of child elements by calling GetChildrenCore().

(Inherited from AutomationPeer)
SetFocus()

Sets the keyboard focus on the element that is associated with this automation peer.

(Inherited from AutomationPeer)
SetFocusCore()

Sets the keyboard input focus on the ContentElement that is associated with this ContentElementAutomationPeer. Called by SetFocus().

(Inherited from ContentElementAutomationPeer)
ToString()

Returns a string that represents the current object.

(Inherited from Object)
VerifyAccess()

Enforces that the calling thread has access to this DispatcherObject.

(Inherited from DispatcherObject)

Applies to

See also