ItemsControlAutomationPeer ItemsControlAutomationPeer ItemsControlAutomationPeer Class

Definition

Exposes ItemsControl types to Microsoft UI Automation.

public : class ItemsControlAutomationPeer : FrameworkElementAutomationPeer, IItemsControlAutomationPeer, IItemsControlAutomationPeer2, IItemsControlAutomationPeerOverrides2, IItemContainerProvider
public class ItemsControlAutomationPeer : FrameworkElementAutomationPeer, IItemsControlAutomationPeer, IItemsControlAutomationPeer2, IItemsControlAutomationPeerOverrides2, IItemContainerProvider
Public Class ItemsControlAutomationPeer Inherits FrameworkElementAutomationPeer Implements IItemsControlAutomationPeer, IItemsControlAutomationPeer2, IItemsControlAutomationPeerOverrides2, IItemContainerProvider
Inheritance
Attributes
Windows 10 requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

Remarks

The Windows Runtime ItemsControl class creates a new ItemsControlAutomationPeer as its OnCreateAutomationPeer definition. Derive your automation peer from ItemsControlAutomationPeer if you are deriving a custom class from ItemsControl and want to add automation support for additional features that you enabled in your custom class. Then override OnCreateAutomationPeer so that it returns your custom peer. Make sure though that there aren't any existing derived classes from ItemsControl that might better suit your scenario. For example, Selector, FlipView, GridView, ComboBox, ListViewBase and ListBox are all a type of ItemsControl. Each of these already has a dedicated automation peer.

Default peer implementation and overrides in ItemsControlAutomationPeer

ItemsControlAutomationPeer has overrides of Core methods such that the associated AutomationPeer methods provide peer-specific information to a Microsoft UI Automation client.

For Windows Phone 8.x apps, ItemsControlAutomationPeer has methods that support creating item-specific automation peers for data items. See CreateItemAutomationPeer and OnCreateItemAutomationPeer.

ItemsControlAutomationPeer derived classes

ItemsControlAutomationPeer is the parent class for SelectorAutomationPeer.

Constructors

ItemsControlAutomationPeer(ItemsControl) ItemsControlAutomationPeer(ItemsControl) ItemsControlAutomationPeer(ItemsControl)

Initializes a new instance of the ItemsControlAutomationPeer class.

public : ItemsControlAutomationPeer(ItemsControl owner)
public ItemsControlAutomationPeer(ItemsControl owner)
Public Sub New(owner As ItemsControl)
Parameters
owner
ItemsControl ItemsControl ItemsControl

The owner element to create for.

Methods

ClearValue(DependencyProperty) ClearValue(DependencyProperty) ClearValue(DependencyProperty)

Inherited from DependencyObject

CreateItemAutomationPeer(Object) CreateItemAutomationPeer(Object) CreateItemAutomationPeer(Object)

Creates a new instance of the ItemAutomationPeer for a data item in the Items collection of this ItemsControl.

public : ItemAutomationPeer CreateItemAutomationPeer(Platform::Object item)
public ItemAutomationPeer CreateItemAutomationPeer(Object item)
Public Function CreateItemAutomationPeer(item As Object) As ItemAutomationPeer
Parameters
item
Platform::Object Object Object

The data item that is associated with this ItemAutomationPeer.

Returns

CreatePeerForElement(UIElement) CreatePeerForElement(UIElement) CreatePeerForElement(UIElement)

FindItemByProperty(IRawElementProviderSimple, AutomationProperty, Object) FindItemByProperty(IRawElementProviderSimple, AutomationProperty, Object) FindItemByProperty(IRawElementProviderSimple, AutomationProperty, Object)

Retrieves an element by the specified property value.

public : IRawElementProviderSimple FindItemByProperty(IRawElementProviderSimple startAfter, AutomationProperty automationProperty, Platform::Object value)
public IRawElementProviderSimple FindItemByProperty(IRawElementProviderSimple startAfter, AutomationProperty automationProperty, Object value)
Public Function FindItemByProperty(startAfter As IRawElementProviderSimple, automationProperty As AutomationProperty, value As Object) As IRawElementProviderSimple
Parameters
startAfter
IRawElementProviderSimple IRawElementProviderSimple IRawElementProviderSimple

The item in the container after which to begin the search.

automationProperty
AutomationProperty AutomationProperty AutomationProperty

The property that contains the value to retrieve.

value
Platform::Object Object Object

The value to retrieve.

Returns

The first item that matches the search criterion if such an item exists; otherwise, null.

FromElement(UIElement) FromElement(UIElement) FromElement(UIElement)

GenerateRawElementProviderRuntimeId GenerateRawElementProviderRuntimeId GenerateRawElementProviderRuntimeId

Inherited from AutomationPeer

GetAcceleratorKey GetAcceleratorKey GetAcceleratorKey

Inherited from AutomationPeer

GetAcceleratorKeyCore GetAcceleratorKeyCore GetAcceleratorKeyCore

Inherited from AutomationPeer

GetAccessKey GetAccessKey GetAccessKey

Inherited from AutomationPeer

GetAccessKeyCore GetAccessKeyCore GetAccessKeyCore

Inherited from AutomationPeer

GetAnimationBaseValue(DependencyProperty) GetAnimationBaseValue(DependencyProperty) GetAnimationBaseValue(DependencyProperty)

Inherited from DependencyObject

GetAnnotations GetAnnotations GetAnnotations

Inherited from AutomationPeer

GetAnnotationsCore GetAnnotationsCore GetAnnotationsCore

Inherited from AutomationPeer

GetAutomationControlType GetAutomationControlType GetAutomationControlType

Inherited from AutomationPeer

GetAutomationControlTypeCore GetAutomationControlTypeCore GetAutomationControlTypeCore

Inherited from AutomationPeer

GetAutomationId GetAutomationId GetAutomationId

Inherited from AutomationPeer

GetAutomationIdCore GetAutomationIdCore GetAutomationIdCore

Inherited from AutomationPeer

GetBoundingRectangle GetBoundingRectangle GetBoundingRectangle

Inherited from AutomationPeer

GetBoundingRectangleCore GetBoundingRectangleCore GetBoundingRectangleCore

Inherited from AutomationPeer

GetChildren GetChildren GetChildren

Inherited from AutomationPeer

GetChildrenCore GetChildrenCore GetChildrenCore

Inherited from AutomationPeer

GetClassName GetClassName GetClassName

Inherited from AutomationPeer

GetClassNameCore GetClassNameCore GetClassNameCore

Inherited from AutomationPeer

GetClickablePoint GetClickablePoint GetClickablePoint

Inherited from AutomationPeer

GetClickablePointCore GetClickablePointCore GetClickablePointCore

Inherited from AutomationPeer

GetControlledPeers GetControlledPeers GetControlledPeers

Inherited from AutomationPeer

GetControlledPeersCore GetControlledPeersCore GetControlledPeersCore

Inherited from AutomationPeer

GetCulture GetCulture GetCulture

Inherited from AutomationPeer

GetCultureCore GetCultureCore GetCultureCore

Inherited from AutomationPeer

GetDescribedByCore GetDescribedByCore GetDescribedByCore

Inherited from AutomationPeer

GetElementFromPoint(Point) GetElementFromPoint(Point) GetElementFromPoint(Point)

Inherited from AutomationPeer

GetElementFromPointCore(Point) GetElementFromPointCore(Point) GetElementFromPointCore(Point)

Inherited from AutomationPeer

GetFlowsFromCore GetFlowsFromCore GetFlowsFromCore

Inherited from AutomationPeer

GetFlowsToCore GetFlowsToCore GetFlowsToCore

Inherited from AutomationPeer

GetFocusedElement GetFocusedElement GetFocusedElement

Inherited from AutomationPeer

GetFocusedElementCore GetFocusedElementCore GetFocusedElementCore

Inherited from AutomationPeer

GetFullDescription GetFullDescription GetFullDescription

Inherited from AutomationPeer

GetFullDescriptionCore GetFullDescriptionCore GetFullDescriptionCore

Inherited from AutomationPeer

GetHelpText GetHelpText GetHelpText

Inherited from AutomationPeer

GetHelpTextCore GetHelpTextCore GetHelpTextCore

Inherited from AutomationPeer

GetItemStatus GetItemStatus GetItemStatus

Inherited from AutomationPeer

GetItemStatusCore GetItemStatusCore GetItemStatusCore

Inherited from AutomationPeer

GetItemType GetItemType GetItemType

Inherited from AutomationPeer

GetItemTypeCore GetItemTypeCore GetItemTypeCore

Inherited from AutomationPeer

GetLabeledBy GetLabeledBy GetLabeledBy

Inherited from AutomationPeer

GetLabeledByCore GetLabeledByCore GetLabeledByCore

Inherited from AutomationPeer

GetLandmarkType GetLandmarkType GetLandmarkType

Inherited from AutomationPeer

GetLandmarkTypeCore GetLandmarkTypeCore GetLandmarkTypeCore

