RibbonAutomationPeer Class

Exposes Ribbon types to UI Automation.

Inheritance Hierarchy

System.Object
  System.Windows.Threading.DispatcherObject
    System.Windows.Automation.Peers.AutomationPeer
      System.Windows.Automation.Peers.UIElementAutomationPeer
        System.Windows.Automation.Peers.FrameworkElementAutomationPeer
          System.Windows.Automation.Peers.ItemsControlAutomationPeer
            System.Windows.Automation.Peers.SelectorAutomationPeer
              Microsoft.Windows.Automation.Peers.RibbonAutomationPeer

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

Syntax

'Declaration
Public Class RibbonAutomationPeer _
    Inherits SelectorAutomationPeer _
    Implements IExpandCollapseProvider, ISelectionProvider

public class RibbonAutomationPeer : SelectorAutomationPeer, 
    IExpandCollapseProvider, ISelectionProvider

public ref class RibbonAutomationPeer : public SelectorAutomationPeer, 
    IExpandCollapseProvider, ISelectionProvider

type RibbonAutomationPeer =  
    class
        inherit SelectorAutomationPeer
        interface IExpandCollapseProvider
        interface ISelectionProvider
    end

public class RibbonAutomationPeer extends SelectorAutomationPeer implements IExpandCollapseProvider, ISelectionProvider

The RibbonAutomationPeer type exposes the following members.

Constructors

	Name	Description
	RibbonAutomationPeer	Initializes a new instance of the RibbonAutomationPeer 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.)
	ExpandCollapseState	Gets the state, expanded or collapsed, of the control that is associated with this RibbonAutomationPeer.
	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.)
	Owner	Gets the UIElement that is associated with this UIElementAutomationPeer. (Inherited from UIElementAutomationPeer.)

Top

Methods

	Name	Description
	CheckAccess	Determines whether the calling thread has access to this DispatcherObject. (Inherited from DispatcherObject.)
	Collapse	Minimizes the Ribbon.
	CreateItemAutomationPeer	Creates a RibbonTabDataAutomationPeer for the specified item. (Overrides ItemsControlAutomationPeer.CreateItemAutomationPeer(Object).)
	Equals	Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
	Expand	Restores the Ribbon.
	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 is associated with this UIElementAutomationPeer. This method is called by GetAcceleratorKey. (Inherited from UIElementAutomationPeer.)
	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 is associated with this UIElementAutomationPeer.This method is called by GetAccessKey. (Inherited from UIElementAutomationPeer.)
	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 Ribbon that is associated with this RibbonAutomationPeer. This method is called by GetAutomationControlType. (Overrides SelectorAutomationPeer.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 FrameworkElement that is associated with this FrameworkElementAutomationPeer. 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	Gets the Rect that represents the bounding rectangle of the UIElement that is associated with this UIElementAutomationPeer. This method is called by GetBoundingRectangle. (Inherited from UIElementAutomationPeer.)
	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 Ribbon that is associated with this RibbonAutomationPeer. This method is called by GetChildren. (Overrides ItemsControlAutomationPeer.GetChildrenCore().)
	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 name of the Ribbon that is associated with this RibbonAutomationPeer. This method is called by GetClassName. (Overrides UIElementAutomationPeer.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 UIElement that is associated with this UIElementAutomationPeer. This method is called by GetClickablePoint. (Inherited from UIElementAutomationPeer.)
	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 ContentElement that is associated with this ContentElementAutomationPeer. Called by GetHelpText. (Inherited from FrameworkElementAutomationPeer.)
	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 communicates the visual status of the UIElement that is associated with this UIElementAutomationPeer. This method is called by GetItemStatus. (Inherited from UIElementAutomationPeer.)
	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 item type that the UIElement for this UIElementAutomationPeer represents. This method is called by GetItemType. (Inherited from UIElementAutomationPeer.)
	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 ContentElement that is associated with this ContentElementAutomationPeer. Called by GetLabeledBy. (Inherited from FrameworkElementAutomationPeer.)
	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 ContentElement that is associated with this ContentElementAutomationPeer. Called by GetName. (Inherited from FrameworkElementAutomationPeer.)
	GetOrientation	Gets a value that indicates the explicit control orientation, if any. (Inherited from AutomationPeer.)
	GetOrientationCore	Gets a value that indicates whether the UIElement that is associated with this UIElementAutomationPeer is laid out in a specific direction. This method is called by GetOrientation. (Inherited from UIElementAutomationPeer.)
	GetParent	Gets the AutomationPeer that is the parent of this AutomationPeer. (Inherited from AutomationPeer.)
	GetPattern	Gets the control pattern for the Ribbon that is associated with the RibbonAutomationPeer. (Overrides SelectorAutomationPeer.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 UIElement that is associated with this UIElementAutomationPeer currently has keyboard input focus. This method is called by HasKeyboardFocus. (Inherited from UIElementAutomationPeer.)
	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 UIElement that is associated with this UIElementAutomationPeer is an element that contains data that is presented to the user. This method is called by IsContentElement. (Inherited from UIElementAutomationPeer.)
	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 or sets a value that indicates whether the UIElement that is associated with this UIElementAutomationPeer is understood by the end user as interactive. Optionally, the user might understand the UIElement as contributing to the logical structure of the control in the GUI. This method is called by IsControlElement. (Inherited from UIElementAutomationPeer.)
	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 UIElement that is associated with this UIElementAutomationPeer can accept keyboard focus. This method is called by IsKeyboardFocusable. (Inherited from UIElementAutomationPeer.)
	IsKeyboardFocusable	Gets a value that indicates whether the element can accept keyboard focus. (Inherited from AutomationPeer.)
	IsKeyboardFocusableCore	Gets a value that indicates whether the UIElement that is associated with this UIElementAutomationPeer can accept keyboard focus. This method is called by IsKeyboardFocusable. (Inherited from UIElementAutomationPeer.)
	IsOffscreen	Gets a value that indicates whether an element is off the screen. (Inherited from AutomationPeer.)
	IsOffscreenCore	Gets a value that indicates whether the Ribbon that is associated with this RibbonAutomationPeer is off the screen. (Overrides UIElementAutomationPeer.IsOffscreenCore().)
	IsPassword	Gets a value that indicates whether the element contains sensitive content. (Inherited from AutomationPeer.)
	IsPasswordCore	Gets a value that indicates whether the UIElement that is associated with this UIElementAutomationPeer contains protected content. This method is called by IsPassword. (Inherited from UIElementAutomationPeer.)
	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 UIElement that is associated with this UIElementAutomationPeer is required to be completed on a form. This method is called by IsRequiredForForm. (Inherited from UIElementAutomationPeer.)
	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	Infrastructure. This API is not implemented. (Overrides UIElementAutomationPeer.SetFocusCore().)
	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
	ISelectionProvider.CanSelectMultiple	Gets a value that specifies whether the Ribbon allows more than one child element to be selected concurrently.
	ISelectionProvider.IsSelectionRequired	Gets a value that specifies whether the Ribbon requires at least one child element to be selected.
	ISelectionProvider.GetSelection	This type or member supports the Windows Presentation Foundation (WPF) infrastructure and is not intended to be used directly from your code. (Inherited from SelectorAutomationPeer.)

Top

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

Microsoft.Windows.Automation.Peers Namespace