New to Telerik UI for WPFStart a free 30-day trial

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:

C#
[TelerikToolboxCategory("Navigation")]
public class RadRibbonSplitButton : RadSplitButton, ICommandSource, IDisposable, IRibbonButton, IVariantControl

Inheritance: objectRadSplitButtonRadRibbonSplitButton

Implements: ICommandSourceIDisposableIRibbonButtonIVariantControl

Inherited Members RadSplitButton.ClickEventRadSplitButton.CheckedEventRadSplitButton.UncheckedEventRadSplitButton.ActivateEventRadSplitButton.DropDownClosedEventRadSplitButton.DropDownOpenedEventRadSplitButton.DropDownOpeningEventRadSplitButton.CloseOnPopupMouseLeftButtonUpPropertyRadSplitButton.CornerRadiusPropertyRadSplitButton.ToggleCornerRadiusPropertyRadSplitButton.ButtonCornerRadiusPropertyRadSplitButton.IsBackgroundVisiblePropertyRadSplitButton.CommandParameterPropertyRadSplitButton.CommandPropertyRadSplitButton.CommandTargetPropertyRadSplitButton.DropDownIndicatorVisibilityPropertyRadSplitButton.AutoOpenDelayPropertyRadSplitButton.CloseOnEscapePropertyRadSplitButton.IsCheckedPropertyRadSplitButton.IsTogglePropertyRadSplitButton.DropDownContentPropertyRadSplitButton.DropDownWidthPropertyRadSplitButton.DropDownHeightPropertyRadSplitButton.DropDownMaxWidthPropertyRadSplitButton.DropDownMaxHeightPropertyRadSplitButton.IsOpenPropertyRadSplitButton.IsButtonPartVisiblePropertyRadSplitButton.DropDownButtonPositionPropertyRadSplitButton.DropDownPlacementPropertyRadSplitButton.DropDownContentTemplatePropertyRadSplitButton.DropDownContentTemplateSelectorPropertyRadSplitButton.TogglePartStylePropertyRadSplitButton.ButtonPartStylePropertyRadSplitButton.IsFocusedPropertyRadSplitButton.ToggleContentRotateAnglePropertyRadSplitButton.PopupAnimationPropertyRadSplitButton.Dispose()RadSplitButton.OnMouseWheel(MouseWheelEventArgs)RadSplitButton.OnActivate()RadSplitButton.OnClick()RadSplitButton.OnToggle()RadSplitButton.OnChecked()RadSplitButton.OnUnchecked()RadSplitButton.OnGotFocus(RoutedEventArgs)RadSplitButton.OnLostFocus(RoutedEventArgs)RadSplitButton.OnMouseEnter(MouseEventArgs)RadSplitButton.OnMouseLeave(MouseEventArgs)RadSplitButton.OnMouseMove(MouseEventArgs)RadSplitButton.OnDropDownContentChanged(object, object)RadSplitButton.OnDropDownContentTemplateChanged(DataTemplate, DataTemplate)RadSplitButton.OnDropDownContentTemplateSelectorChanged(DataTemplateSelector, DataTemplateSelector)RadSplitButton.OnIsButtonPartVisibleChanged(bool, bool)RadSplitButton.OnDropDownPlacementChanged(PlacementMode, PlacementMode)RadSplitButton.GetToggleContentRotateAngle(DependencyObject)RadSplitButton.SetToggleContentRotateAngle(DependencyObject, double)RadSplitButton.CloseOnPopupMouseLeftButtonUpRadSplitButton.IsEnabledCoreRadSplitButton.CommandRadSplitButton.CommandParameterRadSplitButton.CommandTargetRadSplitButton.IsOpenRadSplitButton.IsFocusedRadSplitButton.IsButtonPartVisibleRadSplitButton.DropDownIndicatorVisibilityRadSplitButton.AutoOpenDelayRadSplitButton.CloseOnEscapeRadSplitButton.IsCheckedRadSplitButton.IsToggleRadSplitButton.DropDownContentRadSplitButton.DropDownButtonPositionRadSplitButton.DropDownPlacementRadSplitButton.DropDownContentTemplateRadSplitButton.DropDownContentTemplateSelectorRadSplitButton.DropDownWidthRadSplitButton.DropDownHeightRadSplitButton.DropDownMaxWidthRadSplitButton.DropDownMaxHeightRadSplitButton.TogglePartStyleRadSplitButton.ButtonPartStyleRadSplitButton.CornerRadiusRadSplitButton.ToggleCornerRadiusRadSplitButton.ButtonCornerRadiusRadSplitButton.IsBackgroundVisibleRadSplitButton.PopupAnimationRadSplitButton.ClickRadSplitButton.CheckedRadSplitButton.UncheckedRadSplitButton.ActivateRadSplitButton.DropDownClosedRadSplitButton.DropDownOpenedRadSplitButton.DropDownOpening...

