Class ItemAutomationPeer

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

Inheritance

System.Object

DependencyObject

AutomationPeer

FrameworkElementAutomationPeer

ItemAutomationPeer

SelectorItemAutomationPeer

TabItemAutomationPeer

Inherited Members

FrameworkElementAutomationPeer.Owner

FrameworkElementAutomationPeer.FromElement(UIElement)

FrameworkElementAutomationPeer.CreatePeerForElement(UIElement)

AutomationPeer.EventsSource

AutomationPeer.ListenerExists(AutomationEvents)

AutomationPeer.GetAcceleratorKey()

AutomationPeer.GetAccessKey()

AutomationPeer.GetAutomationControlType()

AutomationPeer.GetAutomationId()

AutomationPeer.GetBoundingRectangle()

AutomationPeer.GetChildren()

AutomationPeer.GetClassName()

AutomationPeer.GetClickablePoint()

AutomationPeer.GetHelpText()

AutomationPeer.GetItemStatus()

AutomationPeer.GetItemType()

AutomationPeer.GetLabeledBy()

AutomationPeer.GetLocalizedControlType()

AutomationPeer.GetName()

AutomationPeer.GetOrientation()

AutomationPeer.HasKeyboardFocus()

AutomationPeer.IsContentElement()

AutomationPeer.IsControlElement()

AutomationPeer.IsEnabled()

AutomationPeer.IsKeyboardFocusable()

AutomationPeer.IsOffscreen()

AutomationPeer.IsPassword()

AutomationPeer.IsRequiredForForm()

AutomationPeer.SetFocus()

AutomationPeer.InvalidatePeer()

AutomationPeer.GetParent()

AutomationPeer.RaiseAutomationEvent(AutomationEvents)

AutomationPeer.RaisePropertyChangedEvent(AutomationProperty, Object, Object)

AutomationPeer.PeerFromProvider(IRawElementProviderSimple)

AutomationPeer.ProviderFromPeer(AutomationPeer)

DependencyObject.GetValue(DependencyProperty)

DependencyObject.SetCurrentValue(DependencyProperty, Object)

DependencyObject.ReadLocalValue(DependencyProperty)

DependencyObject.SetValue(DependencyProperty, Object)

DependencyObject.SetValue(DependencyPropertyKey, Object)

DependencyObject.OnPropertyChanged(DependencyPropertyChangedEventArgs)

DependencyObject.CoerceValue(DependencyProperty)

DependencyObject.Dispatcher

DependencyObject.INTERNAL_OnAttachedToVisualTree()

DependencyObject.INTERNAL_OnDetachedFromVisualTree()

DependencyObject.ClearValue(DependencyProperty)

DependencyObject.ClearValue(DependencyPropertyKey)

DependencyObject.CheckAccess()

DependencyObject.GetAnimationBaseValue(DependencyProperty)

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: System.Windows.Automation.Peers

Assembly: OpenSilver.dll

Syntax

public abstract class ItemAutomationPeer : FrameworkElementAutomationPeer, IDependencyObject

Constructors

ItemAutomationPeer(Object, ItemsControlAutomationPeer)

Provides initialization for base class values when called by the constructor of a derived class.

Declaration

protected ItemAutomationPeer(object item, ItemsControlAutomationPeer itemsControlAutomationPeer)

Parameters

Type	Name	Description
System.Object	item	The data item in the Items collection that is associated with this ItemAutomationPeer .
ItemsControlAutomationPeer	itemsControlAutomationPeer	The ItemsControlAutomationPeer that is associated with the ItemsControl that holds the Items collection.

ItemAutomationPeer(UIElement)

Provides initialization for base class values when called by the constructor of a derived class.

Declaration

protected ItemAutomationPeer(UIElement item)

Parameters

Type	Name	Description
UIElement	item	The data item in the Items collection that is associated with this ItemAutomationPeer .

Properties

Item

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

Declaration

protected object Item { get; }

Property Value

Type	Description
System.Object	The requested data item.

ItemsControlAutomationPeer

Gets the ItemsControlAutomationPeer that is associated with the ItemsControl for this peer's Items .

Declaration

protected ItemsControlAutomationPeer ItemsControlAutomationPeer { get; }

Property Value

Type	Description
ItemsControlAutomationPeer	The ItemsControlAutomationPeer associated with the ItemsControl that holds the Items collection.

Methods

GetAcceleratorKeyCore()

Returns the accelerator key for the item element that is associated with this ItemAutomationPeer. This method is called by GetAcceleratorKey() .

Declaration

protected override string GetAcceleratorKeyCore()

Returns

