RibbonGroupDataAutomationPeer Class

Article
02/04/2013

Exposes RibbonGroup types to UI Automation.

Inheritance Hierarchy

System.Object
  System.Windows.Threading.DispatcherObject
    System.Windows.Automation.Peers.AutomationPeer
      System.Windows.Automation.Peers.ItemAutomationPeer
        Microsoft.Windows.Automation.Peers.RibbonGroupDataAutomationPeer

Namespace: Microsoft.Windows.Automation.Peers
Assembly: RibbonControlsLibrary (in RibbonControlsLibrary.dll)

Syntax

'Declaration
Public Class RibbonGroupDataAutomationPeer _
    Inherits ItemAutomationPeer _
    Implements IScrollItemProvider, IExpandCollapseProvider

public class RibbonGroupDataAutomationPeer : ItemAutomationPeer, 
    IScrollItemProvider, IExpandCollapseProvider

public ref class RibbonGroupDataAutomationPeer : public ItemAutomationPeer, 
    IScrollItemProvider, IExpandCollapseProvider

type RibbonGroupDataAutomationPeer =  
    class
        inherit ItemAutomationPeer
        interface IScrollItemProvider
        interface IExpandCollapseProvider
    end

public class RibbonGroupDataAutomationPeer extends ItemAutomationPeer implements IScrollItemProvider, IExpandCollapseProvider

The RibbonGroupDataAutomationPeer type exposes the following members.

Constructors

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

Top

Properties

	Name	Description
	Dispatcher	Gets the Dispatcher this DispatcherObject is associated with. (Inherited from DispatcherObject.)
	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.)
	IsHwndHost	Gets a value that indicates whether the element that is associated with this AutomationPeer hosts hwnds in Windows Presentation Foundation (WPF). (Inherited from AutomationPeer.)
	Item	Gets the data item in the Items collection that is associated with this ItemAutomationPeer. (Inherited from ItemAutomationPeer.)
	ItemsControlAutomationPeer	Gets the ItemsControlAutomationPeer that is associated with the ItemsControl that holds the Items collection. (Inherited from ItemAutomationPeer.)

Top