Constructors

Initializes a new instance of the RadRibbonSplitButton class.

C#
public RadRibbonSplitButton()

Fields

CollapseToMediumProperty

DependencyProperty

Identifies the CollapseToMedium property.

C#
public static readonly DependencyProperty CollapseToMediumProperty

CollapseToSmallProperty

DependencyProperty

Identifies the CollapseToSmall property.

C#
public static readonly DependencyProperty CollapseToSmallProperty

CurrentSizeProperty

DependencyProperty

Identifies the CurrentSize property.

C#
public static readonly DependencyProperty CurrentSizeProperty

IsAutoSizeProperty

DependencyProperty

Identifies the IsAutoSize property.

C#
public static readonly DependencyProperty IsAutoSizeProperty

Identifies the IsTextInMiddleButton property.

C#
public static readonly DependencyProperty IsTextInMiddleButtonProperty

KeepOpenProperty

DependencyProperty

Identifies the KeepOpen property.

C#
public static readonly DependencyProperty KeepOpenProperty

LargeImageProperty

DependencyProperty

Identifies the LargeImage property.

C#
public static readonly DependencyProperty LargeImageProperty

SizeProperty

DependencyProperty

Identifies the Size property.

C#
public static readonly DependencyProperty SizeProperty

SmallImageProperty

DependencyProperty

Identifies the SmallImage property.

C#
public static readonly DependencyProperty SmallImageProperty

SplitTextProperty

DependencyProperty

Identifies the SplitText property.

C#
public static readonly DependencyProperty SplitTextProperty

TextProperty

DependencyProperty

Identifies the Text property.

C#
public static readonly DependencyProperty TextProperty

TextRow1Property

DependencyProperty

Identifies the TextRow1 property.

C#
public static readonly DependencyProperty TextRow1Property

TextRow2Property

DependencyProperty

Identifies the TextRow2 property.

C#
public static readonly DependencyProperty TextRow2Property

Properties

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

C#
public CollapseThreshold CollapseToMedium { get; set; }

Implements: IRibbonButton.CollapseToMedium

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

C#
public CollapseThreshold CollapseToSmall { get; set; }

Implements: IRibbonButton.CollapseToSmall

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

C#
public ButtonSize CurrentSize { get; }

Implements: IRibbonButton.CurrentSize

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

C#
public bool IsAutoSize { get; set; }

Get/Set the placement of the text in the Middle-sized button. This is a dependency property.

C#
public bool IsTextInMiddleButton { get; set; }

Defines the close behavior of the popup window. If True the popup will stays opened regardless its children activity.

C#
public bool KeepOpen { get; set; }

LargeImage

ImageSource

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

C#
public ImageSource LargeImage { get; set; }

Implements: IRibbonButton.LargeImage

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

C#
public ButtonSize Size { get; set; }

Implements: IRibbonButton.Size

SmallImage

ImageSource

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

C#
public ImageSource SmallImage { get; set; }

Implements: IRibbonButton.SmallImage

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

C#
public bool SplitText { get; set; }

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

C#
public string Text { get; set; }

Implements: IRibbonButton.Text

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

C#
public string TextRow1 { get; }

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

C#
public string TextRow2 { get; }

Methods

Hides the Popup when one of observed Children is activated.

C#
protected void HidePopupOnChildItemActivated(object sender, RoutedEventArgs e)
Parameters:senderobjecteRoutedEventArgs

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

C#
public override void OnApplyTemplate()

Overrides: RadSplitButton.OnApplyTemplate()

Creates a RadSplitButtonAutomationPeer.

C#
protected override AutomationPeer OnCreateAutomationPeer()
Returns:

AutomationPeer

Overrides: RadSplitButton.OnCreateAutomationPeer()

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

C#
protected override void OnInitialized(EventArgs e)
Parameters:eEventArgs

The RoutedEventArgs that contains the event data.

Overrides: RadSplitButton.OnInitialized(EventArgs)

Called before the event occurs.

C#
protected override void OnKeyDown(KeyEventArgs e)
Parameters:eKeyEventArgs

The data for the event.

Overrides: RadSplitButton.OnKeyDown(KeyEventArgs)

C#
protected override void OnPreviewKeyDown(KeyEventArgs e)
Parameters:eKeyEventArgs

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

C#
public void SetVariant(RibbonGroupVariant variant)
Parameters:variantRibbonGroupVariant

Implements: IVariantControl.SetVariant(RibbonGroupVariant)