RadRibbonSplitButton
Represents a split button control specifically designed for use within a ribbon interface. This class extends the functionality of the RadSplitButton to include features typical of a ribbon button, such as multi-line text support and automatic resizing based on the available space. The RadRibbonSplitButton includes properties for managing text, images (both small and large), and size, allowing for flexible customization. The control also provides functionality to manage drop-down popups and their behavior during user interactions, as well as various template parts for layout customization. The split button can display two rows of text and adjusts its visual appearance and behavior according to the current state and size. This control effectively enhances the user experience in ribbon-based applications by providing a visually appealing and easy-to-use button interface.
Definition
Namespace:Telerik.Windows.Controls
Assembly:Telerik.Windows.Controls.RibbonView.dll
Syntax:
[TelerikToolboxCategory("Navigation")]
public class RadRibbonSplitButton : RadSplitButton, ICommandSource, IDisposable, IRibbonButton, IVariantControl
Inheritance: objectRadSplitButtonRadRibbonSplitButton
Implements:
Inherited Members
Constructors
Initializes a new instance of the RadRibbonSplitButton class.
public RadRibbonSplitButton()
Fields
CollapseToMediumProperty
DependencyProperty
Identifies the CollapseToMedium property.
public static readonly DependencyProperty CollapseToMediumProperty
CollapseToSmallProperty
DependencyProperty
Identifies the CollapseToSmall property.
public static readonly DependencyProperty CollapseToSmallProperty
CurrentSizeProperty
DependencyProperty
Identifies the CurrentSize property.
public static readonly DependencyProperty CurrentSizeProperty
IsAutoSizeProperty
DependencyProperty
Identifies the IsAutoSize property.
public static readonly DependencyProperty IsAutoSizeProperty
IsTextInMiddleButtonProperty
DependencyProperty
Identifies the IsTextInMiddleButton property.
public static readonly DependencyProperty IsTextInMiddleButtonProperty
KeepOpenProperty
DependencyProperty
Identifies the KeepOpen property.
public static readonly DependencyProperty KeepOpenProperty
LargeImageProperty
DependencyProperty
Identifies the LargeImage property.
public static readonly DependencyProperty LargeImageProperty
SizeProperty
DependencyProperty
Identifies the Size property.
public static readonly DependencyProperty SizeProperty
SmallImageProperty
DependencyProperty
Identifies the SmallImage property.
public static readonly DependencyProperty SmallImageProperty
SplitTextProperty
DependencyProperty
Identifies the SplitText property.
public static readonly DependencyProperty SplitTextProperty
TextProperty
DependencyProperty
Identifies the Text property.
public static readonly DependencyProperty TextProperty
TextRow1Property
DependencyProperty
Identifies the TextRow1 property.
public static readonly DependencyProperty TextRow1Property
TextRow2Property
DependencyProperty
Identifies the TextRow2 property.
public static readonly DependencyProperty TextRow2Property
Properties
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; }
Get/Set the placement of the text in the Middle-sized button. This is a dependency property.
public bool IsTextInMiddleButton { get; set; }
Defines the close behavior of the popup window. If True the popup will stays opened regardless its children activity.
public bool KeepOpen { 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:
Enable/disable the Text splitting for the Large-sized button. This is a dependency property.
public bool SplitText { get; set; }
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
Hides the Popup when one of observed Children is activated.
protected void HidePopupOnChildItemActivated(object sender, RoutedEventArgs e)
Invoked whenever application code or internal processes (such as a rebuilding layout pass) call. .
public override void OnApplyTemplate()
Overrides:
OnCreateAutomationPeer()
AutomationPeer
Creates a RadSplitButtonAutomationPeer.
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:
Called before the event occurs.
protected override void OnKeyDown(KeyEventArgs e)
The data for the event.
Overrides:
protected override void OnPreviewKeyDown(KeyEventArgs e)
Implements the interface for button resizing in order to follow the resize mechanism of the ribbon group.
public void SetVariant(RibbonGroupVariant variant)
Implements: