Class
RadSplitButton

Represents a split button that facilitates a primary action and offers a drop-down menu with additional supplementary actions. This class includes properties for managing the visibility of its components, the ability to check and uncheck the button, and control over the drop-down menu's appearance and behavior. The RadSplitButton supports events for actions such as clicking the button, opening, closing, and toggling the drop-down. It is designed to be styled and customized, providing features like auto-open delays and command binding for integration into MVVM architectures.

Definition

Namespace:Telerik.Windows.Controls

Assembly:Telerik.Windows.Controls.dll

Syntax:

cs-api-definition
[TelerikToolboxCategory("Buttons")]
public class RadSplitButton : ContentControl, ICommandSource, IDisposable

Inheritance: objectRadSplitButton

Derived Classes: RadRibbonSplitButton

Implements: ICommandSourceIDisposable

Constructors

RadSplitButton()

Initializes a new instance of the RadSplitButton class.

Declaration

cs-api-definition
public RadSplitButton()

Fields

ActivateEvent

Identifies the Activate routed event.

Declaration

cs-api-definition
public static readonly RoutedEvent ActivateEvent

Field Value

RoutedEvent

AutoOpenDelayProperty

Identifies the AutoOpenDelay property.

Declaration

cs-api-definition
public static readonly DependencyProperty AutoOpenDelayProperty

Field Value

DependencyProperty

ButtonCornerRadiusProperty

Identifies the ButtonCornerRadius property.

Declaration

cs-api-definition
public static readonly DependencyProperty ButtonCornerRadiusProperty

Field Value

DependencyProperty

ButtonPartStyleProperty

Identifies the ButtonPartStyle dependency property.

Declaration

cs-api-definition
public static readonly DependencyProperty ButtonPartStyleProperty

Field Value

DependencyProperty

CheckedEvent

Occurs when the Button part become checked.

Declaration

cs-api-definition
public static readonly RoutedEvent CheckedEvent

Field Value

RoutedEvent

ClickEvent

Identifies the Click property.

Declaration

cs-api-definition
public static readonly RoutedEvent ClickEvent

Field Value

RoutedEvent

CloseOnEscapeProperty

Identifies the CloseOnEscape property.

Declaration

cs-api-definition
public static readonly DependencyProperty CloseOnEscapeProperty

Field Value

DependencyProperty

CloseOnPopupMouseLeftButtonUpProperty

Identifies the CloseOnPopupMouseLeftButtonUp property.

Declaration

cs-api-definition
public static readonly DependencyProperty CloseOnPopupMouseLeftButtonUpProperty

Field Value

DependencyProperty

CommandParameterProperty

Identifies the CommandParameter property.

Declaration

cs-api-definition
public static readonly DependencyProperty CommandParameterProperty

Field Value

DependencyProperty

CommandProperty

Identifies the Command property.

Declaration

cs-api-definition
public static readonly DependencyProperty CommandProperty

Field Value

DependencyProperty

CommandTargetProperty

Identifies the CommandTarget property.

Declaration

cs-api-definition
public static readonly DependencyProperty CommandTargetProperty

Field Value

DependencyProperty

CornerRadiusProperty

Identifies the CornerRadius property.

Declaration

cs-api-definition
public static readonly DependencyProperty CornerRadiusProperty

Field Value

DependencyProperty

DropDownButtonPositionProperty

Identifies the DropDownButtonPosition property.

Declaration

cs-api-definition
public static readonly DependencyProperty DropDownButtonPositionProperty

Field Value

DependencyProperty

DropDownClosedEvent

Identifies the DropDownClosed property.

Declaration

cs-api-definition
public static readonly RoutedEvent DropDownClosedEvent

Field Value

RoutedEvent

DropDownContentProperty

Identifies the DropDownContent property.

Declaration

cs-api-definition
public static readonly DependencyProperty DropDownContentProperty

Field Value

DependencyProperty

DropDownContentTemplateProperty

Identifies the DropDownContentTemplate property.

Declaration

cs-api-definition
public static readonly DependencyProperty DropDownContentTemplateProperty

Field Value

DependencyProperty

DropDownContentTemplateSelectorProperty

Identifies the DropDownContentTemplateSelector property.

Declaration

cs-api-definition
public static readonly DependencyProperty DropDownContentTemplateSelectorProperty

Field Value

DependencyProperty

DropDownHeightProperty

Identifies the PopupHeight property.

Declaration

cs-api-definition
public static readonly DependencyProperty DropDownHeightProperty

Field Value

DependencyProperty

DropDownIndicatorVisibilityProperty

Identifies the DropDownContent property.

