DataGridAutomationPeer Class

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

Exposes DataGrid types to UI automation.

Inheritance Hierarchy

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

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

Syntax

'Declaration
Public Class DataGridAutomationPeer _
    Inherits FrameworkElementAutomationPeer _
    Implements IScrollProvider, ISelectionProvider, ITableProvider, IGridProvider

public class DataGridAutomationPeer : FrameworkElementAutomationPeer, 
    IScrollProvider, ISelectionProvider, ITableProvider, IGridProvider

The DataGridAutomationPeer type exposes the following members.

Constructors

	Name	Description
	DataGridAutomationPeer	Initializes a new instance of the DataGridAutomationPeer class.

Top

Properties

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

Top

Methods

	Name	Description
	CheckAccess	Determines whether the calling thread has access to this object. (Inherited from DependencyObject.)
	ClearValue	Clears the local value of a dependency property. (Inherited from DependencyObject.)
	Equals(Object)	Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
	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.)
	GetAcceleratorKey	Gets the accelerator key combination for the object that is associated with the UI Automation peer. (Inherited from AutomationPeer.)
	GetAcceleratorKeyCore	Returns the accelerator key for the UIElement that is associated with this FrameworkElementAutomationPeer. This method is called by GetAcceleratorKey. (Inherited from FrameworkElementAutomationPeer.)
	GetAccessKey	Gets the access key for the object that is associated with the automation peer. (Inherited from AutomationPeer.)
	GetAccessKeyCore	Returns the access key for the UIElement that is associated with this FrameworkElementAutomationPeer. This method is called by GetAccessKey. (Inherited from FrameworkElementAutomationPeer.)
	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.)
	GetAutomationControlType	Gets the control type for the object that is associated with the UI Automation peer. (Inherited from AutomationPeer.)
	GetAutomationControlTypeCore	Gets the AutomationControlType for the element associated with this DataGridAutomationPeer. Called by GetAutomationControlType. (Overrides FrameworkElementAutomationPeer.GetAutomationControlTypeCore().)
	GetAutomationId	Gets the AutomationId of the object that is associated with the automation peer. (Inherited from AutomationPeer.)
	GetAutomationIdCore	Returns the string that uniquely identifies the FrameworkElement that is associated with this FrameworkElementAutomationPeer. This method is called by GetAutomationId. (Inherited from FrameworkElementAutomationPeer.)
	GetBoundingRectangle	Gets the Rect object that represents the screen coordinates of the element that is associated with the automation peer. (Inherited from AutomationPeer.)
	GetBoundingRectangleCore	Returns the Rect that represents the bounding rectangle of the UIElement that is associated with this FrameworkElementAutomationPeer. This method is called by GetBoundingRectangle. (Inherited from FrameworkElementAutomationPeer.)
	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	Gets automation peers for the collection of child elements of the element associated with this DataGridAutomationPeer. This method is called by GetChildren. (Overrides FrameworkElementAutomationPeer.GetChildrenCore().)
	GetClassName	Gets the name of the control class that is associated with the peer. (Inherited from AutomationPeer.)
	GetClassNameCore	Gets the name of the class associated with this DataGridAutomationPeer. Called by GetClassName. (Overrides FrameworkElementAutomationPeer.GetClassNameCore().)
	GetClickablePoint	Gets a Point on the object that is associated with the automation peer that responds to a mouse click. (Inherited from AutomationPeer.)
	GetClickablePointCore	Returns a Point that represents the clickable space that is on the UIElement that is associated with this FrameworkElementAutomationPeer. This method is called by GetClickablePoint. (Inherited from FrameworkElementAutomationPeer.)
	GetHashCode	Serves as a hash function for a particular type. (Inherited from Object.)
	GetHelpText	Gets text that describes the functionality of the control that is associated with the automation peer. (Inherited from AutomationPeer.)
	GetHelpTextCore	Returns the string that describes the functionality of the FrameworkElement that is associated with this FrameworkElementAutomationPeer. This method is called by GetHelpText. (Inherited from FrameworkElementAutomationPeer.)
	GetItemStatus	Gets text that conveys the visual status of the object that is associated with this automation peer. (Inherited from AutomationPeer.)
	GetItemStatusCore	Returns a string that communicates the visual status of the UIElement that is associated with this FrameworkElementAutomationPeer. This method is called by GetItemStatus. (Inherited from FrameworkElementAutomationPeer.)
	GetItemType	Gets a string that describes what kind of item an element represents. (Inherited from AutomationPeer.)
	GetItemTypeCore	Returns a human-readable string that contains the item type that the UIElement for this FrameworkElementAutomationPeer represents. This method is called by GetItemType. (Inherited from FrameworkElementAutomationPeer.)
	GetLabeledBy	Gets the AutomationPeer for the UIElement that is targeted to the element. (Inherited from AutomationPeer.)
	GetLabeledByCore	Returns the AutomationPeer for the UIElement that targets the FrameworkElement that is associated with this FrameworkElementAutomationPeer. This method is called by GetLabeledBy. (Inherited from FrameworkElementAutomationPeer.)
	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.)
	GetLocalizedControlTypeCore	Returns a localized human-readable string that identifies a control type. The control type is for the owner type that is associated with this FrameworkElementAutomationPeer. This method is called by GetLocalizedControlType. (Inherited from FrameworkElementAutomationPeer.)
	GetName	Gets the value that the automation peer reports as the UI Automation Name for the associated control. (Inherited from AutomationPeer.)
	GetNameCore	Gets the UI Automation Name from the element associated with this DataGridAutomationPeer. Called by GetName. (Overrides FrameworkElementAutomationPeer.GetNameCore().)
	GetOrientation	Gets a value that indicates the explicit control orientation, if any. (Inherited from AutomationPeer.)
	GetOrientationCore	Returns a value that indicates whether the element that is associated with this FrameworkElementAutomationPeer is laid out in a specific direction. This method is called by GetOrientation. (Inherited from FrameworkElementAutomationPeer.)
	GetParent	Gets the AutomationPeer that is the parent of this AutomationPeer. (Inherited from AutomationPeer.)
	GetPattern	Gets an object that supports the requested pattern, based on the patterns supported by this DataGridAutomationPeer. (Overrides FrameworkElementAutomationPeer.GetPattern(PatternInterface).)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	GetValue	Returns the current effective value of a dependency property from a DependencyObject. (Inherited from DependencyObject.)
	HasKeyboardFocus	Gets a value that indicates whether the object that is associated with this automation peer currently has keyboard focus. (Inherited from AutomationPeer.)
	HasKeyboardFocusCore	Returns a value that indicates whether the UIElement that is associated with this FrameworkElementAutomationPeer currently has keyboard input focus. This method is called by HasKeyboardFocus. (Inherited from FrameworkElementAutomationPeer.)
	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 object that is associated with this automation peer contains data that is presented to the user. (Inherited from AutomationPeer.)
	IsContentElementCore	Returns a value that indicates whether the element that is associated with this FrameworkElementAutomationPeer is an element that contains data that is presented to the user. This method is called by IsContentElement. (Inherited from FrameworkElementAutomationPeer.)
	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	Returns a value that indicates whether the object that is associated with this FrameworkElementAutomationPeer is understood by the end user as interactive. Optionally, the user might understand the object as contributing to the logical structure of the control in the GUI. This method is called by IsControlElement. (Inherited from FrameworkElementAutomationPeer.)
	IsEnabled	Gets a value that indicates whether the element associated with this automation peer supports interaction. (Inherited from AutomationPeer.)
	IsEnabledCore	Returns a value that indicates whether the UIElement that is associated with this FrameworkElementAutomationPeer is enabled. This method is called by IsEnabled. (Inherited from FrameworkElementAutomationPeer.)
	IsKeyboardFocusable	Gets a value that indicates whether the element can accept keyboard focus. (Inherited from AutomationPeer.)
	IsKeyboardFocusableCore	Returns a value that indicates whether the element that is associated with this FrameworkElementAutomationPeer can accept keyboard focus. This method is called by IsKeyboardFocusable. (Inherited from FrameworkElementAutomationPeer.)
	IsOffscreen	Gets a value that indicates whether an element is off the screen. (Inherited from AutomationPeer.)
	IsOffscreenCore	Returns a value that indicates whether the UIElement that is associated with this FrameworkElementAutomationPeer is off the screen. This method is called by IsOffscreen. (Inherited from FrameworkElementAutomationPeer.)
	IsPassword	Gets a value that indicates whether the element contains sensitive content. (Inherited from AutomationPeer.)
	IsPasswordCore	Returns a value that indicates whether the element that is associated with this FrameworkElementAutomationPeer contains protected content. This method is called by IsPassword. (Inherited from FrameworkElementAutomationPeer.)
	IsRequiredForForm	Gets a value that indicates whether the object that is associated with this peer must be completed on a form. (Inherited from AutomationPeer.)
	IsRequiredForFormCore	Returns a value that indicates whether the element that is associated with this FrameworkElementAutomationPeer is required to be completed on a form. This method is called by IsRequiredForForm. (Inherited from FrameworkElementAutomationPeer.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	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 object that is associated with this automation peer. (Inherited from AutomationPeer.)
	SetFocusCore	Sets the keyboard input focus on the element that is associated with this FrameworkElementAutomationPeer. This method is called by SetFocus. (Inherited from FrameworkElementAutomationPeer.)
	SetValue	Sets the local value of a dependency property on a DependencyObject. (Inherited from DependencyObject.)
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Top

Explicit Interface Implementations

	Name	Description
	IGridProvider.ColumnCount	Infrastructure. For a description of this member, see IGridProvider.ColumnCount.
	IGridProvider.GetItem	Infrastructure. For a description of this member, see IGridProvider.GetItem.
	IGridProvider.RowCount	Infrastructure. For a description of this member, see IGridProvider.RowCount.
	IScrollProvider.HorizontallyScrollable	Infrastructure. For a description of this member, see IScrollProvider.HorizontallyScrollable.
	IScrollProvider.HorizontalScrollPercent	Infrastructure. For a description of this member, see IScrollProvider.HorizontalScrollPercent.
	IScrollProvider.HorizontalViewSize	Infrastructure. For a description of this member, see IScrollProvider.HorizontalViewSize.
	IScrollProvider.Scroll	Infrastructure. For a description of this member, see IScrollProvider.Scroll.
	IScrollProvider.SetScrollPercent	Infrastructure. For a description of this member, see IScrollProvider.SetScrollPercent.
	IScrollProvider.VerticallyScrollable	Infrastructure. For a description of this member, see IScrollProvider.VerticallyScrollable.
	IScrollProvider.VerticalScrollPercent	Infrastructure. For a description of this member, see IScrollProvider.VerticalScrollPercent.
	IScrollProvider.VerticalViewSize	Infrastructure. For a description of this member, see IScrollProvider.VerticalViewSize.
	ISelectionProvider.CanSelectMultiple	Infrastructure. For a description of this member, see ISelectionProvider.CanSelectMultiple.
	ISelectionProvider.GetSelection	Infrastructure. For a description of this member, see ISelectionProvider.GetSelection.
	ISelectionProvider.IsSelectionRequired	Infrastructure. For a description of this member, see ISelectionProvider.IsSelectionRequired.
	ITableProvider.GetColumnHeaders	Infrastructure. For a description of this member, see ITableProvider.GetColumnHeaders.
	ITableProvider.GetRowHeaders	Infrastructure. For a description of this member, see ITableProvider.GetRowHeaders.
	ITableProvider.RowOrColumnMajor	Infrastructure. For a description of this member, see ITableProvider.RowOrColumnMajor.

Top

Remarks

Automation Patterns

This automation peer implements the following pattern interfaces: IScrollProvider, ISelectionProvider, ITableProvider, IGridProvider.

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.

See Also

Reference

System.Windows.Automation.Peers Namespace

Other Resources

UI Automation of a Silverlight Custom Control