Type	Description
System.String	The System.Windows.Automation.AutomationProperties.AcceleratorKey that is returned by GetAcceleratorKey(DependencyObject) .

Overrides

FrameworkElementAutomationPeer.GetAcceleratorKeyCore()

GetAccessKeyCore()

Returns the access key for the item element that is associated with this ItemAutomationPeer . This method is called by GetAccessKey() .

Declaration

protected override string GetAccessKeyCore()

Returns

Type	Description
System.String	The access key for the element that is associated with this ItemAutomationPeer .

Overrides

FrameworkElementAutomationPeer.GetAccessKeyCore()

GetAutomationControlTypeCore()

Returns the control type for the item element that is associated with this ItemAutomationPeer. This method is called by GetAutomationControlType().

Declaration

protected override AutomationControlType GetAutomationControlTypeCore()

Returns

Type	Description
AutomationControlType	A value of the enumeration.

Overrides

FrameworkElementAutomationPeer.GetAutomationControlTypeCore()

GetAutomationIdCore()

Returns the string that uniquely identifies the item element that is associated with this ItemAutomationPeer. This method is called by GetAutomationId() .

Declaration

protected override string GetAutomationIdCore()

Returns

Type	Description
System.String	The automation identifier for the element associated with the ItemAutomationPeer, or System.String.Empty if there is no automation identifier.

Overrides

FrameworkElementAutomationPeer.GetAutomationIdCore()

GetBoundingRectangleCore()

Returns the Rect that represents the bounding rectangle of the item element that is associated with this ItemAutomationPeer . This method is called by GetBoundingRectangle() .

Declaration

protected override Rect GetBoundingRectangleCore()

Returns

Type	Description
Rect	The Rect that contains the coordinates of the element item.

Overrides

FrameworkElementAutomationPeer.GetBoundingRectangleCore()

GetChildrenCore()

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

Declaration

protected override List<AutomationPeer> GetChildrenCore()

Returns

Type	Description
System.Collections.Generic.List<AutomationPeer>	A list of AutomationPeer elements.

Overrides

FrameworkElementAutomationPeer.GetChildrenCore()

GetClassNameCore()

Returns name of the class that is associated with this ItemAutomationPeer. This method is called by GetClassName().

Declaration

protected override string GetClassNameCore()

Returns

Type	Description
System.String	The class name. See Remarks.

Overrides

FrameworkElementAutomationPeer.GetClassNameCore()

Remarks

If the item is a UIElement with its own peer as reported by Owner, then information from that peer is forwarded. Next, the container peer (which could be ItemsControlAutomationPeer, ListBoxAutomationPeer, or another class) is used as a possible source. Finally, if there is no container peer, then this method returns System.String.Empty.

GetClickablePointCore()

Returns a Point that represents the clickable space for the item element that is associated with this ItemAutomationPeer. This method is called by GetClickablePoint().

Declaration

protected override Point GetClickablePointCore()

Returns

Type	Description
Point	The Point on the element that allows a click.

Overrides

FrameworkElementAutomationPeer.GetClickablePointCore()

GetHelpTextCore()

Returns the string that describes the functionality of the item element that is associated with this ItemAutomationPeer. This method is called by GetHelpText().

Declaration

protected override string GetHelpTextCore()

Returns

Type	Description
System.String	The help text, or System.String.Empty if there is no help text.

Overrides

FrameworkElementAutomationPeer.GetHelpTextCore()

GetItemStatusCore()

Returns a string that communicates the visual status of the item element that is associated with this ItemAutomationPeer. This method is called by GetItemStatus().

Declaration

protected override string GetItemStatusCore()

Returns

Type	Description
System.String	The string that contains the System.Windows.Automation.AutomationProperties.ItemStatus that is returned by GetItemStatus(DependencyObject).

Overrides

FrameworkElementAutomationPeer.GetItemStatusCore()

GetItemTypeCore()

Returns a human-readable string that contains the type of item element that the item represents. This method is called by GetItemType().

Declaration

protected override string GetItemTypeCore()

Returns

Type	Description
System.String	The item type string.

Overrides

FrameworkElementAutomationPeer.GetItemTypeCore()

GetLabeledByCore()

Returns the AutomationPeer for the object that targets the item that is associated with this ItemAutomationPeer. This method is called by GetLabeledBy().

Declaration

protected override AutomationPeer GetLabeledByCore()

Returns

Type	Description
AutomationPeer	An automation peer for the object that label-targets the peer's owner.

Overrides

FrameworkElementAutomationPeer.GetLabeledByCore()

GetLocalizedControlTypeCore()

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

Declaration

protected override string GetLocalizedControlTypeCore()

Returns

Type	Description
System.String	The string that contains the type of control.

Overrides

FrameworkElementAutomationPeer.GetLocalizedControlTypeCore()

GetNameCore()

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

Declaration

protected override string GetNameCore()

Returns

Type	Description
System.String	The UI Automation Name from the element that corresponds to a data item.

Overrides

FrameworkElementAutomationPeer.GetNameCore()

GetOrientationCore()

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

Declaration

protected override AutomationOrientation GetOrientationCore()

Returns

Type	Description
AutomationOrientation	A value of the enumeration.

Overrides

FrameworkElementAutomationPeer.GetOrientationCore()

GetPattern(PatternInterface)

Returns an object that supports the requested pattern, based on the patterns supported by this ItemAutomationPeer .

Declaration

public override object GetPattern(PatternInterface patternInterface)

Parameters

Type	Name	Description
PatternInterface	patternInterface	One of the enumeration values.

Returns

Type	Description
System.Object	The object that implements the pattern interface, or null if the specified pattern interface is not implemented.

Overrides

FrameworkElementAutomationPeer.GetPattern(PatternInterface)

HasKeyboardFocusCore()

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

Declaration

protected override bool HasKeyboardFocusCore()

Returns

Type	Description
System.Boolean	true if the element has keyboard input focus; otherwise, false.

Overrides

FrameworkElementAutomationPeer.HasKeyboardFocusCore()

IsContentElementCore()

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

Declaration

protected override bool IsContentElementCore()

Returns

Type	Description
System.Boolean	true if the element contains data for the user to read; otherwise, false.

Overrides

FrameworkElementAutomationPeer.IsContentElementCore()

IsControlElementCore()

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

Declaration

protected override bool IsControlElementCore()

Returns

Type	Description
System.Boolean	true if the element is interactive; otherwise, false.

Overrides

FrameworkElementAutomationPeer.IsControlElementCore()

IsEnabledCore()

Returns a value that indicates whether the item element that is associated with this ItemAutomationPeer is enabled. This method is called by IsEnabled().

Declaration

protected override bool IsEnabledCore()

Returns

Type	Description
System.Boolean	true if the element is enabled; otherwise, false.

Overrides

FrameworkElementAutomationPeer.IsEnabledCore()

IsKeyboardFocusableCore()

Returns a value that indicates whether the item element that is associated with this ItemAutomationPeer can accept keyboard focus. This method is called by IsKeyboardFocusable().

Declaration

protected override bool IsKeyboardFocusableCore()

Returns

Type	Description
System.Boolean	true if the item element is focusable by the keyboard; otherwise, false.

Overrides

FrameworkElementAutomationPeer.IsKeyboardFocusableCore()

IsOffscreenCore()

Returns a value that indicates whether the item element that is associated with this ItemAutomationPeer is off the screen. This method is called by IsOffscreen().

Declaration

protected override bool IsOffscreenCore()

Returns

Type	Description
System.Boolean	true if the item element is not on the screen; otherwise, false.

Overrides

FrameworkElementAutomationPeer.IsOffscreenCore()

IsPasswordCore()

Returns a value that indicates whether the item element that is associated with this ItemAutomationPeer contains protected content. This method is called by IsPassword().

Declaration

protected override bool IsPasswordCore()

Returns

Type	Description
System.Boolean	true if the item element contains sensitive content; otherwise, false.

Overrides

FrameworkElementAutomationPeer.IsPasswordCore()

IsRequiredForFormCore()

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

Declaration

protected override bool IsRequiredForFormCore()

Returns

Type	Description
System.Boolean	The value that is returned by GetIsRequiredForForm(DependencyObject), if the value is set; otherwise, false.

Overrides

FrameworkElementAutomationPeer.IsRequiredForFormCore()

SetFocusCore()

Sets the keyboard input focus on the item element that is associated with this FrameworkElementAutomationPeer. This method is called by SetFocus().

Declaration

protected override void SetFocusCore()

Overrides

FrameworkElementAutomationPeer.SetFocusCore()

Extension Methods

DependencyObjectHelper.GetSelfAndAncestors(DependencyObject)

VisualTreeExtensions.GetVisualAncestors(DependencyObject)

VisualTreeExtensions.GetVisualAncestorsAndSelf(DependencyObject)

VisualTreeExtensions.GetVisualChildren(DependencyObject)

VisualTreeExtensions.GetVisualChildrenAndSelf(DependencyObject)

VisualTreeExtensions.GetVisualDescendants(DependencyObject)

VisualTreeExtensions.GetVisualDescendantsAndSelf(DependencyObject)

VisualTreeExtensions.GetVisualSiblings(DependencyObject)

VisualTreeExtensions.GetVisualSiblingsAndSelf(DependencyObject)