ItemAutomationPeer Class

Definition

Exposes a data item in an Items collection to UI Automation.

public ref class ItemAutomationPeer abstract : System::Windows::Automation::Peers::AutomationPeer, System::Windows::Automation::Provider::IVirtualizedItemProvider
public abstract class ItemAutomationPeer : System.Windows.Automation.Peers.AutomationPeer, System.Windows.Automation.Provider.IVirtualizedItemProvider
type ItemAutomationPeer = class
    inherit AutomationPeer
    interface IVirtualizedItemProvider
Public MustInherit Class ItemAutomationPeer
Inherits AutomationPeer
Implements IVirtualizedItemProvider
Inheritance
Derived
Implements

Remarks

Data items that are not also UIElement types do not have children; however, they can have a UIElement tree and a corresponding UI Automation tree.

For example, a ListBox can have a collection of strings that contain data items. When those items are processed by an ItemsControl for visualization, a UIElement tree is created for them. This tree can have a corresponding UI Automation tree. After the tree is created, WPF merges the UIElement tree into a UI Automation tree. ItemAutomationPeer works with its UIElement counterpart, if it exists, to obtain more information about the UIElement tree.

Only visible data items, or more precisely, the corresponding UIElement trees, have this dualism. Non-visible data items, which have no corresponding UIElement trees, have only one ItemAutomationPeer.

Constructors

ItemAutomationPeer(Object, ItemsControlAutomationPeer)

Provides initialization for base class values when called by the constructor of a derived 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)
Item

Gets the data item in the Items collection that is associated with this ItemAutomationPeer.

ItemsControlAutomationPeer

Gets the ItemsControlAutomationPeer that is associated with the ItemsControl that holds the Items collection.

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 UIElement that corresponds to the data item in the Items collection that is associated with this ItemAutomationPeer.

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 UIElement that corresponds to the data item in the Items collection that is associated with this ItemAutomationPeer.

GetAutomationControlType()

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

(Inherited from AutomationPeer)
GetAutomationControlTypeCore()

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

(Inherited from AutomationPeer)
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 UIElement that corresponds to the data item in the Items collection that is associated with this ItemAutomationPeer.

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 bounding rectangle of the specified UIElement.

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 of the UIElement that corresponds to the data item in the Items collection that is associated with this ItemAutomationPeer.

GetClassName()

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

(Inherited from AutomationPeer)
GetClassNameCore()

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

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

Gets a Point that represents the clickable space that is on the specified UIElement.

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)
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 UIElement that corresponds to the data item in the Items collection that is associated with this ItemAutomationPeer.

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 specified UIElement.

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 item that the specified UIElement represents.

GetLabeledBy()

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

(Inherited from AutomationPeer)
GetLabeledByCore()

Gets the AutomationPeer for the Label that is targeted to the specified UIElement.

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 for the UIElement that corresponds to the data item in the Items collection that is associated with this ItemAutomationPeer object.

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 UIElement that corresponds to the data item in the Items collection that is associated with this ItemAutomationPeer.

GetOrientation()

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

(Inherited from AutomationPeer)
GetOrientationCore()

Gets a value that indicates whether the specified UIElement is laid out in a particular direction.

GetParent()

Gets the AutomationPeer that is the parent of this AutomationPeer.

(Inherited from AutomationPeer)
GetPattern(PatternInterface)

Returns the object that supports the specified control pattern of the element that is associated with this automation peer.

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

Gets the position of this item within a set.

GetSizeOfSet()

Attempts to get the value of the SizeOfSet property.

(Inherited from AutomationPeer)
GetSizeOfSetCore()

Gets the size of a set that contains this item.

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 specified UIElement currently has keyboard input focus.

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 specified UIElement contains data that is presented to the user.

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 a value that indicates whether the UIElement that is associated with this ItemAutomationPeer is understood by the end user as interactive.

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 the specified UIElement can receive and send events.

IsKeyboardFocusable()

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

(Inherited from AutomationPeer)
IsKeyboardFocusableCore()

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

IsOffscreen()

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

(Inherited from AutomationPeer)
IsOffscreenCore()

Gets a value that indicates whether the specified UIElement is off the screen.

IsPassword()

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

(Inherited from AutomationPeer)
IsPasswordCore()

Gets a value that indicates whether the specified UIElement contains protected content.

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 specified UIElement is required to be completed on a form.

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

Called by the AutomationPeer to raise the AsyncContentLoadedEvent event.

(Inherited from AutomationPeer)
RaiseAutomationEvent(AutomationEvents)

Raises an automation event.

(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 specified UIElement. The UIElement corresponds to the data item in the Items collection that is associated with this ItemAutomationPeer.

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)

Explicit Interface Implementations

IVirtualizedItemProvider.Realize()

Makes the virtual item fully accessible as a UI Automation element.

Applies to