Represents a toggle button for a RadRibbonView.
The RadRibbonToggleButton class inherits from RadToggleButton and implements
the IRibbonButton and IVariantControl interfaces.
This control allows users to toggle settings or commands with associated text and images
displayed in various sizes. It supports features such as different text labels for button states,
customizable images for small and large states, and configurable sizing behavior depending
on the available space in the ribbon layout. The button can automatically adjust its size and appearance
based on the provided CollapseThreshold settings for small and medium sizes.
Additionally, it provides properties for defining the current button size and
supports automation peer creation for user interface automation scenarios.
Definition
Namespace:Telerik.Windows.Controls
Assembly:Telerik.Windows.Controls.RibbonView.dll
Syntax:
[TelerikToolboxCategory("Navigation")]
public class RadRibbonToggleButton : RadToggleButton, IRibbonButton, IVariantControlInheritance: objectRadToggleButtonRadRibbonToggleButton
Derived Classes:
Implements:
Inherited Members
Constructors
Initializes a new instance of the RadRibbonToggleButton class.
public RadRibbonToggleButton()Fields
CollapseToMediumProperty
DependencyProperty
Identifies the CollapseToMedium property.
public static readonly DependencyProperty CollapseToMediumPropertyCollapseToSmallProperty
DependencyProperty
Identifies the CollapseToSmall property.
public static readonly DependencyProperty CollapseToSmallPropertyCurrentSizeProperty
DependencyProperty
Identifies the CurrentSize property.
public static readonly DependencyProperty CurrentSizePropertyIsAutoSizeProperty
DependencyProperty
Identifies the IsAutoSize property.
public static readonly DependencyProperty IsAutoSizePropertyLargeImageProperty
DependencyProperty
Identifies the LargeImage property.
public static readonly DependencyProperty LargeImagePropertySizeProperty
DependencyProperty
Identifies the Size property.
public static readonly DependencyProperty SizePropertySmallImageProperty
DependencyProperty
Identifies the SmallImage property.
public static readonly DependencyProperty SmallImagePropertyTextProperty
DependencyProperty
Identifies the Text property.
public static readonly DependencyProperty TextPropertyTextRow1Property
DependencyProperty
Identifies the TextRow1 property.
public static readonly DependencyProperty TextRow1PropertyTextRow2Property
DependencyProperty
Identifies the TextRow2 property.
public static readonly DependencyProperty TextRow2PropertyProperties
Get/Set the guidance about button's resize to the Medium size. This is a dependency property.
public CollapseThreshold CollapseToMedium { get; set; }Implements:
Get/Set the guidance about button's resize to the Small size. This is a dependency property.
public CollapseThreshold CollapseToSmall { get; set; }Implements:
Get/Set the current State-size of the button. This is a dependency property.
public ButtonSize CurrentSize { get; }Implements:
Get/Set the permission to resize the Image according to the RibbonView guidance. This is a dependency property.
public bool IsAutoSize { get; set; }LargeImage
ImageSource
Get/Set the LargeImage that is shown in Large button state. This is a dependency property.
public ImageSource LargeImage { get; set; }Implements:
Get/Set the button initial size. In fact this is the max-size that the button can implement. This is a dependency property.
public ButtonSize Size { get; set; }Implements:
SmallImage
ImageSource
Get/Set the SmallImage that is shown in Medium and Small button state. This is a dependency property.
public ImageSource SmallImage { get; set; }Implements:
Get/Set the Text label that is shown in Medium and Large button state. This is a dependency property.
public string Text { get; set; }Implements:
Get/Set the Text label that is shown in Medium and Large button state. This is a dependency property.
public string TextRow1 { get; }Methods
Invoked whenever application code or internal processes (such as a rebuilding layout pass) call. .
public override void OnApplyTemplate()Overrides:
OnCreateAutomationPeer()
AutomationPeer
Creates a RadToggleButtonAutomationPeer.
protected override AutomationPeer OnCreateAutomationPeer()AutomationPeer
Overrides:
Raises the event. This method is invoked whenever is set to true internally.
protected override void OnInitialized(EventArgs e)The RoutedEventArgs that contains the event data.
Overrides:
Implements the interface for button resizing in order to follow the resize mechanism of the ribbon group.
public void SetVariant(RibbonGroupVariant variant)Implements: