alexa
menu

WPF

  • Code Examples
  • Upgrade Guide
  • User Guide
  • Demos
  • Support
  • Forums
  • Download

    Show / Hide Table of Contents

    Class RibbonButtonAutomationPeer

    Class that provides UI Automation support.

    Inheritance
    System.Object
    RibbonButtonAutomationPeer
    Implements
    System.Windows.Automation.Provider.IInvokeProvider
    Namespace: Syncfusion.Windows.Controls.Tools.AutomationPeer
    Assembly: Syncfusion.Tools.Wpf.dll
    Syntax
    public class RibbonButtonAutomationPeer : FrameworkElementAutomationPeer, IInvokeProvider

    Constructors

    RibbonButtonAutomationPeer(RibbonButton)

    Initializes a new instance of the RibbonButtonAutomationPeer class.

    Declaration
    public RibbonButtonAutomationPeer(RibbonButton control)
    Parameters
    Type Name Description
    RibbonButton control

    The control.

    Methods

    GetAccessKeyCore()

    Gets the access key for the UIElement that is associated with this UIElementAutomationPeer

    Declaration
    protected override string GetAccessKeyCore()
    Returns
    Type Description
    System.String

    The access key

    GetAutomationControlTypeCore()

    Gets the control type for the System.Windows.UIElement that is associated with this System.Windows.Automation.Peers.UIElementAutomationPeer. This method is called by System.Windows.Automation.Peers.AutomationPeer.GetAutomationControlType.

    Declaration
    protected override AutomationControlType GetAutomationControlTypeCore()
    Returns
    Type Description
    System.Windows.Automation.Peers.AutomationControlType

    The System.Windows.Automation.Peers.AutomationControlType.Custom enumeration value.

    GetAutomationIdCore()

    Provides the peer's behavior when a UI Automation client calls GetAutomationId or an equivalent UI Automation client API.

    Declaration
    protected override string GetAutomationIdCore()
    Returns
    Type Description
    System.String

    The automation identifier.

    GetClassNameCore()

    Gets the name of the System.Windows.UIElement that is associated with this System.Windows.Automation.Peers.UIElementAutomationPeer. This method is called by System.Windows.Automation.Peers.AutomationPeer.GetClassName.

    Declaration
    protected override string GetClassNameCore()
    Returns
    Type Description
    System.String

    An System.String.Empty string.

    GetHelpTextCore()

    Provides the peer's behavior when a UI Automation client calls GetHelpText or an equivalent UI Automation client API.

    Declaration
    protected override string GetHelpTextCore()
    Returns
    Type Description
    System.String

    The help text.

    GetItemStatusCore()

    Retrieves the status string for the item if the owner is a RibbonButton.

    Declaration
    protected override string GetItemStatusCore()
    Returns
    Type Description
    System.String

    A formatted string containing various properties of the RibbonButton, including icons, label, and visual states. Returns null if the owner is not a RibbonButton.

    GetLocalizedControlTypeCore()

    When overridden in a derived class, is called by System.Windows.Automation.Peers.AutomationPeer.GetLocalizedControlType.

    Declaration
    protected override string GetLocalizedControlTypeCore()
    Returns
    Type Description
    System.String

    The string that contains the type of control.

    GetNameCore()

    Provides the peer's behavior when a UI Automation client calls GetName or an equivalent UI Automation client API.

    Declaration
    protected override string GetNameCore()
    Returns
    Type Description
    System.String

    The name as used by assistive technoloGetClassNameCoreies and other UI Automation clients.

    GetPattern(PatternInterface)

    Gets the control pattern for the System.Windows.UIElement that is associated with this System.Windows.Automation.Peers.UIElementAutomationPeer.

    Declaration
    public override object GetPattern(PatternInterface patternInterface)
    Parameters
    Type Name Description
    System.Windows.Automation.Peers.PatternInterface patternInterface

    A value from the enumeration.

    Returns
    Type Description
    System.Object

    returns the pattern

    Invoke()

    Sends a request to activate a control and initiate its single, unambiguous action.

    Declaration
    public void Invoke()
    Exceptions
    Type Condition
    System.Windows.Automation.ElementNotEnabledException

    If the control is not enabled.

    Implements

    System.Windows.Automation.Provider.IInvokeProvider
    Back to top Generated by DocFX
    Copyright © 2001 - 2025 Syncfusion Inc. All Rights Reserved