Declaration

cs-api-definition
public static readonly DependencyProperty DropDownIndicatorVisibilityProperty

Field Value

DependencyProperty

DropDownMaxHeightProperty

Identifies the PopupMaxHeight property.

Declaration

cs-api-definition
public static readonly DependencyProperty DropDownMaxHeightProperty

Field Value

DependencyProperty

DropDownMaxWidthProperty

Identifies the PopupMaxWidth property.

Declaration

cs-api-definition
public static readonly DependencyProperty DropDownMaxWidthProperty

Field Value

DependencyProperty

DropDownOpenedEvent

Identifies the DropDownOpened property.

Declaration

cs-api-definition
public static readonly RoutedEvent DropDownOpenedEvent

Field Value

RoutedEvent

DropDownOpeningEvent

Identifies the DropDownOpening property.

Declaration

cs-api-definition
public static readonly RoutedEvent DropDownOpeningEvent

Field Value

RoutedEvent

DropDownPlacementProperty

Identifies the PopupPlacement property.

Declaration

cs-api-definition
public static readonly DependencyProperty DropDownPlacementProperty

Field Value

DependencyProperty

DropDownWidthProperty

Identifies the PopupWidth property.

Declaration

cs-api-definition
public static readonly DependencyProperty DropDownWidthProperty

Field Value

DependencyProperty

IsBackgroundVisibleProperty

Identifies the IsBackgroundVisible property.

Declaration

cs-api-definition
public static readonly DependencyProperty IsBackgroundVisibleProperty

Field Value

DependencyProperty

IsButtonPartVisibleProperty

Identifies the IsButtonPartVisible property.

Declaration

cs-api-definition
public static readonly DependencyProperty IsButtonPartVisibleProperty

Field Value

DependencyProperty

IsCheckedProperty

Identifies the IsChecked property.

Declaration

cs-api-definition
public static readonly DependencyProperty IsCheckedProperty

Field Value

DependencyProperty

IsFocusedProperty

Identifies the IsFocused dependency property.

Declaration

cs-api-definition
public static readonly DependencyProperty IsFocusedProperty

Field Value

DependencyProperty

IsOpenProperty

Identifies the IsOpen property.

Declaration

cs-api-definition
public static readonly DependencyProperty IsOpenProperty

Field Value

DependencyProperty

IsToggleProperty

Identifies the IsToggle property.

Declaration

cs-api-definition
public static readonly DependencyProperty IsToggleProperty

Field Value

DependencyProperty

PopupAnimationProperty

Identifies the PopupAnimation property.

Declaration

cs-api-definition
public static readonly DependencyProperty PopupAnimationProperty

Field Value

DependencyProperty

ToggleContentRotateAngleProperty

Identifies the ToggleContentRotateAngle dependency property.

Declaration

cs-api-definition
public static readonly DependencyProperty ToggleContentRotateAngleProperty

Field Value

DependencyProperty

ToggleCornerRadiusProperty

Identifies the ToggleCornerRadius property.

Declaration

cs-api-definition
public static readonly DependencyProperty ToggleCornerRadiusProperty

Field Value

DependencyProperty

TogglePartStyleProperty

Identifies the ToggleButtonStyle dependency property.

Declaration

cs-api-definition
public static readonly DependencyProperty TogglePartStyleProperty

Field Value

DependencyProperty

UncheckedEvent

Occurs when the Button part become unchecked.

Declaration

cs-api-definition
public static readonly RoutedEvent UncheckedEvent

Field Value

RoutedEvent

Properties

AutoOpenDelay

Gets or sets whether the popup opens when mouse hovers for pointed milliseconds Value of zero means no auto open. This is a dependency property.

Declaration

cs-api-definition
[Browsable(false)]
public TimeSpan AutoOpenDelay { get; set; }

Property Value

TimeSpan

ButtonCornerRadius

Gets or sets the ButtonCornerRadius dependency property.

Declaration

cs-api-definition
public CornerRadius ButtonCornerRadius { get; set; }

Property Value

CornerRadius

ButtonPartStyle

Gets or sets the style for the Button used by the SplitButton.

Declaration

cs-api-definition
public Style ButtonPartStyle { get; set; }

Property Value

Style

CloseOnEscape

Gets or sets whether the popup closes when the Escape key toggles. This is a dependency property.

Declaration

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

Property Value

bool

CloseOnPopupMouseLeftButtonUp

Gets or sets whether the Popup should be closed when the user clicks on the DropDownContent. The closing is executed on MouseLeftButtonUp event of the Popup. This is a dependency property.

Declaration

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

Property Value

bool

