Share via

  • Article

DataGridGroupItemAutomationPeer Class

Microsoft Silverlight will reach end of support after October 2021. Learn more.

Exposes the groups of items in CollectionViewGroup views of a DataGrid to UI automation.

Inheritance Hierarchy

System.Object
  System.Windows.DependencyObject
    System.Windows.Automation.Peers.AutomationPeer
      System.Windows.Automation.Peers.FrameworkElementAutomationPeer
        System.Windows.Automation.Peers.DataGridGroupItemAutomationPeer

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

Syntax

'Declaration
Public Class DataGridGroupItemAutomationPeer _
    Inherits FrameworkElementAutomationPeer _
    Implements IExpandCollapseProvider, IGridProvider, IScrollItemProvider, ISelectionProvider

public class DataGridGroupItemAutomationPeer : FrameworkElementAutomationPeer, 
    IExpandCollapseProvider, IGridProvider, IScrollItemProvider, ISelectionProvider

The DataGridGroupItemAutomationPeer type exposes the following members.

Constructors

  Name Description
Public method DataGridGroupItemAutomationPeer Initializes a new instance of the DataGridGroupItemAutomationPeer class.

Top

Properties

  Name Description
Public property Dispatcher Gets the Dispatcher this object is associated with. (Inherited from DependencyObject.)
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.)
Public property Owner Gets the UIElement that is associated with this FrameworkElementAutomationPeer. (Inherited from FrameworkElementAutomationPeer.)

Top

Methods

  Name Description
