menu

WPF

  • Code Examples
  • Upgrade Guide
  • User Guide
  • Demos
  • Support
  • Forums
  • Download
Class RibbonToggleButton - API Reference

    Show / Hide Table of Contents

    Class RibbonToggleButton

    Represent RibbonToggleButton class.

    Inheritance
    System.Object
    ButtonAdv
    RibbonToggleButton
    Implements
    System.Windows.Input.ICommandSource
    IButtonAdv
    IRibbonControl
    System.IDisposable
    System.ICloneable
    Inherited Members
    ButtonAdv.IsCancelProperty
    ButtonAdv.IsDefaultProperty
    ButtonAdv.IconStretchProperty
    ButtonAdv.LabelProperty
    ButtonAdv.IconTemplateProperty
    ButtonAdv.IconTemplateSelectorProperty
    ButtonAdv.SmallIconProperty
    ButtonAdv.IsCheckableProperty
    ButtonAdv.IsCheckedProperty
    ButtonAdv.LargeIconProperty
    ButtonAdv.IconWidthProperty
    ButtonAdv.IconHeightProperty
    ButtonAdv.SizeModeProperty
    ButtonAdv.IsMultiLineProperty
    ButtonAdv.UpdateSize()
    ButtonAdv.OnMouseLeftButtonDown(MouseButtonEventArgs)
    ButtonAdv.OnApplyTemplate()
    ButtonAdv.IsCancel
    ButtonAdv.IsDefault
    ButtonAdv.IconStretch
    ButtonAdv.Label
    ButtonAdv.IconTemplate
    ButtonAdv.IconTemplateSelector
    ButtonAdv.SmallIcon
    ButtonAdv.IsCheckable
    ButtonAdv.IsChecked
    ButtonAdv.LargeIcon
    ButtonAdv.IconWidth
    ButtonAdv.IconHeight
    ButtonAdv.SizeMode
    ButtonAdv.IsMultiLine
    ButtonAdv.Checked
    Namespace: Syncfusion.Windows.Tools.Controls
    Assembly: Syncfusion.Tools.Wpf.dll
    Syntax
    public class RibbonToggleButton : ButtonAdv, ICommandSource, IButtonAdv, IRibbonControl, IDisposable, ICloneable

    Constructors

    RibbonToggleButton()

    Initializes a new instance of the RibbonToggleButton class.

    Declaration
    public RibbonToggleButton()

    Fields

    IsNormalStateProperty

    Identifies the IsNormalState dependency property.

    Declaration
    public static readonly DependencyProperty IsNormalStateProperty
    Field Value
    Type Description
    System.Windows.DependencyProperty
    Remarks

    The identifier for the IsNormalState dependency property.

    Properties

    IsNormalState

    Gets or sets a value indicating whether this instance is normal state.

    Declaration
    public bool IsNormalState { get; set; }
    Property Value
    Type Description
    System.Boolean

    true if this instance is normal state; otherwise, false.

    Methods

    Clone()

    Clones the element

    Declaration
    public object Clone()
    Returns
    Type Description
    System.Object

    The cloned element

    Dispose()

    Dispose all used objects

    Declaration
    public void Dispose()

    OnClick()

    Raises the System.Windows.Controls.Primitives.ButtonBase.Click event.

    Declaration
    protected override void OnClick()
    Overrides
    ButtonAdv.OnClick()

    OnCreateAutomationPeer()

    Returns class-specific AutomationPeer implementations for the Windows Presentation Foundation infrastructure

    Declaration
    protected override AutomationPeer OnCreateAutomationPeer()
    Returns
    Type Description
    System.Windows.Automation.Peers.AutomationPeer

    The type-specific AutomationPeer implementation.

    Overrides
    ButtonAdv.OnCreateAutomationPeer()

    OnMouseRightButtonUp(MouseButtonEventArgs)

    Invoked when an unhandled System.Windows.UIElement.MouseRightButtonUp routed event reaches an element in its route that is derived from this class. Implement this method to add class handling for this event.

    Declaration
    protected override void OnMouseRightButtonUp(MouseButtonEventArgs e)
    Parameters
    Type Name Description
    System.Windows.Input.MouseButtonEventArgs e

    The System.Windows.Input.MouseButtonEventArgs that contains the event data. The event data reports that the right mouse button was released.

    OnPreviewMouseLeftButtonDown(MouseButtonEventArgs)

    Invoked when an unhandled PreviewMouseLeftButtonDown routed event reaches an element in its route that is derived from this class. Implement this method to add class handling for this event.

    Declaration
    protected override void OnPreviewMouseLeftButtonDown(MouseButtonEventArgs e)
    Parameters
    Type Name Description
    System.Windows.Input.MouseButtonEventArgs e

    The event data

    OnPreviewTouchDown(TouchEventArgs)

    Provides class handling for the PreviewTouchDown routed event that occurs when a touch presses this element.

    Declaration
    protected override void OnPreviewTouchDown(TouchEventArgs e)
    Parameters
    Type Name Description
    System.Windows.Input.TouchEventArgs e

    The event data

    OnStylusSystemGesture(StylusSystemGestureEventArgs)

    Invoked when an unhandled Stylus. StylusSystemGesture attached event reaches an element in its route that is derived from this class. Implement this method to add class handling for this event.

    Declaration
    protected override void OnStylusSystemGesture(StylusSystemGestureEventArgs e)
    Parameters
    Type Name Description
    System.Windows.Input.StylusSystemGestureEventArgs e

    The event data

    OnTouchUp(TouchEventArgs)

    Provides class handling for the TouchUp routed event that occurs when a touch is released inside this element.

    Declaration
    protected override void OnTouchUp(TouchEventArgs e)
    Parameters
    Type Name Description
    System.Windows.Input.TouchEventArgs e

    The event data

    Explicit Interface Implementations

    IRibbonControl.get_ToolTip()

    Declaration
    object IRibbonControl.get_ToolTip()
    Returns
    Type Description
    System.Object

    Implements

    System.Windows.Input.ICommandSource
    IButtonAdv
    IRibbonControl
    System.IDisposable
    System.ICloneable
    Back to top Generated by DocFX
    Copyright © 2001 - 2023 Syncfusion Inc. All Rights Reserved