Command

Gets the command that will be executed when the command source is invoked. This is a dependency property.

Declaration

cs-api-definition
[TypeConverter(typeof(CommandConverter))]
public ICommand Command { get; set; }

Property Value

ICommand

CommandParameter

Represents a user defined data value that can be passed to the command when it is executed. This is a dependency property.

Declaration

cs-api-definition
public object CommandParameter { get; set; }

Property Value

object

CommandTarget

The object that the command is being executed on. This is a dependency property.

Declaration

cs-api-definition
public IInputElement CommandTarget { get; set; }

Property Value

IInputElement

CornerRadius

Gets or sets a value that represents the degree to which the corners of the control are rounded. This is a dependency property.

Declaration

cs-api-definition
public CornerRadius CornerRadius { get; set; }

Property Value

CornerRadius

DropDownButtonPosition

Gets or sets the position of the drop down indicator. This is a dependency property.

Declaration

cs-api-definition
public DropDownButtonPosition DropDownButtonPosition { get; set; }

Property Value

DropDownButtonPosition

DropDownContent

Gets or sets a content to popup. This is a dependency property.

Declaration

cs-api-definition
public object DropDownContent { get; set; }

Property Value

object

DropDownContentTemplate

Gets or sets the template used to display the drop-down content of the button. This is a dependency property.

Declaration

cs-api-definition
public DataTemplate DropDownContentTemplate { get; set; }

Property Value

DataTemplate

DropDownContentTemplateSelector

Gets or sets the template used to display the drop-down content of the button. This is a dependency property.

Declaration

cs-api-definition
public DataTemplateSelector DropDownContentTemplateSelector { get; set; }

Property Value

DataTemplateSelector

DropDownHeight

Gets or sets the Height of the popup. This is a dependency property.

Declaration

cs-api-definition
public double DropDownHeight { get; set; }

Property Value

double

DropDownIndicatorVisibility

Gets or sets whether the DropDown indicator visibility. This is a dependency property.

Declaration

cs-api-definition
public Visibility DropDownIndicatorVisibility { get; set; }

Property Value

Visibility

DropDownMaxHeight

Gets or sets the MaxHeight of the popup. This is a dependency property.

Declaration

cs-api-definition
public double DropDownMaxHeight { get; set; }

Property Value

double

DropDownMaxWidth

Gets or sets the MaxWidth of the popup. This is a dependency property.

Declaration

cs-api-definition
public double DropDownMaxWidth { get; set; }

Property Value

double

DropDownPlacement

Gets or sets the position of the popup. This is a dependency property.

Declaration

cs-api-definition
public PlacementMode DropDownPlacement { get; set; }

Property Value

PlacementMode

DropDownWidth

Gets or sets the Width of the popup. This is a dependency property.

Declaration

cs-api-definition
public double DropDownWidth { get; set; }

Property Value

double

IsBackgroundVisible

Sets the visual appearance of the chrome not to render in Normal mode.

Declaration

cs-api-definition
[Browsable(false)]
public bool IsBackgroundVisible { get; set; }

Property Value

bool

IsButtonPartVisible

Gets or sets whether the button part is visible.

Declaration

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

Property Value

bool

IsChecked

Simulates the IsChecked of the ToggleButton. This is a dependency property.

Declaration

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

Property Value

bool

IsEnabledCore

Gets a value that becomes the return value of in derived classes.

Declaration

cs-api-definition
protected override bool IsEnabledCore { get; }

Property Value

bool

true if the element is enabled; otherwise, false.

IsFocused

Gets or sets the IsFocused property.

Declaration

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

Property Value

bool

IsOpen

Gets or sets whether the popup window is expanded. This is a dependency property.

Declaration

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

Property Value

bool

IsToggle

Gets or sets whether the popup supports toggle mode. This is a dependency property.

Declaration

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

Property Value

bool

PopupAnimation

Gets or sets the animation that will be used for the popup element.

Declaration

cs-api-definition
public PopupAnimation PopupAnimation { get; set; }

Property Value

PopupAnimation

ToggleCornerRadius

Gets or sets the ToggleCornerRadius dependency property.

Declaration

cs-api-definition
public CornerRadius ToggleCornerRadius { get; set; }

Property Value

CornerRadius

TogglePartStyle

Gets or sets the style for the ToggleButton used by the SplitButton.

Declaration

cs-api-definition
public Style TogglePartStyle { get; set; }

Property Value

Style

Methods

Dispose()

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

Declaration

cs-api-definition
public void Dispose()

Implements IDisposable.Dispose()

GetToggleContentRotateAngle(DependencyObject)