Inherited from AutomationPeer

GetLevel GetLevel GetLevel

Inherited from AutomationPeer

GetLevelCore GetLevelCore GetLevelCore

Inherited from AutomationPeer

GetLiveSetting GetLiveSetting GetLiveSetting

Inherited from AutomationPeer

GetLiveSettingCore GetLiveSettingCore GetLiveSettingCore

Inherited from AutomationPeer

GetLocalizedControlType GetLocalizedControlType GetLocalizedControlType

Inherited from AutomationPeer

GetLocalizedControlTypeCore GetLocalizedControlTypeCore GetLocalizedControlTypeCore

Inherited from AutomationPeer

GetLocalizedLandmarkType GetLocalizedLandmarkType GetLocalizedLandmarkType

Inherited from AutomationPeer

GetLocalizedLandmarkTypeCore GetLocalizedLandmarkTypeCore GetLocalizedLandmarkTypeCore

Inherited from AutomationPeer

GetName GetName GetName

Inherited from AutomationPeer

GetNameCore GetNameCore GetNameCore

Inherited from AutomationPeer

GetOrientation GetOrientation GetOrientation

Inherited from AutomationPeer

GetOrientationCore GetOrientationCore GetOrientationCore

Inherited from AutomationPeer

GetParent GetParent GetParent

Inherited from AutomationPeer

GetPattern(PatternInterface) GetPattern(PatternInterface) GetPattern(PatternInterface)

Inherited from AutomationPeer

GetPatternCore(PatternInterface) GetPatternCore(PatternInterface) GetPatternCore(PatternInterface)

Inherited from AutomationPeer

GetPeerFromPoint(Point) GetPeerFromPoint(Point) GetPeerFromPoint(Point)

Inherited from AutomationPeer

GetPeerFromPointCore(Point) GetPeerFromPointCore(Point) GetPeerFromPointCore(Point)

Inherited from AutomationPeer

GetPositionInSet GetPositionInSet GetPositionInSet

Inherited from AutomationPeer

GetPositionInSetCore GetPositionInSetCore GetPositionInSetCore

Inherited from AutomationPeer

GetSizeOfSet GetSizeOfSet GetSizeOfSet

Inherited from AutomationPeer

GetSizeOfSetCore GetSizeOfSetCore GetSizeOfSetCore

Inherited from AutomationPeer

GetValue(DependencyProperty) GetValue(DependencyProperty) GetValue(DependencyProperty)

Inherited from DependencyObject

HasKeyboardFocus HasKeyboardFocus HasKeyboardFocus

Inherited from AutomationPeer

HasKeyboardFocusCore HasKeyboardFocusCore HasKeyboardFocusCore

Inherited from AutomationPeer

InvalidatePeer InvalidatePeer InvalidatePeer

Inherited from AutomationPeer

IsContentElement IsContentElement IsContentElement

Inherited from AutomationPeer

IsContentElementCore IsContentElementCore IsContentElementCore

Inherited from AutomationPeer

IsControlElement IsControlElement IsControlElement

Inherited from AutomationPeer

IsControlElementCore IsControlElementCore IsControlElementCore

Inherited from AutomationPeer

IsDataValidForForm IsDataValidForForm IsDataValidForForm

Inherited from AutomationPeer

IsDataValidForFormCore IsDataValidForFormCore IsDataValidForFormCore

Inherited from AutomationPeer

IsEnabled IsEnabled IsEnabled

Inherited from AutomationPeer

IsEnabledCore IsEnabledCore IsEnabledCore

Inherited from AutomationPeer

IsKeyboardFocusable IsKeyboardFocusable IsKeyboardFocusable

Inherited from AutomationPeer

IsKeyboardFocusableCore IsKeyboardFocusableCore IsKeyboardFocusableCore

Inherited from AutomationPeer

IsOffscreen IsOffscreen IsOffscreen

Inherited from AutomationPeer

IsOffscreenCore IsOffscreenCore IsOffscreenCore

Inherited from AutomationPeer

IsPassword IsPassword IsPassword

Inherited from AutomationPeer

IsPasswordCore IsPasswordCore IsPasswordCore

Inherited from AutomationPeer

IsPeripheral IsPeripheral IsPeripheral

Inherited from AutomationPeer

IsPeripheralCore IsPeripheralCore IsPeripheralCore

Inherited from AutomationPeer

IsRequiredForForm IsRequiredForForm IsRequiredForForm

Inherited from AutomationPeer

IsRequiredForFormCore IsRequiredForFormCore IsRequiredForFormCore