Public method CheckAccess Determines whether the calling thread has access to this object. (Inherited from DependencyObject.)
Public method ClearValue Clears the local value of a dependency property. (Inherited from DependencyObject.)
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 the Object is reclaimed by garbage collection. (Inherited from Object.)
Public method GetAcceleratorKey Gets the accelerator key combination for the object that is associated with the UI Automation peer. (Inherited from AutomationPeer.)
Protected method GetAcceleratorKeyCore Retrieves the accelerator key combinations for the item group. (Overrides FrameworkElementAutomationPeer.GetAcceleratorKeyCore().)
Public method GetAccessKey Gets the access key for the object that is associated with the automation peer. (Inherited from AutomationPeer.)
Protected method GetAccessKeyCore Retrieves the access key for the item group. (Overrides FrameworkElementAutomationPeer.GetAccessKeyCore().)
Public method GetAnimationBaseValue Returns any base value established for a Silverlight dependency property, which would apply in cases where an animation is not active. (Inherited from DependencyObject.)
Public method GetAutomationControlType Gets the control type for the object that is associated with the UI Automation peer. (Inherited from AutomationPeer.)
Protected method GetAutomationControlTypeCore Retrieves the AutomationControlType for the item group associated with this DataGridGroupItemAutomationPeer. Called by GetAutomationControlType. (Overrides FrameworkElementAutomationPeer.GetAutomationControlTypeCore().)
Public method GetAutomationId Gets the AutomationId of the object that is associated with the automation peer. (Inherited from AutomationPeer.)
Protected method GetAutomationIdCore Retrieves the string that uniquely identifies the group of items to UI automation. (Overrides FrameworkElementAutomationPeer.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 Retrieves the object that represents the bounding box in screen coordinates of the group of items. (Overrides FrameworkElementAutomationPeer.GetBoundingRectangleCore().)
Public method 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.)
Protected method GetChildrenCore Retrieves automation peers for the collection of child elements that are represented in the UI automation tree as immediate child elements of the automation peer. (Overrides FrameworkElementAutomationPeer.GetChildrenCore().)
Public method GetClassName Gets the name of the control class that is associated with the peer. (Inherited from AutomationPeer.)
Protected method GetClassNameCore Gets the name of the class that is associated with this DataGridGroupItemAutomationPeer. Called by GetClassName. (Overrides FrameworkElementAutomationPeer.GetClassNameCore().)
Public method GetClickablePoint Gets a Point on the object that is associated with the automation peer that responds to a mouse click. (Inherited from AutomationPeer.)
Protected method GetClickablePointCore Retrieves the point on the group of items that responds to a mouse click. (Overrides FrameworkElementAutomationPeer.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 Retrieves text that describes the functionality of the group of items. (Overrides FrameworkElementAutomationPeer.GetHelpTextCore().)
Public method GetItemStatus Gets text that conveys the visual status of the object that is associated with this automation peer. (Inherited from AutomationPeer.)
Protected method GetItemStatusCore Retrieves text that conveys the visual status of the group of items. (Overrides FrameworkElementAutomationPeer.GetItemStatusCore().)
Public method GetItemType Gets a string that describes what kind of item an element represents. (Inherited from AutomationPeer.)
Protected method GetItemTypeCore Retrieves a value that describes what kind of item the group of items represents. (Overrides FrameworkElementAutomationPeer.GetItemTypeCore().)
Public method GetLabeledBy Gets the AutomationPeer for the UIElement that is targeted to the element. (Inherited from AutomationPeer.)
Protected method GetLabeledByCore Retrieves the automation peer for the element designated as the label for the group of items. (Overrides FrameworkElementAutomationPeer.GetLabeledByCore().)
Public method GetLocalizedControlType Gets 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 method GetLocalizedControlTypeCore Retrieves a localized string that represents the AutomationControlType for the group of items. (Overrides FrameworkElementAutomationPeer.GetLocalizedControlTypeCore().)
Public method GetName Gets the value that the automation peer reports as the UI Automation Name for the associated control. (Inherited from AutomationPeer.)
Protected method GetNameCore Gets the UI Automation Name of the data grid item that is associated with this DataGridGroupItemAutomationPeer. Called by GetName. (Overrides FrameworkElementAutomationPeer.GetNameCore().)
Public method GetOrientation Gets a value that indicates the explicit control orientation, if any. (Inherited from AutomationPeer.)
Protected method GetOrientationCore Retrieves a value that indicates the explicit control orientation, if any. (Overrides FrameworkElementAutomationPeer.GetOrientationCore().)
Public method GetParent Gets the AutomationPeer that is the parent of this AutomationPeer. (Inherited from AutomationPeer.)
Public method GetPattern Gets an object that supports the requested pattern, based on the patterns supported by this DataGridGroupItemAutomationPeer. (Overrides FrameworkElementAutomationPeer.GetPattern(PatternInterface).)
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Public method GetValue Returns the current effective value of a dependency property from a DependencyObject. (Inherited from DependencyObject.)
Public method HasKeyboardFocus Gets a value that indicates whether the object that is associated with this automation peer currently has keyboard focus. (Inherited from AutomationPeer.)
Protected method HasKeyboardFocusCore Retrieves a value that indicates whether the group of items currently has keyboard focus. (Overrides FrameworkElementAutomationPeer.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 have changed. (Inherited from AutomationPeer.)
Public method IsContentElement Gets 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 method IsContentElementCore Retrieves a value that indicates whether the group of items contains data that is presented to the user. (Overrides FrameworkElementAutomationPeer.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 Retrieves a value that indicates whether the group of items is understood by the user as interactive, or as contributing to the logical structure of the UI. (Overrides FrameworkElementAutomationPeer.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 Retrieves a value that indicates whether the group of items supports interaction. (Overrides FrameworkElementAutomationPeer.IsEnabledCore().)
Public method IsKeyboardFocusable Gets a value that indicates whether the element can accept keyboard focus. (Inherited from AutomationPeer.)
Protected method IsKeyboardFocusableCore Retrieves a value that indicates whether the group of items can accept keyboard focus. (Overrides FrameworkElementAutomationPeer.IsKeyboardFocusableCore().)
Public method IsOffscreen Gets a value that indicates whether an element is off the screen. (Inherited from AutomationPeer.)
Protected method IsOffscreenCore Retrieves a value that indicates whether the data grid item is off the screen. (Overrides FrameworkElementAutomationPeer.IsOffscreenCore().)
Public method IsPassword Gets a value that indicates whether the element contains sensitive content. (Inherited from AutomationPeer.)
Protected method IsPasswordCore Retrieves a value that indicates whether the group of items contains sensitive content. (Overrides FrameworkElementAutomationPeer.IsPasswordCore().)
Public method IsRequiredForForm Gets a value that indicates whether the object that is associated with this peer must be completed on a form. (Inherited from AutomationPeer.)
Protected method IsRequiredForFormCore Retrieves a value that indicates whether the group of items must be completed on a form. (Overrides FrameworkElementAutomationPeer.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 proxy for the specified AutomationPeer. (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 ReadLocalValue Returns the local value of a dependency property, if a local value is set. (Inherited from DependencyObject.)
Public method SetFocus Sets the keyboard focus on the object that is associated with this automation peer. (Inherited from AutomationPeer.)
Protected method SetFocusCore Sets the keyboard focus on the data grid item. (Overrides FrameworkElementAutomationPeer.SetFocusCore().)
Public method SetValue Sets the local value of a dependency property on a DependencyObject. (Inherited from DependencyObject.)
Public method ToString Returns a string that represents the current object. (Inherited from Object.)

Top

Explicit Interface Implementations

  Name Description
Explicit interface implemetationPrivate method IExpandCollapseProvider.Collapse Infrastructure. For a description of this member, see IExpandCollapseProvider.Collapse.
Explicit interface implemetationPrivate method IExpandCollapseProvider.Expand Infrastructure. For a description of this member, see IExpandCollapseProvider.Expand.
Explicit interface implemetationPrivate property IExpandCollapseProvider.ExpandCollapseState Infrastructure. For a description of this member, see IExpandCollapseProvider.ExpandCollapseState.
Explicit interface implemetationPrivate property IGridProvider.ColumnCount Infrastructure. For a description of this member, see IGridProvider.ColumnCount.
Explicit interface implemetationPrivate method IGridProvider.GetItem Infrastructure. For a description of this member, see IGridProvider.GetItem.
Explicit interface implemetationPrivate property IGridProvider.RowCount Infrastructure. For a description of this member, see IGridProvider.RowCount.
Explicit interface implemetationPrivate method IScrollItemProvider.ScrollIntoView Infrastructure. For a description of this member, see IScrollItemProvider.ScrollIntoView.
Explicit interface implemetationPrivate property ISelectionProvider.CanSelectMultiple Infrastructure. For a description of this member, see ISelectionProvider.CanSelectMultiple.
Explicit interface implemetationPrivate method ISelectionProvider.GetSelection Infrastructure. For a description of this member, see ISelectionProvider.GetSelection.
Explicit interface implemetationPrivate property ISelectionProvider.IsSelectionRequired Infrastructure. For a description of this member, see ISelectionProvider.IsSelectionRequired.

Top

Remarks

Automation Patterns

This automation peer implements the following pattern interfaces: IExpandCollapseProvider, IGridProvider, IScrollItemProvider, ISelectionProvider.

Notes to Inheritors

The FrameworkElementAutomationPeer overrides in DataGridGroupItemAutomationPeer follow a pattern of returning results based on a row header group owner if one exists, and otherwise returning defaults such as String.Empty or null.

Version Information

Silverlight

Supported in: 5, 4, 3

Platforms

For a list of the operating systems and browsers that are supported by Silverlight, see Supported Operating Systems and Browsers.

Thread Safety

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