Gets the ToggleContentRotateAngle property.

Declaration

cs-api-definition
public static double GetToggleContentRotateAngle(DependencyObject obj)

Parameters

obj

DependencyObject

Returns

double

OnActivate()

Raises the event.

Declaration

cs-api-definition
protected virtual void OnActivate()

OnApplyTemplate()

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

Declaration

cs-api-definition
public override void OnApplyTemplate()

OnChecked()

Called when IsChecked property is initialised to true. Raises the Checked events.

Declaration

cs-api-definition
protected virtual void OnChecked()

OnClick()

Toggle the IsOpen property and execute the associated Command.

Declaration

cs-api-definition
protected virtual void OnClick()

OnCreateAutomationPeer()

Creates a RadSplitButtonAutomationPeer.

Declaration

cs-api-definition
protected override AutomationPeer OnCreateAutomationPeer()

Returns

AutomationPeer

OnDropDownContentChanged(object, object)

Called when the value of the drop-down content changes.

Declaration

cs-api-definition
protected virtual void OnDropDownContentChanged(object oldValue, object newValue)

Parameters

oldValue

object

The previous value of the drop-down content.

newValue

object

The new value of the drop-down content.

Remarks

This method is invoked whenever the drop-down content is updated. Derived classes can override this method to perform custom logic in response to the content change. The base implementation does nothing.

OnDropDownContentTemplateChanged(DataTemplate, DataTemplate)

Called when the DropDownContentTemplate property of a RadSplitButton changes.

Declaration

cs-api-definition
protected virtual void OnDropDownContentTemplateChanged(DataTemplate oldValue, DataTemplate newValue)

Parameters

oldValue

DataTemplate

The old value of the DropDownContentTemplate property.

newValue

DataTemplate

The new value of the DropDownContentTemplate property.

OnDropDownContentTemplateSelectorChanged(DataTemplateSelector, DataTemplateSelector)

Called when the DropDownContentTemplateSelector property of a RadSplitButton changes.

Declaration

cs-api-definition
protected virtual void OnDropDownContentTemplateSelectorChanged(DataTemplateSelector oldValue, DataTemplateSelector newValue)

Parameters

oldValue

DataTemplateSelector

The old value of the DropDownContentTemplateSelector property.

newValue

DataTemplateSelector

The new value of the DropDownContentTemplateSelector property.

OnDropDownPlacementChanged(PlacementMode, PlacementMode)

Called when [drop down placement changed].

Declaration

cs-api-definition
protected virtual void OnDropDownPlacementChanged(PlacementMode newValue, PlacementMode oldValue)

Parameters

newValue

PlacementMode

The new value.

oldValue

PlacementMode

The old value.

OnGotFocus(RoutedEventArgs)

Called on got focus.

Declaration

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

Parameters

e

RoutedEventArgs

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.

OnIsButtonPartVisibleChanged(bool, bool)

Called when the visibility of the button part changes.

Declaration

cs-api-definition
protected virtual void OnIsButtonPartVisibleChanged(bool oldValue, bool newValue)

Parameters

oldValue

bool

The previous visibility state of the button part.

newValue

bool

The new visibility state of the button part.

Remarks

This method is invoked to handle changes in the visibility of the button part. Derived classes can override this method to provide custom behavior when the visibility changes.

OnKeyDown(KeyEventArgs)

Closes the popup on Escape key.

Declaration

cs-api-definition
protected override void OnKeyDown(KeyEventArgs e)

Parameters

e

KeyEventArgs

OnLostFocus(RoutedEventArgs)

Called on lost focus.

Declaration

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

Parameters

e

RoutedEventArgs

OnMouseEnter(MouseEventArgs)

Handles the mouse over and starts the auto open timer.

Declaration

cs-api-definition
protected override void OnMouseEnter(MouseEventArgs e)

Parameters

e

MouseEventArgs

OnMouseLeave(MouseEventArgs)

Handles the mouse over and stops the auto open timer.

Declaration

cs-api-definition
protected override void OnMouseLeave(MouseEventArgs e)

Parameters

e

MouseEventArgs

OnMouseMove(MouseEventArgs)

Restarts the auto open timer.

Declaration

cs-api-definition
protected override void OnMouseMove(MouseEventArgs e)

Parameters

e

MouseEventArgs

OnMouseWheel(MouseWheelEventArgs)

Declaration

cs-api-definition
protected override void OnMouseWheel(MouseWheelEventArgs e)

Parameters

e

MouseWheelEventArgs

OnToggle()

Toggle the IsChecked property and raise the Checked/Unchecked events.

Declaration