Inherited from AutomationPeer

ListenerExists(AutomationEvents) ListenerExists(AutomationEvents) ListenerExists(AutomationEvents)

Inherited from AutomationPeer

Navigate(AutomationNavigationDirection) Navigate(AutomationNavigationDirection) Navigate(AutomationNavigationDirection)

Inherited from AutomationPeer

NavigateCore(AutomationNavigationDirection) NavigateCore(AutomationNavigationDirection) NavigateCore(AutomationNavigationDirection)

Inherited from AutomationPeer

OnCreateItemAutomationPeer(Object) OnCreateItemAutomationPeer(Object) OnCreateItemAutomationPeer(Object)

Invoked whenever a new instance of the ItemAutomationPeer is created for a data item in the Items collection of this ItemsControl.

protected : virtual ItemAutomationPeer OnCreateItemAutomationPeer(Platform::Object item)
protected virtual ItemAutomationPeer OnCreateItemAutomationPeer(Object item)
Protected Overridable Function OnCreateItemAutomationPeer(item As Object) As ItemAutomationPeer
Parameters
item
Platform::Object Object Object

The data item that is associated with this ItemAutomationPeer.

Returns

PeerFromProvider(IRawElementProviderSimple) PeerFromProvider(IRawElementProviderSimple) PeerFromProvider(IRawElementProviderSimple)

Inherited from AutomationPeer

ProviderFromPeer(AutomationPeer) ProviderFromPeer(AutomationPeer) ProviderFromPeer(AutomationPeer)

Inherited from AutomationPeer

RaiseAutomationEvent(AutomationEvents) RaiseAutomationEvent(AutomationEvents) RaiseAutomationEvent(AutomationEvents)

Inherited from AutomationPeer

RaiseNotificationEvent(AutomationNotificationKind,AutomationNotificationProcessing,String,String) RaiseNotificationEvent(AutomationNotificationKind,AutomationNotificationProcessing,String,String) RaiseNotificationEvent(AutomationNotificationKind,AutomationNotificationProcessing,String,String)

Inherited from AutomationPeer

RaisePropertyChangedEvent(AutomationProperty,Object,Object) RaisePropertyChangedEvent(AutomationProperty,Object,Object) RaisePropertyChangedEvent(AutomationProperty,Object,Object)

Inherited from AutomationPeer

RaiseStructureChangedEvent(AutomationStructureChangeType,AutomationPeer) RaiseStructureChangedEvent(AutomationStructureChangeType,AutomationPeer) RaiseStructureChangedEvent(AutomationStructureChangeType,AutomationPeer)

Inherited from AutomationPeer

RaiseTextEditTextChangedEvent(AutomationTextEditChangeType,IVectorView{String}) RaiseTextEditTextChangedEvent(AutomationTextEditChangeType,IVectorView{String}) RaiseTextEditTextChangedEvent(AutomationTextEditChangeType,IVectorView{String})

Inherited from AutomationPeer

ReadLocalValue(DependencyProperty) ReadLocalValue(DependencyProperty) ReadLocalValue(DependencyProperty)

Inherited from DependencyObject

RegisterPropertyChangedCallback(DependencyProperty,DependencyPropertyChangedCallback) RegisterPropertyChangedCallback(DependencyProperty,DependencyPropertyChangedCallback) RegisterPropertyChangedCallback(DependencyProperty,DependencyPropertyChangedCallback)

Inherited from DependencyObject

SetFocus SetFocus SetFocus

Inherited from AutomationPeer

SetFocusCore SetFocusCore SetFocusCore

Inherited from AutomationPeer

SetParent(AutomationPeer) SetParent(AutomationPeer) SetParent(AutomationPeer)

Inherited from AutomationPeer

SetValue(DependencyProperty,Object) SetValue(DependencyProperty,Object) SetValue(DependencyProperty,Object)

Inherited from DependencyObject

ShowContextMenu ShowContextMenu ShowContextMenu

Inherited from AutomationPeer

ShowContextMenuCore ShowContextMenuCore ShowContextMenuCore

Inherited from AutomationPeer

UnregisterPropertyChangedCallback(DependencyProperty,Int64) UnregisterPropertyChangedCallback(DependencyProperty,Int64) UnregisterPropertyChangedCallback(DependencyProperty,Int64)

Inherited from DependencyObject

Properties

Dispatcher Dispatcher Dispatcher

Inherited from DependencyObject

EventsSource EventsSource EventsSource

Inherited from AutomationPeer

Owner Owner Owner

See Also