Class RadRibbonButton

A Button control for usage in the RadRibbonView.

Inheritance
System.Object
RadButton
RadRibbonButton
Inherited Members
Namespace: Telerik.Windows.Controls
Assembly: Telerik.Windows.Controls.RibbonView.dll

Syntax

[TelerikToolboxCategory("Navigation")]
public class RadRibbonButton : RadButton, IRibbonButton, IVariantControl

Constructors

RadRibbonButton()

Initializes a new instance of the RadRibbonButton class.

Declaration
public RadRibbonButton()

Fields

CollapseToMediumProperty

Identifies the CollapseToMedium property.

Declaration
public static readonly DependencyProperty CollapseToMediumProperty
Field Value
System.Windows.DependencyProperty

CollapseToSmallProperty

Identifies the CollapseToSmall property.

Declaration
public static readonly DependencyProperty CollapseToSmallProperty
Field Value
System.Windows.DependencyProperty

CurrentSizeProperty

Identifies the CurrentSize property.

Declaration
public static readonly DependencyProperty CurrentSizeProperty
Field Value
System.Windows.DependencyProperty

IsAutoSizeProperty

Identifies the IsAutoSize property.

Declaration
public static readonly DependencyProperty IsAutoSizeProperty
Field Value
System.Windows.DependencyProperty

LargeImageProperty

Identifies the LargeImage property.

Declaration
public static readonly DependencyProperty LargeImageProperty
Field Value
System.Windows.DependencyProperty

SizeProperty

Identifies the Size property.

Declaration
public static readonly DependencyProperty SizeProperty
Field Value
System.Windows.DependencyProperty

SmallImageProperty

Identifies the SmallImage property.

Declaration
public static readonly DependencyProperty SmallImageProperty
Field Value
System.Windows.DependencyProperty

SplitTextProperty

Identifies the SplitText property.

Declaration
public static readonly DependencyProperty SplitTextProperty
Field Value
System.Windows.DependencyProperty

TextProperty

Identifies the Text property.

Declaration
public static readonly DependencyProperty TextProperty
Field Value
System.Windows.DependencyProperty

TextRow1Property

Identifies the TextRow1 property.

Declaration
public static readonly DependencyProperty TextRow1Property
Field Value
System.Windows.DependencyProperty

TextRow2Property

Identifies the TextRow2 property.

Declaration
public static readonly DependencyProperty TextRow2Property
Field Value
System.Windows.DependencyProperty

Properties

CollapseToMedium

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

Declaration
public CollapseThreshold CollapseToMedium { get; set; }
Property Value
CollapseThreshold

Implements

CollapseToSmall

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

Declaration
public CollapseThreshold CollapseToSmall { get; set; }
Property Value
CollapseThreshold

Implements

CurrentSize

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

Declaration
public ButtonSize CurrentSize { get; }
Property Value
ButtonSize

Implements

IsAutoSize

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

Declaration
public bool IsAutoSize { get; set; }
Property Value
System.Boolean

LargeImage

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

Declaration
public ImageSource LargeImage { get; set; }
Property Value
System.Windows.Media.ImageSource

Implements

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
public ButtonSize Size { get; set; }
Property Value
ButtonSize

Implements

SmallImage

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

Declaration
public ImageSource SmallImage { get; set; }
Property Value
System.Windows.Media.ImageSource

Implements

SplitText

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

Declaration
public bool SplitText { get; set; }
Property Value
System.Boolean

Text

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

Declaration
public string Text { get; set; }
Property Value
System.String

Implements

TextRow1

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

Declaration
public string TextRow1 { get; }
Property Value
System.String

TextRow2

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

Declaration
public string TextRow2 { get; }
Property Value
System.String

Methods

OnApplyTemplate()

Invoked whenever application code or internal processes (such as a rebuilding layout pass) call. System.Windows.Controls.Control.ApplyTemplate.

Declaration
public override void OnApplyTemplate()
Overrides

OnCreateAutomationPeer()

Creates a RadButtonAutomationPeer.

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

Overrides

OnInitialized(EventArgs)

Raises the System.Windows.FrameworkElement.Initialized event. This method is invoked whenever System.Windows.FrameworkElement.IsInitialized is set to true internally.

Declaration
protected override void OnInitialized(EventArgs e)
Parameters
System.EventArgs e

The System.Windows.RoutedEventArgs that contains the event data.
Overrides

SetVariant(RibbonGroupVariant)

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

Declaration
public void SetVariant(RibbonGroupVariant variant)
Parameters
RibbonGroupVariant variant

Implements

Explicit Interface Implementations

IRibbonButton.TextRow1Element

Gets the text row1 element.

Declaration
TextBlock IRibbonButton.TextRow1Element { get; }
Returns
System.Windows.Controls.TextBlock

The text row1 element.
Implements

IRibbonButton.TextRow2Element

Gets the text row2 element.

Declaration
TextBlock IRibbonButton.TextRow2Element { get; }
Returns
System.Windows.Controls.TextBlock

The text row2 element.
Implements

Extension Methods