cs-api-definition
protected virtual void OnToggle()

OnUnchecked()

Called when IsChecked property is initialised to false. Raises the Unchecked events.

Declaration

cs-api-definition
protected virtual void OnUnchecked()

SetToggleContentRotateAngle(DependencyObject, double)

Sets the ToggleContentRotateAngle property.

Declaration

cs-api-definition
public static void SetToggleContentRotateAngle(DependencyObject obj, double value)

Parameters

obj

DependencyObject

value

double

Events

Activate

Occurs when the action button is clicked.

Declaration

cs-api-definition
public event EventHandler<RadRoutedEventArgs> Activate

Event Value

EventHandler<RadRoutedEventArgs>

Checked

Occurs when the action button is checked.

Declaration

cs-api-definition
public event RoutedEventHandler Checked

Event Value

RoutedEventHandler

Click

Occurs when the action button is clicked.

Declaration

cs-api-definition
public event RoutedEventHandler Click

Event Value

RoutedEventHandler

DropDownClosed

Occurs when the Popup closed.

Declaration

cs-api-definition
public event RoutedEventHandler DropDownClosed

Event Value

RoutedEventHandler

DropDownOpened

Occurs when the Popup opened.

Declaration

cs-api-definition
public event RoutedEventHandler DropDownOpened

Event Value

RoutedEventHandler

DropDownOpening

Occurs when the Popup will be opened. If the event handler set True for the Handled property then the Popup doesn't open.

Declaration

cs-api-definition
public event RoutedEventHandler DropDownOpening

Event Value

RoutedEventHandler

Unchecked

Occurs when the action button is unchecked.

Declaration

cs-api-definition
public event RoutedEventHandler Unchecked

Event Value

RoutedEventHandler

In this article
DefinitionConstructorsRadSplitButton()FieldsActivateEventAutoOpenDelayPropertyButtonCornerRadiusPropertyButtonPartStylePropertyCheckedEventClickEventCloseOnEscapePropertyCloseOnPopupMouseLeftButtonUpPropertyCommandParameterPropertyCommandPropertyCommandTargetPropertyCornerRadiusPropertyDropDownButtonPositionPropertyDropDownClosedEventDropDownContentPropertyDropDownContentTemplatePropertyDropDownContentTemplateSelectorPropertyDropDownHeightPropertyDropDownIndicatorVisibilityPropertyDropDownMaxHeightPropertyDropDownMaxWidthPropertyDropDownOpenedEventDropDownOpeningEventDropDownPlacementPropertyDropDownWidthPropertyIsBackgroundVisiblePropertyIsButtonPartVisiblePropertyIsCheckedPropertyIsFocusedPropertyIsOpenPropertyIsTogglePropertyPopupAnimationPropertyToggleContentRotateAnglePropertyToggleCornerRadiusPropertyTogglePartStylePropertyUncheckedEventPropertiesAutoOpenDelayButtonCornerRadiusButtonPartStyleCloseOnEscapeCloseOnPopupMouseLeftButtonUpCommandCommandParameterCommandTargetCornerRadiusDropDownButtonPositionDropDownContentDropDownContentTemplateDropDownContentTemplateSelectorDropDownHeightDropDownIndicatorVisibilityDropDownMaxHeightDropDownMaxWidthDropDownPlacementDropDownWidthIsBackgroundVisibleIsButtonPartVisibleIsCheckedIsEnabledCoreIsFocusedIsOpenIsTogglePopupAnimationToggleCornerRadiusTogglePartStyleMethodsDispose()GetToggleContentRotateAngle(DependencyObject)OnActivate()OnApplyTemplate()OnChecked()OnClick()OnCreateAutomationPeer()OnDropDownContentChanged(object, object)OnDropDownContentTemplateChanged(DataTemplate, DataTemplate)OnDropDownContentTemplateSelectorChanged(DataTemplateSelector, DataTemplateSelector)OnDropDownPlacementChanged(PlacementMode, PlacementMode)OnGotFocus(RoutedEventArgs)OnInitialized(EventArgs)OnIsButtonPartVisibleChanged(bool, bool)OnKeyDown(KeyEventArgs)OnLostFocus(RoutedEventArgs)OnMouseEnter(MouseEventArgs)OnMouseLeave(MouseEventArgs)OnMouseMove(MouseEventArgs)OnMouseWheel(MouseWheelEventArgs)OnToggle()OnUnchecked()SetToggleContentRotateAngle(DependencyObject, double)EventsActivateCheckedClickDropDownClosedDropDownOpenedDropDownOpeningUnchecked
Not finding the help you need?
Contact Support