This topic has not yet been rated - Rate this topic

ItemAutomationPeer Class

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

Namespace:  System.Windows.Automation.Peers
Assembly:  PresentationFramework (in PresentationFramework.dll)
public abstract class ItemAutomationPeer : AutomationPeer, 
	IVirtualizedItemProvider

The ItemAutomationPeer type exposes the following members.

  Name Description
Protected method ItemAutomationPeer Provides initialization for base class values when called by the constructor of a derived class.
Top
  Name Description
Public property Dispatcher Gets the Dispatcher this DispatcherObject is associated with. (Inherited from DispatcherObject.)
Public property 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.)
Protected property 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.)
Public property Item Gets the data item in the Items collection that is associated with this ItemAutomationPeer.
Public property ItemsControlAutomationPeer Gets the ItemsControlAutomationPeer that is associated with the ItemsControl that holds the Items collection.
Top
  Name Description
Public method CheckAccess Determines whether the calling thread has access to this DispatcherObject. (Inherited from DispatcherObject.)
Public method Equals(Object) Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected method Finalize Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public method GetAcceleratorKey Gets the accelerator key combinations for the element that is associated with the UI Automation peer.  (Inherited from AutomationPeer.)
Protected method GetAcceleratorKeyCore Gets the accelerator key for the UIElement that corresponds to the data item in the Items collection that is associated with this ItemAutomationPeer. (Overrides AutomationPeer.GetAcceleratorKeyCore().)
Public method GetAccessKey Gets the access key for the element that is associated with the automation peer. (Inherited from AutomationPeer.)
Protected method GetAccessKeyCore Gets the access key for the UIElement that corresponds to the data item in the Items collection that is associated with this ItemAutomationPeer. (Overrides AutomationPeer.GetAccessKeyCore().)
Public method GetAutomationControlType Gets the control type for the element that is associated with the UI Automation peer. (Inherited from AutomationPeer.)
Protected method GetAutomationControlTypeCore When overridden in a derived class, is called by GetAutomationControlType. (Inherited from AutomationPeer.)
Public method GetAutomationId Gets the AutomationId of the element that is associated with the automation peer. (Inherited from AutomationPeer.)
Protected method 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. (Overrides AutomationPeer.GetAutomationIdCore().)
Public method GetBoundingRectangle Gets the Rect object that represents the screen coordinates of the element that is associated with the automation peer. (Inherited from AutomationPeer.)
Protected method GetBoundingRectangleCore Gets the Rect that represents the bounding rectangle of the specified UIElement. (Overrides AutomationPeer.GetBoundingRectangleCore().)
Public method 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.)
Protected method 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. (Overrides AutomationPeer.GetChildrenCore().)
Public method GetClassName Gets a name that is used with AutomationControlType, to differentiate the control that is represented by this AutomationPeer. (Inherited from AutomationPeer.)
Protected method GetClassNameCore When overridden in a derived class, is called by GetClassName. (Inherited from AutomationPeer.)
Public method GetClickablePoint Gets a Point on the element that is associated with the automation peer that responds to a mouse click. (Inherited from AutomationPeer.)
Protected method GetClickablePointCore Gets a Point that represents the clickable space that is on the specified UIElement. (Overrides AutomationPeer.GetClickablePointCore().)
Public method GetHashCode Serves as a hash function for a particular type. (Inherited from Object.)
Public method GetHelpText Gets text that describes the functionality of the control that is associated with the automation peer. (Inherited from AutomationPeer.)
Protected method 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. (Overrides AutomationPeer.GetHelpTextCore().)
Protected method 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.)
Public method GetItemStatus Gets text that conveys the visual status of the element that is associated with this automation peer. (Inherited from AutomationPeer.)
Protected method GetItemStatusCore Gets a string that conveys the visual status of the specified UIElement. (Overrides AutomationPeer.GetItemStatusCore().)
Public method GetItemType Gets a string that describes what kind of item an object represents. (Inherited from AutomationPeer.)
Protected method GetItemTypeCore Gets a human-readable string that contains the type of item that the specified UIElement represents. (Overrides AutomationPeer.GetItemTypeCore().)
Public method GetLabeledBy Gets the AutomationPeer for the Label that is targeted to the element. (Inherited from AutomationPeer.)
Protected method GetLabeledByCore Gets the AutomationPeer for the Label that is targeted to the specified UIElement. (Overrides AutomationPeer.GetLabeledByCore().)
Public method 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.)
Protected method GetLocalizedControlTypeCore When overridden in a derived class, is called by GetLocalizedControlType. (Inherited from AutomationPeer.)
Public method GetName Gets text that describes the element that is associated with this automation peer. (Inherited from AutomationPeer.)
Protected method GetNameCore Gets the text label of the UIElement that corresponds to the data item in the Items collection that is associated with this ItemAutomationPeer. (Overrides AutomationPeer.GetNameCore().)
Public method GetOrientation Gets a value that indicates the explicit control orientation, if any. (Inherited from AutomationPeer.)
Protected method GetOrientationCore Gets a value that indicates whether the specified UIElement is laid out in a particular direction. (Overrides AutomationPeer.GetOrientationCore().)
Public method GetParent Gets the AutomationPeer that is the parent of this AutomationPeer. (Inherited from AutomationPeer.)
Public method GetPattern Returns the object that supports the specified control pattern of the element that is associated with this automation peer. (Overrides AutomationPeer.GetPattern(PatternInterface).)
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Public method HasKeyboardFocus Gets a value that indicates whether the element that is associated with this automation peer currently has keyboard focus. (Inherited from AutomationPeer.)
Protected method HasKeyboardFocusCore Gets a value that indicates whether the specified UIElement currently has keyboard input focus. (Overrides AutomationPeer.HasKeyboardFocusCore().)
Public method 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.)
Public method 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.)
Protected method IsContentElementCore Gets a value that indicates whether the specified UIElement contains data that is presented to the user. (Overrides AutomationPeer.IsContentElementCore().)
Public method 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.)
Protected method IsControlElementCore Gets a value that indicates whether the UIElement that is associated with this ItemAutomationPeer is understood by the end user as interactive. (Overrides AutomationPeer.IsControlElementCore().)
Public method IsEnabled Gets a value that indicates whether the element associated with this automation peer supports interaction. (Inherited from AutomationPeer.)
Protected method IsEnabledCore Gets a value that indicates whether the specified UIElement can receive and send events. (Overrides AutomationPeer.IsEnabledCore().)
Public method IsKeyboardFocusable Gets a value that indicates whether the element can accept keyboard focus. (Inherited from AutomationPeer.)
Protected method IsKeyboardFocusableCore Gets a value that indicates whether the specified UIElement can accept keyboard focus. (Overrides AutomationPeer.IsKeyboardFocusableCore().)
Public method IsOffscreen Gets a value that indicates whether an element is off the screen. (Inherited from AutomationPeer.)
Protected method IsOffscreenCore Gets a value that indicates whether the specified UIElement is off the screen. (Overrides AutomationPeer.IsOffscreenCore().)
Public method IsPassword Gets a value that indicates whether the element contains sensitive content. (Inherited from AutomationPeer.)
Protected method IsPasswordCore Gets a value that indicates whether the specified UIElement contains protected content. (Overrides AutomationPeer.IsPasswordCore().)
Public method IsRequiredForForm Gets a value that indicates whether the element that is associated with this peer must be completed on a form. (Inherited from AutomationPeer.)
Protected method IsRequiredForFormCore Gets a value that indicates whether the specified UIElement is required to be completed on a form. (Overrides AutomationPeer.IsRequiredForFormCore().)
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Protected method PeerFromProvider Gets an AutomationPeer for the specified IRawElementProviderSimple proxy. (Inherited from AutomationPeer.)
Protected method ProviderFromPeer Gets the IRawElementProviderSimple for the specified AutomationPeer. (Inherited from AutomationPeer.)
Public method RaiseAsyncContentLoadedEvent Called by the AutomationPeer to raise the AsyncContentLoadedEvent event. (Inherited from AutomationPeer.)
Public method RaiseAutomationEvent Raises an automation event. (Inherited from AutomationPeer.)
Public method RaisePropertyChangedEvent Raises an event to notify the automation client of a changed property value. (Inherited from AutomationPeer.)
Public method ResetChildrenCache Synchronously resets the tree of child elements by calling GetChildrenCore. (Inherited from AutomationPeer.)
Public method SetFocus Sets the keyboard focus on the element that is associated with this automation peer. (Inherited from AutomationPeer.)
Protected method 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. (Overrides AutomationPeer.SetFocusCore().)
Public method ToString Returns a string that represents the current object. (Inherited from Object.)
Public method VerifyAccess Enforces that the calling thread has access to this DispatcherObject. (Inherited from DispatcherObject.)
Top
  Name Description
Explicit interface implemetation Private method IVirtualizedItemProvider.Realize Makes the virtual item fully accessible as a UI Automation element.
Top

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.

.NET Framework

Supported in: 4, 3.5, 3.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Did you find this helpful?
(1500 characters remaining)
Community Content Add
Annotations FAQ