Methods

	Name	Description
	CheckAccess	Determines whether the calling thread has access to this DispatcherObject. (Inherited from DispatcherObject.)
	Equals	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 it is reclaimed by garbage collection. (Inherited from Object.)
	GetAcceleratorKey	Gets the accelerator key combinations for the element that is associated with the UI Automation peer. (Inherited from AutomationPeer.)
	GetAcceleratorKeyCore	Gets the accelerator key for the UIElement that corresponds to the data item in the Items collection that is associated with this ItemAutomationPeer. (Inherited from ItemAutomationPeer.)
	GetAccessKey	Gets the access key for the element that is associated with the automation peer. (Inherited from AutomationPeer.)
	GetAccessKeyCore	Gets the access key for the UIElement that corresponds to the data item in the Items collection that is associated with this ItemAutomationPeer. (Inherited from ItemAutomationPeer.)
	GetAutomationControlType	Gets the control type for the element that is associated with the UI Automation peer. (Inherited from AutomationPeer.)
	GetAutomationControlTypeCore	Gets the control type for the RibbonGroup that is associated with this RibbonGroupDataAutomationPeer. This method is called by GetAutomationControlType. (Overrides AutomationPeer.GetAutomationControlTypeCore().)
	GetAutomationId	Gets the AutomationId of the element that is associated with the automation peer. (Inherited from AutomationPeer.)
	GetAutomationIdCore	Gets the string that uniquely identifies the UIElement that corresponds to the data item in the Items collection that is associated with this ItemAutomationPeer. (Inherited from ItemAutomationPeer.)
	GetBoundingRectangle	Gets the Rect object that represents the screen coordinates of the element that is associated with the automation peer. (Inherited from AutomationPeer.)
	GetBoundingRectangleCore	Gets the Rect that represents the bounding rectangle of the specified UIElement. (Inherited from ItemAutomationPeer.)
	GetChildren	Gets the collection of GetChildren elements that are represented in the UI Automation tree as immediate child elements of the automation peer. (Inherited from AutomationPeer.)
	GetChildrenCore	Gets the collection of child elements of the UIElement that corresponds to the data item in the Items collection that is associated with this ItemAutomationPeer. (Inherited from ItemAutomationPeer.)
	GetClassName	Gets a name that is used with AutomationControlType, to differentiate the control that is represented by this AutomationPeer. (Inherited from AutomationPeer.)
	GetClassNameCore	Gets the class name of the RibbonGroup that is associated with this RibbonGroupDataAutomationPeer. This method is called by GetClassName. (Overrides AutomationPeer.GetClassNameCore().)
	GetClickablePoint	Gets a Point on the element that is associated with the automation peer that responds to a mouse click. (Inherited from AutomationPeer.)
	GetClickablePointCore	Gets a Point that represents the clickable space that is on the specified UIElement. (Inherited from ItemAutomationPeer.)
	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	Gets the string that describes the functionality of the UIElement that corresponds to the data item in the Items collection that is associated with this ItemAutomationPeer. (Inherited from ItemAutomationPeer.)
	GetHostRawElementProviderCore	Tells UI Automation where in the UI Automation tree to place the hwnd being hosted by a Windows Presentation Foundation (WPF) element. (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	Gets a string that conveys the visual status of the specified UIElement. (Inherited from ItemAutomationPeer.)
	GetItemType	Gets a string that describes what kind of item an object represents. (Inherited from AutomationPeer.)
	GetItemTypeCore	Gets a human-readable string that contains the type of item that the specified UIElement represents. (Inherited from ItemAutomationPeer.)
	GetLabeledBy	Gets the AutomationPeer for the Label that is targeted to the element. (Inherited from AutomationPeer.)
	GetLabeledByCore	Gets the AutomationPeer for the Label that is targeted to the specified UIElement. (Inherited from ItemAutomationPeer.)
	GetLocalizedControlType	Gets a human-readable localized string that represents the AutomationControlType value for the control that is associated with this automation peer. (Inherited from AutomationPeer.)
	GetLocalizedControlTypeCore	When overridden in a derived class, is called by GetLocalizedControlType. (Inherited from AutomationPeer.)
	GetName	Gets text that describes the element that is associated with this automation peer. (Inherited from AutomationPeer.)
	GetNameCore	Gets the text label of the UIElement that corresponds to the data item in the Items collection that is associated with this ItemAutomationPeer. (Inherited from ItemAutomationPeer.)
	GetOrientation	Gets a value that indicates the explicit control orientation, if any. (Inherited from AutomationPeer.)
	GetOrientationCore	Gets a value that indicates whether the specified UIElement is laid out in a particular direction. (Inherited from ItemAutomationPeer.)
	GetParent	Gets the AutomationPeer that is the parent of this AutomationPeer. (Inherited from AutomationPeer.)
	GetPattern	Gets the control pattern for the RibbonGroup that is associated with the RibbonGroupDataAutomationPeer. (Overrides AutomationPeer.GetPattern(PatternInterface).)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	HasKeyboardFocus	Gets a value that indicates whether the element that is associated with this automation peer currently has keyboard focus. (Inherited from AutomationPeer.)
	HasKeyboardFocusCore	Gets a value that indicates whether the specified UIElement currently has keyboard input focus. (Inherited from ItemAutomationPeer.)
	InvalidatePeer	Triggers recalculation of the main properties of the AutomationPeer and raises the PropertyChanged notification to the Automation Client if the properties 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	Gets a value that indicates whether the specified UIElement contains data that is presented to the user. (Inherited from ItemAutomationPeer.)
	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	Gets a value that indicates whether the UIElement that is associated with this ItemAutomationPeer is understood by the end user as interactive. (Inherited from ItemAutomationPeer.)
	IsEnabled	Gets a value that indicates whether the element associated with this automation peer supports interaction. (Inherited from AutomationPeer.)
	IsEnabledCore	Gets a value that indicates whether the specified UIElement can receive and send events. (Inherited from ItemAutomationPeer.)
	IsKeyboardFocusable	Gets a value that indicates whether the element can accept keyboard focus. (Inherited from AutomationPeer.)
	IsKeyboardFocusableCore	Gets a value that indicates whether the specified UIElement can accept keyboard focus. (Inherited from ItemAutomationPeer.)
	IsOffscreen	Gets a value that indicates whether an element is off the screen. (Inherited from AutomationPeer.)
	IsOffscreenCore	Gets a value that indicates whether the specified UIElement is off the screen. (Inherited from ItemAutomationPeer.)
	IsPassword	Gets a value that indicates whether the element contains sensitive content. (Inherited from AutomationPeer.)
	IsPasswordCore	Gets a value that indicates whether the specified UIElement contains protected content. (Inherited from ItemAutomationPeer.)
	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	Gets a value that indicates whether the specified UIElement is required to be completed on a form. (Inherited from ItemAutomationPeer.)
	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 for the specified AutomationPeer. (Inherited from AutomationPeer.)
	RaiseAsyncContentLoadedEvent	Called by the AutomationPeer to raise the AsyncContentLoadedEvent event. (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.)
	ResetChildrenCache	Synchronously resets the tree of child elements by calling GetChildrenCore. (Inherited from AutomationPeer.)
	SetFocus	Sets the keyboard focus on the element that is associated with this automation peer. (Inherited from AutomationPeer.)
	SetFocusCore	Sets the keyboard input focus on the specified UIElement. The UIElement corresponds to the data item in the Items collection that is associated with this ItemAutomationPeer. (Inherited from ItemAutomationPeer.)
	ToString	Returns a string that represents the current object. (Inherited from Object.)
	VerifyAccess	Enforces that the calling thread has access to this DispatcherObject. (Inherited from DispatcherObject.)

Top

Explicit Interface Implementations

	Name	Description
	IExpandCollapseProvider.Collapse	Hides all controls that are in the RibbonGroup.
	IExpandCollapseProvider.Expand	Shows the controls that are in the RibbonGroup.
	IExpandCollapseProvider.ExpandCollapseState	Gets the state, expanded or collapsed, of the control that is associated with this RibbonGroupDataAutomationPeer.
	IScrollItemProvider.ScrollIntoView	Scrolls the RibbonGroup into the visible region of the container.