Class
RadRibbonButton

A Button control for usage in the RadRibbonView.

Definition

Namespace:Telerik.UI.Xaml.Controls

Assembly:Telerik.WinUI.Controls.dll

Syntax:

cs-api-definition
public class RadRibbonButton : RadButton, ICommandSource, IRibbonButton, IVariantControl

Inheritance: objectRadButtonRadRibbonButton

Implements: ICommandSourceIRibbonButtonIVariantControl

Inherited Members RadButton.CommandParameterPropertyRadButton.CommandPropertyRadButton.CommandTargetPropertyRadButton.ExecuteCommand()RadButton.CommandRadButton.CommandParameterRadButton.CommandTarget

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

LargeIconProperty

Identifies the LargeIcon property.

Declaration

cs-api-definition
public static readonly DependencyProperty LargeIconProperty

Field Value

DependencyProperty

SizeProperty

Identifies the Size property.

Declaration

cs-api-definition
public static readonly DependencyProperty SizeProperty

Field Value

DependencyProperty

SmallIconProperty

Identifies the SmallIcon property.

Declaration

cs-api-definition
public static readonly DependencyProperty SmallIconProperty

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

LargeIcon

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

Declaration

cs-api-definition
public IconElement LargeIcon { get; set; }

Property Value

IconElement

Implements IRibbonButton.LargeIcon

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

SmallIcon

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

Declaration

cs-api-definition
public IconElement SmallIcon { get; set; }

Property Value

IconElement

Implements IRibbonButton.SmallIcon

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
protected override void OnApplyTemplate()

OnCreateAutomationPeer()

Creates a RadButtonAutomationPeer.

Declaration

cs-api-definition
protected override AutomationPeer OnCreateAutomationPeer()

Returns

AutomationPeer

Overrides RadButton.OnCreateAutomationPeer()

OnGotFocus(RoutedEventArgs)

Declaration

cs-api-definition
protected override void OnGotFocus(RoutedEventArgs e)

Parameters

e

RoutedEventArgs

OnLostFocus(RoutedEventArgs)

Declaration

cs-api-definition
protected override void OnLostFocus(RoutedEventArgs e)

Parameters

e

RoutedEventArgs

OnPointerExited(PointerRoutedEventArgs)

Declaration

cs-api-definition
protected override void OnPointerExited(PointerRoutedEventArgs e)

Parameters

e

PointerRoutedEventArgs

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)