Back to all docs
API Reference / Telerik.Windows.Controls / RadRibbonToggleButton

Class
RadRibbonToggleButton

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:
cs-api-definition
[TelerikToolboxCategory("Navigation")]
public class RadRibbonToggleButton : RadToggleButton, IRibbonButton, IVariantControl

Inheritance: objectRadToggleButtonRadRibbonToggleButton

Derived Classes: FormatPainterButton

Implements: IRibbonButtonIVariantControl

Inherited Members RadToggleButton.CornerRadiusPropertyRadToggleButton.IsBackgroundVisiblePropertyRadToggleButton.ActivateEventRadToggleButton.PreviewClickEventRadToggleButton.OnClick()RadToggleButton.OnMouseEnter(MouseEventArgs)RadToggleButton.OnMouseLeave(MouseEventArgs)RadToggleButton.OnMouseLeftButtonUp(MouseButtonEventArgs)RadToggleButton.OnLostFocus(RoutedEventArgs)RadToggleButton.OnGotFocus(RoutedEventArgs)RadToggleButton.CornerRadiusRadToggleButton.IsBackgroundVisibleRadToggleButton.ActivateRadToggleButton.PreviewClick

Constructors

RadRibbonToggleButton()

Initializes a new instance of the RadRibbonToggleButton class.

Declaration

cs-api-definition
public RadRibbonToggleButton()

Fields

CollapseToMediumProperty

Identifies the CollapseToMedium property.

Declaration

cs-api-definition
public static readonly DependencyProperty CollapseToMediumProperty

Field Value

DependencyProperty

CollapseToSmallProperty

Identifies the CollapseToSmall property.

Declaration

cs-api-definition
public static readonly DependencyProperty CollapseToSmallProperty

Field Value

DependencyProperty

CurrentSizeProperty

Identifies the CurrentSize property.

Declaration

cs-api-definition
public static readonly DependencyProperty CurrentSizeProperty

Field Value

DependencyProperty

IsAutoSizeProperty

Identifies the IsAutoSize property.

Declaration

cs-api-definition
public static readonly DependencyProperty IsAutoSizeProperty

Field Value

DependencyProperty

LargeImageProperty

Identifies the LargeImage property.

Declaration

cs-api-definition
public static readonly DependencyProperty LargeImageProperty

Field Value

DependencyProperty

SizeProperty

Identifies the Size property.

Declaration

cs-api-definition
public static readonly DependencyProperty SizeProperty

Field Value

DependencyProperty

SmallImageProperty

Identifies the SmallImage property.

Declaration

cs-api-definition
public static readonly DependencyProperty SmallImageProperty

Field Value

DependencyProperty

TextProperty

Identifies the Text property.

Declaration

cs-api-definition
public static readonly DependencyProperty TextProperty

Field Value

DependencyProperty

TextRow1Property

Identifies the TextRow1 property.

Declaration

cs-api-definition
public static readonly DependencyProperty TextRow1Property

Field Value

DependencyProperty

TextRow2Property

Identifies the TextRow2 property.

Declaration

cs-api-definition
public static readonly DependencyProperty TextRow2Property

Field Value

DependencyProperty

Properties

CollapseToMedium

Get/Set the guidance about button's resize to the Medium size. This is a dependency property.

Declaration

cs-api-definition
public CollapseThreshold CollapseToMedium { get; set; }

Property Value

CollapseThreshold

Implements IRibbonButton.CollapseToMedium

CollapseToSmall

Get/Set the guidance about button's resize to the Small size. This is a dependency property.

Declaration

cs-api-definition
public CollapseThreshold CollapseToSmall { get; set; }

Property Value

CollapseThreshold

Implements IRibbonButton.CollapseToSmall

CurrentSize

Get/Set the current State-size of the button. This is a dependency property.

Declaration

cs-api-definition
public ButtonSize CurrentSize { get; }

Property Value

ButtonSize

Implements IRibbonButton.CurrentSize

IsAutoSize

Get/Set the permission to resize the Image according to the RibbonView guidance. This is a dependency property.

Declaration

cs-api-definition
public bool IsAutoSize { get; set; }

Property Value

bool

LargeImage

Get/Set the LargeImage that is shown in Large button state. This is a dependency property.

Declaration

cs-api-definition
public ImageSource LargeImage { get; set; }

Property Value

ImageSource

Implements IRibbonButton.LargeImage

Size

Get/Set the button initial size. In fact this is the max-size that the button can implement. This is a dependency property.

Declaration

cs-api-definition
public ButtonSize Size { get; set; }

Property Value

ButtonSize

Implements IRibbonButton.Size

SmallImage

Get/Set the SmallImage that is shown in Medium and Small button state. This is a dependency property.

Declaration

cs-api-definition
public ImageSource SmallImage { get; set; }

Property Value

ImageSource

Implements IRibbonButton.SmallImage

Text

Get/Set the Text label that is shown in Medium and Large button state. This is a dependency property.

Declaration

cs-api-definition
public string Text { get; set; }

Property Value

string

Implements IRibbonButton.Text

TextRow1

Get/Set the Text label that is shown in Medium and Large button state. This is a dependency property.

Declaration

cs-api-definition
public string TextRow1 { get; }

Property Value

string

TextRow2

Get/Set the Text label that is shown only in Large button state. This is a dependency property.

Declaration

cs-api-definition
public string TextRow2 { get; }

Property Value

string

Methods

OnApplyTemplate()

Invoked whenever application code or internal processes (such as a rebuilding layout pass) call. .

Declaration

cs-api-definition
public override void OnApplyTemplate()

Overrides RadToggleButton.OnApplyTemplate()

OnCreateAutomationPeer()

Creates a RadToggleButtonAutomationPeer.

Declaration

cs-api-definition
protected override AutomationPeer OnCreateAutomationPeer()

Returns

AutomationPeer

Overrides RadToggleButton.OnCreateAutomationPeer()

OnInitialized(EventArgs)

Raises the event. This method is invoked whenever is set to true internally.

Declaration

cs-api-definition
protected override void OnInitialized(EventArgs e)

Parameters

e

EventArgs

The RoutedEventArgs that contains the event data.

Overrides RadToggleButton.OnInitialized(EventArgs)

SetVariant(RibbonGroupVariant)

Implements the interface for button resizing in order to follow the resize mechanism of the ribbon group.

Declaration

cs-api-definition
public void SetVariant(RibbonGroupVariant variant)

Parameters

variant

RibbonGroupVariant

Implements IVariantControl.SetVariant(RibbonGroupVariant)

In this article
DefinitionConstructorsRadRibbonToggleButton()FieldsCollapseToMediumPropertyCollapseToSmallPropertyCurrentSizePropertyIsAutoSizePropertyLargeImagePropertySizePropertySmallImagePropertyTextPropertyTextRow1PropertyTextRow2PropertyPropertiesCollapseToMediumCollapseToSmallCurrentSizeIsAutoSizeLargeImageSizeSmallImageTextTextRow1TextRow2MethodsOnApplyTemplate()OnCreateAutomationPeer()OnInitialized(EventArgs)SetVariant(RibbonGroupVariant)
Not finding the help you need?
Contact Support