GridViewItemAutomationPeer class
Exposes a GridViewItem to Microsoft UI Automation.
Inheritance
- Object
- DependencyObject
- AutomationPeer
- FrameworkElementAutomationPeer
- GridViewItemAutomationPeer
Syntax
Attributes
- MarshalingBehaviorAttribute(Agile)
- ThreadingAttribute(Both)
- VersionAttribute(NTDDI_WIN8)
- WebHostHiddenAttribute()
Members
The GridViewItemAutomationPeer class has these types of members:
Constructors
The GridViewItemAutomationPeer class has these constructors.
| Constructor | Description |
|---|---|
| GridViewItemAutomationPeer | Initializes a new instance of the GridViewItemAutomationPeer class. |
Methods
The GridViewItemAutomationPeer class has these methods. It also inherits methods from the Object class.
| Method | Description |
|---|---|
| ClearValue | Clears the local value of a dependency property. (Inherited from DependencyObject) |
| GetAcceleratorKey | Gets the accelerator key combinations for the object that is associated with the UI Automation peer. (Inherited from AutomationPeer) |
| GetAcceleratorKeyCore | Provides the peer's behavior when a Microsoft UI Automation client calls GetAcceleratorKey or an equivalent Microsoft UI Automation client API. (Inherited from AutomationPeer) |
| GetAccessKey | Gets the access key for the element that is associated with the automation peer. (Inherited from AutomationPeer) |
| GetAccessKeyCore | Provides the peer's behavior when a Microsoft UI Automation client calls GetAccessKey or an equivalent Microsoft UI Automation client API. (Inherited from AutomationPeer) |
| GetAnimationBaseValue | Returns any base value established for a dependency property, which would apply in cases where an animation is not active. (Inherited from DependencyObject) |
| GetAutomationControlType | Gets the control type for the element that is associated with the UI Automation peer. (Inherited from AutomationPeer) |
| GetAutomationControlTypeCore | Provides the peer's behavior when a Microsoft UI Automation client calls GetAutomationControlType or an equivalent Microsoft UI Automation client API. (Inherited from AutomationPeer) |
| GetAutomationId | Gets the AutomationId of the element that is associated with the automation peer. (Inherited from AutomationPeer) |
| GetAutomationIdCore | Provides the peer's behavior when a Microsoft UI Automation client calls GetAutomationId or an equivalent Microsoft UI Automation client API. (Inherited from AutomationPeer) |
| GetBoundingRectangle | Gets the Rect object that represents the screen coordinates of the element that is associated with the automation peer. (Inherited from AutomationPeer) |
| GetBoundingRectangleCore | Provides the peer's behavior when a Microsoft UI Automation client calls GetBoundingRectangle or an equivalent Microsoft UI Automation client API. (Inherited from AutomationPeer) |
| GetChildren | Gets the collection of child elements that are represented in the UI Automation tree as immediate child elements of the automation peer. (Inherited from AutomationPeer) |
| GetChildrenCore | Provides the peer's behavior when a Microsoft UI Automation client calls GetChildren or an equivalent Microsoft UI Automation client API. (Inherited from AutomationPeer) |
| GetClassName | Gets a name that is used with AutomationControlType, to differentiate the control that is represented by this AutomationPeer. (Inherited from AutomationPeer) |
| GetClassNameCore | Provides the peer's behavior when a Microsoft UI Automation client calls GetClassName or an equivalent Microsoft UI Automation client API. (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 | Provides the peer's behavior when a Microsoft UI Automation client calls GetClickablePoint or an equivalent Microsoft UI Automation client API. (Inherited from AutomationPeer) |
| GetHelpText | Gets text that describes the functionality of the control that is associated with the automation peer. (Inherited from AutomationPeer) |
| GetHelpTextCore | Provides the peer's behavior when a Microsoft UI Automation client calls GetHelpText or an equivalent Microsoft UI Automation client API. (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 | Provides the peer's behavior when a Microsoft UI Automation client calls GetItemStatus or an equivalent Microsoft UI Automation client API. (Inherited from AutomationPeer) |
| GetItemType | Gets a string that describes what kind of item an element represents. (Inherited from AutomationPeer) |
| GetItemTypeCore | Provides the peer's behavior when a Microsoft UI Automation client calls GetItemType or an equivalent Microsoft UI Automation client API. (Inherited from AutomationPeer) |
| GetLabeledBy | Gets the AutomationPeer for the UIElement that is targeted to the element. (Inherited from AutomationPeer) |
| GetLabeledByCore | Provides the peer's behavior when a Microsoft UI Automation client calls GetLabeledBy or an equivalent Microsoft UI Automation client API. (Inherited from AutomationPeer) |
| GetLiveSetting | Gets the live setting notification behavior information for the object that is associated with the UI Automation peer. (Inherited from AutomationPeer) |
| GetLiveSettingCore | Provides the peer's behavior when a Microsoft UI Automation client calls GetLiveSetting or an equivalent Microsoft UI Automation client API. (Inherited from AutomationPeer) |
| GetLocalizedControlType | Gets a localized string that represents the AutomationControlType value for the control that is associated with this automation peer. (Inherited from AutomationPeer) |
| GetLocalizedControlTypeCore | Provides the peer's behavior when a Microsoft UI Automation client calls GetLocalizedControlType or an equivalent Microsoft UI Automation client API. (Inherited from AutomationPeer) |
| GetName | Gets text that describes the element that is associated with this automation peer. The Microsoft UI Automation Name value is the primary identifier used by most assistive technology when they represent your app's UI by interacting with the Microsoft UI Automation framework. (Inherited from AutomationPeer) |
| GetNameCore | Provides the peer's behavior when a Microsoft UI Automation client calls GetName or an equivalent Microsoft UI Automation client API. (Inherited from AutomationPeer) |
| GetOrientation | Gets a value that indicates the explicit control orientation, if any. (Inherited from AutomationPeer) |
| GetOrientationCore | Provides the peer's behavior when a Microsoft UI Automation client calls GetOrientation or an equivalent Microsoft UI Automation client API. (Inherited from AutomationPeer) |
| GetParent | Gets the AutomationPeer that is the parent of this AutomationPeer. (Inherited from AutomationPeer) |
| GetPattern | Gets the control pattern that is associated with the specified PatternInterface. (Inherited from AutomationPeer) |
| GetPatternCore | Provides the peer's behavior when a Microsoft UI Automation client calls GetPattern or an equivalent Microsoft UI Automation client API. (Inherited from AutomationPeer) |
| GetPeerFromPoint | Gets an AutomationPeer from the specified point. (Inherited from AutomationPeer) |
| GetPeerFromPointCore | Provides the peer's behavior when a Microsoft UI Automation client calls GetPeerFromPoint or an equivalent Microsoft UI Automation client API. (Inherited from AutomationPeer) |
| GetValue | Returns the current effective value of a dependency property from a DependencyObject. (Inherited from DependencyObject) |
| HasKeyboardFocus | Gets a value that indicates whether the element that is associated with this automation peer currently has keyboard focus. (Inherited from AutomationPeer) |
| HasKeyboardFocusCore | Provides the peer's behavior when a Microsoft UI Automation client calls HasKeyboardFocus or an equivalent Microsoft UI Automation client API. (Inherited from AutomationPeer) |
| InvalidatePeer | Triggers 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) |
| 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 | Provides the peer's behavior when a Microsoft UI Automation client calls IsContentElement or an equivalent Microsoft UI Automation client API. (Inherited from AutomationPeer) |
| 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 | Provides the peer's behavior when a Microsoft UI Automation client calls IsControlElement or an equivalent Microsoft UI Automation client API. (Inherited from AutomationPeer) |
| IsEnabled | Gets a value that indicates whether the element associated with this automation peer supports interaction. (Inherited from AutomationPeer) |
| IsEnabledCore | Provides the peer's behavior when a Microsoft UI Automation client calls IsEnabled or an equivalent Microsoft UI Automation client API. (Inherited from AutomationPeer) |
| IsKeyboardFocusable | Gets a value that indicates whether the element can accept keyboard focus. (Inherited from AutomationPeer) |
| IsKeyboardFocusableCore | Provides the peer's behavior when a Microsoft UI Automation client calls IsKeyboardFocusable or an equivalent Microsoft UI Automation client API. (Inherited from AutomationPeer) |
| IsOffscreen | Gets a value that indicates whether an element is off the screen. (Inherited from AutomationPeer) |
| IsOffscreenCore | Provides the peer's behavior when a Microsoft UI Automation client calls IsOffscreen or an equivalent Microsoft UI Automation client API. (Inherited from AutomationPeer) |
| IsPassword | Gets a value that indicates whether the element contains sensitive content. (Inherited from AutomationPeer) |
| IsPasswordCore | Provides the peer's behavior when a Microsoft UI Automation client calls IsPassword or an equivalent Microsoft UI Automation client API. (Inherited from AutomationPeer) |
| 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 | Provides the peer's behavior when a Microsoft UI Automation client calls IsRequiredForForm or an equivalent Microsoft UI Automation client API. (Inherited from AutomationPeer) |
| PeerFromProvider | Gets an AutomationPeer for the specified IRawElementProviderSimple proxy. (Inherited from AutomationPeer) |
| ProviderFromPeer | Gets the IRawElementProviderSimple proxy for the specified AutomationPeer. (Inherited from AutomationPeer) |
| RaiseAutomationEvent | Raises an automation event. (Inherited from AutomationPeer) |
| RaisePropertyChangedEvent | Raises an event to notify the automation client of a changed property value. (Inherited from AutomationPeer) |
| ReadLocalValue | Returns the local value of a dependency property, if a local value is set. (Inherited from DependencyObject) |
| SetFocus | Sets the keyboard focus on the element that is associated with this automation peer. (Inherited from AutomationPeer) |
| SetFocusCore | Provides the peer's behavior when a Microsoft UI Automation client calls SetFocus or an equivalent Microsoft UI Automation client API. (Inherited from AutomationPeer) |
| SetValue | Sets the local value of a dependency property on a DependencyObject. (Inherited from DependencyObject) |
Properties
The GridViewItemAutomationPeer class has these properties.
| Property | Access type | Description |
|---|---|---|
| Read-only | Gets the CoreDispatcher that this object is associated with. (Inherited from DependencyObject) | |
| Read/write | Gets or sets an AutomationPeer that is reported to the automation client as the source for all the events that come from this AutomationPeer. See Remarks. (Inherited from AutomationPeer) | |
| Read-only | Gets the UIElement owner that is associated with this FrameworkElementAutomationPeer. (Inherited from FrameworkElementAutomationPeer) |
Remarks
The Windows Runtime GridViewItem class creates a new GridViewItemAutomationPeer as its OnCreateAutomationPeer definition. Derive your automation peer from GridViewItemAutomationPeer if you are deriving a custom class from GridViewItem 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.
Default peer implementation and overrides in GridViewItemAutomationPeer
GridViewItemAutomationPeer has overrides of Core methods such that the associated AutomationPeer methods provide peer-specific information to a UI Automation client.
-
GetPattern defers to base peers. GetPattern returns a pattern for IDragProvider though an internal base class. The content of the GridViewItem might also have a specific peer, for example if it is a TextBox. The parent GridView has the support for any selection-related automation behavior.
- GetClassName returns "GridViewItem".
- GetAutomationControlType returns AutomationControlType.ListItem.
The peer also has other behaviors that are provided by the base FrameworkElementAutomationPeer class. For more info, see "Base implementation in FrameworkElementAutomationPeer" section of Custom automation peers.
Requirements
|
Minimum supported client | Windows 8 [Windows Store apps only] |
|---|---|
|
Minimum supported server | Windows Server 2012 [Windows Store apps only] |
|
Namespace |
|
|
Metadata |
|
See also
- FrameworkElementAutomationPeer
- GridView
- GridViewItemDataAutomationPeer
- GridViewItem
- Custom automation peers
Build date: 12/4/2012
