ItemAutomationPeer Class

This API supports the .NET Framework infrastructure and is not intended to be used directly from your code.

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

Namespace:  System.Windows.Automation.Peers
Assembly:  System.Windows (in System.Windows.dll)

public abstract class ItemAutomationPeer : FrameworkElementAutomationPeer

The ItemAutomationPeer type exposes the following members.

  NameDescription
Protected methodItemAutomationPeer(UIElement)Provides initialization for base class values when called by the constructor of a derived class.
Protected methodItemAutomationPeer(Object, ItemsControlAutomationPeer)Provides initialization for base class values when called by the constructor of a derived class.
Top

  NameDescription
Public propertyDispatcherGets the Dispatcher this object is associated with. (Inherited from DependencyObject.)
Public propertyEventsSourceGets 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 propertyItemGets the requested data item in the Items collection that is associated with this ItemAutomationPeer.
Protected propertyItemsControlAutomationPeerGets the ItemsControlAutomationPeer that is associated with the ItemsControl for this peer's Items.
Public propertyOwnerGets the UIElement that is associated with this FrameworkElementAutomationPeer. (Inherited from FrameworkElementAutomationPeer.)
Top

  NameDescription
Public methodCheckAccessDetermines whether the calling thread has access to this object. (Inherited from DependencyObject.)
Public methodClearValueClears the local value of a dependency property. (Inherited from DependencyObject.)
Public methodEquals(Object)Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetAcceleratorKeyGets the accelerator key combination for the object that is associated with the UI Automation peer. (Inherited from AutomationPeer.)
Protected methodGetAcceleratorKeyCoreReturns the accelerator key for the item element that is associated with this ItemAutomationPeer. This method is called by GetAcceleratorKey. (Overrides FrameworkElementAutomationPeer.GetAcceleratorKeyCore().)
Public methodGetAccessKeyGets the access key for the object that is associated with the automation peer. (Inherited from AutomationPeer.)
Protected methodGetAccessKeyCoreReturns the access key for the item element that is associated with this ItemAutomationPeer. This method is called by GetAccessKey. (Overrides FrameworkElementAutomationPeer.GetAccessKeyCore().)
Public methodGetAnimationBaseValueReturns any base value established for a Windows Phone dependency property, which would apply in cases where an animation is not active. (Inherited from DependencyObject.)
Public methodGetAutomationControlTypeGets the control type for the object that is associated with the UI Automation peer. (Inherited from AutomationPeer.)
Protected methodGetAutomationControlTypeCoreReturns the control type for the item element that is associated with this ItemAutomationPeer. This method is called by GetAutomationControlType. (Overrides FrameworkElementAutomationPeer.GetAutomationControlTypeCore().)
Public methodGetAutomationIdGets the AutomationId of the object that is associated with the automation peer. (Inherited from AutomationPeer.)
Protected methodGetAutomationIdCoreReturns the string that uniquely identifies the item element that is associated with this ItemAutomationPeer. This method is called by GetAutomationId. (Overrides FrameworkElementAutomationPeer.GetAutomationIdCore().)
Public methodGetBoundingRectangleGets the Rect object that represents the screen coordinates of the element that is associated with the automation peer. (Inherited from AutomationPeer.)
Protected methodGetBoundingRectangleCoreReturns the Rect that represents the bounding rectangle of the item element that is associated with this ItemAutomationPeer. This method is called by GetBoundingRectangle. (Overrides FrameworkElementAutomationPeer.GetBoundingRectangleCore().)
Public methodGetChildrenGets the collection of child elements that are represented in the UI Automation tree as immediate child elements of the automation peer. (Inherited from AutomationPeer.)
Protected methodGetChildrenCoreReturns automation peers for the collection of child elements of the owner. The owner class is associated with the ItemAutomationPeer. This method is called by GetChildren. (Overrides FrameworkElementAutomationPeer.GetChildrenCore().)
Public methodGetClassNameGets the name of the control class that is associated with the peer. (Inherited from AutomationPeer.)
Protected methodGetClassNameCoreReturns name of the class that is associated with this ItemAutomationPeer. This method is called by GetClassName. (Overrides FrameworkElementAutomationPeer.GetClassNameCore().)
Public methodGetClickablePointGets a Point on the object that is associated with the automation peer that responds to a mouse click. (Inherited from AutomationPeer.)
Protected methodGetClickablePointCoreReturns a Point that represents the clickable space for the item element that is associated with this ItemAutomationPeer. This method is called by GetClickablePoint. (Overrides FrameworkElementAutomationPeer.GetClickablePointCore().)
Public methodGetHashCodeServes as a hash function for a particular type. (Inherited from Object.)
Public methodGetHelpTextGets text that describes the functionality of the control that is associated with the automation peer. (Inherited from AutomationPeer.)
Protected methodGetHelpTextCoreReturns the string that describes the functionality of the item element that is associated with this ItemAutomationPeer. his method is called by GetHelpText. (Overrides FrameworkElementAutomationPeer.GetHelpTextCore().)
Public methodGetItemStatusGets text that conveys the visual status of the object that is associated with this automation peer. (Inherited from AutomationPeer.)
Protected methodGetItemStatusCoreReturns a string that communicates the visual status of the item element that is associated with this ItemAutomationPeer. This method is called by GetItemStatus. (Overrides FrameworkElementAutomationPeer.GetItemStatusCore().)
Public methodGetItemTypeGets a string that describes what kind of item an element represents. (Inherited from AutomationPeer.)
Protected methodGetItemTypeCoreReturns a human-readable string that contains the type of item element that the item represents. This method is called by GetItemType. (Overrides FrameworkElementAutomationPeer.GetItemTypeCore().)
Public methodGetLabeledByGets the AutomationPeer for the UIElement that is targeted to the element. (Inherited from AutomationPeer.)
Protected methodGetLabeledByCoreReturns the AutomationPeer for the object that targets the item that is associated with this ItemAutomationPeer. This method is called by GetLabeledBy. (Overrides FrameworkElementAutomationPeer.GetLabeledByCore().)
Public methodGetLocalizedControlTypeGets a localized string that represents the control type, for the control that is associated with this automation peer. The localized string parallels a AutomationControlType value. (Inherited from AutomationPeer.)
Protected methodGetLocalizedControlTypeCoreReturns a localized human-readable string that represents a control type. The control is the owner type that is associated with this ItemAutomationPeer. This method is called by GetLocalizedControlType. (Overrides FrameworkElementAutomationPeer.GetLocalizedControlTypeCore().)
Public methodGetNameGets the value that the automation peer reports as the UI Automation Name for the associated control. (Inherited from AutomationPeer.)
Protected methodGetNameCoreGets the UI Automation Name from the element that corresponds to a data item. The item is the element in an Items collection that is associated with this ItemAutomationPeer. This method is called by GetName. (Overrides FrameworkElementAutomationPeer.GetNameCore().)
Public methodGetOrientationGets a value that indicates the explicit control orientation, if any. (Inherited from AutomationPeer.)
Protected methodGetOrientationCoreReturns a value that indicates whether the element that is associated with this ItemAutomationPeer is laid out in a specific direction. This method is called by GetOrientation. (Overrides FrameworkElementAutomationPeer.GetOrientationCore().)
Public methodGetParentGets the AutomationPeer that is the parent of this AutomationPeer. (Inherited from AutomationPeer.)
Public methodGetPatternReturns an object that supports the requested pattern, based on the patterns supported by this ItemAutomationPeer. (Overrides FrameworkElementAutomationPeer.GetPattern(PatternInterface).)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodGetValueReturns the current effective value of a dependency property from a DependencyObject. (Inherited from DependencyObject.)
Public methodHasKeyboardFocusGets a value that indicates whether the object that is associated with this automation peer currently has keyboard focus. (Inherited from AutomationPeer.)
Protected methodHasKeyboardFocusCoreReturns a value that indicates whether the item element that is associated with this ItemAutomationPeer currently has keyboard input focus. This method is called by HasKeyboardFocus. (Overrides FrameworkElementAutomationPeer.HasKeyboardFocusCore().)
Public methodInvalidatePeerTriggers 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.)
Public methodIsContentElementGets a value that indicates whether the object that is associated with this automation peer contains data that is presented to the user. (Inherited from AutomationPeer.)
Protected methodIsContentElementCoreReturns a value that indicates whether the item element that is associated with this ItemAutomationPeer is an element that contains data that is presented to the user. This method is called by IsContentElement. (Overrides FrameworkElementAutomationPeer.IsContentElementCore().)
Public methodIsControlElementGets 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 methodIsControlElementCoreReturns a value that indicates whether the item element that is associated with this ItemAutomationPeer is understood by the end user as interactive. Optionally, the user might understand the element as contributing to the logical structure of the control in the GUI. This method is called by IsControlElement. (Overrides FrameworkElementAutomationPeer.IsControlElementCore().)
Public methodIsEnabledGets a value that indicates whether the element associated with this automation peer supports interaction. (Inherited from AutomationPeer.)
Protected methodIsEnabledCoreReturns a value that indicates whether the item element that is associated with this ItemAutomationPeer is enabled. This method is called by IsEnabled. (Overrides FrameworkElementAutomationPeer.IsEnabledCore().)
Public methodIsKeyboardFocusableGets a value that indicates whether the element can accept keyboard focus. (Inherited from AutomationPeer.)
Protected methodIsKeyboardFocusableCoreReturns a value that indicates whether the item element that is associated with this ItemAutomationPeer can accept keyboard focus. This method is called by IsKeyboardFocusable. (Overrides FrameworkElementAutomationPeer.IsKeyboardFocusableCore().)
Public methodIsOffscreenGets a value that indicates whether an element is off the screen. (Inherited from AutomationPeer.)
Protected methodIsOffscreenCoreReturns a value that indicates whether the item element that is associated with this ItemAutomationPeer is off the screen. This method is called by IsOffscreen. (Overrides FrameworkElementAutomationPeer.IsOffscreenCore().)
Public methodIsPasswordGets a value that indicates whether the element contains sensitive content. (Inherited from AutomationPeer.)
Protected methodIsPasswordCoreReturns a value that indicates whether the item element that is associated with this ItemAutomationPeer contains protected content. This method is called by IsPassword. (Overrides FrameworkElementAutomationPeer.IsPasswordCore().)
Public methodIsRequiredForFormGets a value that indicates whether the object that is associated with this peer must be completed on a form. (Inherited from AutomationPeer.)
Protected methodIsRequiredForFormCoreReturns a value that indicates whether the item element that is associated with this ItemAutomationPeer is required to be completed on a form. This method is called by IsRequiredForForm. (Overrides FrameworkElementAutomationPeer.IsRequiredForFormCore().)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Protected methodPeerFromProviderGets an AutomationPeer for the specified IRawElementProviderSimple proxy. (Inherited from AutomationPeer.)
Protected methodProviderFromPeerGets the IRawElementProviderSimple proxy for the specified AutomationPeer. (Inherited from AutomationPeer.)
Public methodRaiseAutomationEventRaises an automation event. (Inherited from AutomationPeer.)
Public methodRaisePropertyChangedEventRaises an event to notify the automation client of a changed property value. (Inherited from AutomationPeer.)
Public methodReadLocalValueReturns the local value of a dependency property, if a local value is set. (Inherited from DependencyObject.)
Public methodSetFocusSets the keyboard focus on the object that is associated with this automation peer. (Inherited from AutomationPeer.)
Protected methodSetFocusCoreSets the keyboard input focus on the item element that is associated with this FrameworkElementAutomationPeer. This method is called by SetFocus. (Overrides FrameworkElementAutomationPeer.SetFocusCore().)
Public methodSetValueSets the local value of a dependency property on a DependencyObject. (Inherited from DependencyObject.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Top

Notes to Inheritors

ItemAutomationPeer derives from FrameworkElementAutomationPeer and overrides several FrameworkElementAutomationPeer APIs. Generally the overrides follow a pattern where if the ItemAutomationPeer has a nonnull Owner, then the implementation calls base. If the owner is null, then the implementations check for an associated container and use its automation information if possible. The fallback values if neither of these conditions are true are generally the value defaults for that data type, or otherwise representat that there is not a conventional UI item associated with this item in the automation tree.

Windows Phone OS

Supported in: 8.1, 8.0, 7.1, 7.0

Windows Phone

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Show:
© 2015 Microsoft