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

Class
RadRibbonButton

Represents a customizable button control designed for use in a RadRibbonView. The RadRibbonButton class inherits from RadButton and implements the IRibbonButton and IVariantControl interfaces. This class provides properties for managing text and images across different button sizes, and includes options for auto-sizing, text splitting, and collapsing behaviors. The RadRibbonButton supports a dual-text display with properties for both TextRow1 and TextRow2, enabling rich, contextual button labeling. Additional properties such as Size and CurrentSize allow for control over the button's appearance and behavior based on available space in the Ribbon layout, while the SmallImage and LargeImage properties facilitate the setting of different icons for various button states. Inherits and extends the functionality of the base class to ensure a cohesive user experience within a Ribbon control layout. The class provides callbacks that manage property changes and layout adjustments dynamically.

Definition

Namespace:Telerik.Windows.Controls

Assembly:Telerik.Windows.Controls.RibbonView.dll

Syntax:
cs-api-definition
[TelerikToolboxCategory("Navigation")]
public class RadRibbonButton : RadButton, IRibbonButton, IVariantControl

Inheritance: objectRadButtonRadRibbonButton

Implements: IRibbonButtonIVariantControl

Inherited Members RadButton.HoverDelayPropertyRadButton.CornerRadiusPropertyRadButton.IsBackgroundVisiblePropertyRadButton.ActivateEventRadButton.HoverEventRadButton.OnActivate()RadButton.OnHover()RadButton.OnClick()RadButton.OnLostFocus(RoutedEventArgs)RadButton.OnGotFocus(RoutedEventArgs)RadButton.OnMouseEnter(MouseEventArgs)RadButton.OnMouseLeave(MouseEventArgs)RadButton.OnMouseMove(MouseEventArgs)RadButton.OnIsPressedChanged(DependencyPropertyChangedEventArgs)RadButton.HoverDelayRadButton.CornerRadiusRadButton.IsBackgroundVisibleRadButton.ActivateRadButton.Hover

Constructors

RadRibbonButton()

Initializes a new instance of the RadRibbonButton class.

Declaration

cs-api-definition
public RadRibbonButton()

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

SplitTextProperty

Identifies the SplitText property.

Declaration

cs-api-definition
public static readonly DependencyProperty SplitTextProperty

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

SplitText

Enable/disable the Text splitting for the Large-sized button. This is a dependency property.

Declaration

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

Property Value

bool

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 RadButton.OnApplyTemplate()

OnCreateAutomationPeer()

Creates a RadButtonAutomationPeer.

Declaration

cs-api-definition
protected override AutomationPeer OnCreateAutomationPeer()

Returns

AutomationPeer

Overrides RadButton.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 RadButton.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
DefinitionConstructorsRadRibbonButton()FieldsCollapseToMediumPropertyCollapseToSmallPropertyCurrentSizePropertyIsAutoSizePropertyLargeImagePropertySizePropertySmallImagePropertySplitTextPropertyTextPropertyTextRow1PropertyTextRow2PropertyPropertiesCollapseToMediumCollapseToSmallCurrentSizeIsAutoSizeLargeImageSizeSmallImageSplitTextTextTextRow1TextRow2MethodsOnApplyTemplate()OnCreateAutomationPeer()OnInitialized(EventArgs)SetVariant(RibbonGroupVariant)
Not finding the help you need?
Contact Support