Class RadSplitButton

Represents a split button that allows for both a main action and a drop-down menu of supplementary actions.

Inheritance
System.Object
RadSplitButton
RadRibbonSplitButton
Namespace: Telerik.Windows.Controls
Assembly: Telerik.Windows.Controls.dll

Syntax

[TelerikToolboxCategory("Buttons")]
public class RadSplitButton : ContentControl, IPopupHost, ICommandSource, IPopupWrapperOwner, IDisposable

Constructors

RadSplitButton()

Initializes a new instance of the RadSplitButton class.

Declaration
public RadSplitButton()

Fields

ActivateEvent

Identifies the Activate routed event.

Declaration
public static readonly RoutedEvent ActivateEvent
Field Value
System.Windows.RoutedEvent

AutoOpenDelayProperty

Identifies the AutoOpenDelay property.

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

ButtonCornerRadiusProperty

Identifies the ButtonCornerRadius property.

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

ButtonPartStyleProperty

Identifies the ButtonPartStyle dependency property.

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

CheckedEvent

Occurs when the Button part become checked.

Declaration
public static readonly RoutedEvent CheckedEvent
Field Value
System.Windows.RoutedEvent

ClickEvent

Identifies the Click property.

Declaration
public static readonly RoutedEvent ClickEvent
Field Value
System.Windows.RoutedEvent

CloseOnEscapeProperty

Identifies the CloseOnEscape property.

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

CloseOnPopupMouseLeftButtonUpProperty

Identifies the CloseOnPopupMouseLeftButtonUp property.

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

CommandParameterProperty

Identifies the CommandParameter property.

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

CommandProperty

Identifies the Command property.

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

CommandTargetProperty

Identifies the CommandTarget property.

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

CornerRadiusProperty

Identifies the CornerRadius property.

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

DropDownButtonPositionProperty

Identifies the DropDownButtonPosition property.

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

DropDownClosedEvent

Identifies the DropDownClosed property.

Declaration
public static readonly RoutedEvent DropDownClosedEvent
Field Value
System.Windows.RoutedEvent

DropDownContentProperty

Identifies the DropDownContent property.

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

DropDownContentTemplateProperty

Identifies the DropDownContentTemplate property.

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

DropDownContentTemplateSelectorProperty

Identifies the DropDownContentTemplateSelector property.

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

DropDownHeightProperty

Identifies the PopupHeight property.

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

DropDownIndicatorVisibilityProperty

Identifies the DropDownContent property.

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

DropDownMaxHeightProperty

Identifies the PopupMaxHeight property.

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

DropDownMaxWidthProperty

Identifies the PopupMaxWidth property.

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

DropDownOpenedEvent

Identifies the DropDownOpened property.

Declaration
public static readonly RoutedEvent DropDownOpenedEvent
Field Value
System.Windows.RoutedEvent

DropDownOpeningEvent

Identifies the DropDownOpening property.

Declaration
public static readonly RoutedEvent DropDownOpeningEvent
Field Value
System.Windows.RoutedEvent

DropDownPlacementProperty

Identifies the PopupPlacement property.

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

DropDownWidthProperty

Identifies the PopupWidth property.

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

InnerCornerRadiusProperty

Identifies the InnerCornerRadius property.

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

IsBackgroundVisibleProperty

Identifies the IsBackgroundVisible property.

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

IsButtonPartVisibleProperty

Identifies the IsButtonPartVisible property.

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

IsCheckedProperty

Identifies the IsChecked property.

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

IsFocusedProperty

Identifies the IsFocused dependency property.

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

IsOpenProperty

Identifies the IsOpen property.

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

IsToggleProperty

Identifies the IsToggle property.

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

PopupAnimationProperty

Identifies the PopupAnimation property.

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

ToggleContentRotateAngleProperty

Identifies the ToggleContentRotateAngle dependency property.

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

ToggleCornerRadiusProperty

Identifies the ToggleCornerRadius property.

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

TogglePartStyleProperty

Identifies the ToggleButtonStyle dependency property.

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

UncheckedEvent

Occurs when the Button part become unchecked.

Declaration
public static readonly RoutedEvent UncheckedEvent
Field Value
System.Windows.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
public TimeSpan AutoOpenDelay { get; set; }
Property Value
System.TimeSpan

ButtonCornerRadius

Gets or sets the ButtonCornerRadius dependency property.

Declaration
public CornerRadius ButtonCornerRadius { get; set; }
Property Value
System.Windows.CornerRadius

ButtonPartStyle

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

Declaration
public Style ButtonPartStyle { get; set; }
Property Value
System.Windows.Style

CloseOnEscape

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

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

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
public bool CloseOnPopupMouseLeftButtonUp { get; set; }
Property Value
System.Boolean

Command

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

Declaration
public ICommand Command { get; set; }
Property Value
System.Windows.Input.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
public object CommandParameter { get; set; }
Property Value
System.Object

CommandTarget

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

Declaration
public IInputElement CommandTarget { get; set; }
Property Value
System.Windows.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
public CornerRadius CornerRadius { get; set; }
Property Value
System.Windows.CornerRadius

DropDownButtonPosition

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

Declaration
public DropDownButtonPosition DropDownButtonPosition { get; set; }
Property Value
DropDownButtonPosition

DropDownContent

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

Declaration
public object DropDownContent { get; set; }
Property Value
System.Object

DropDownContentTemplate

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

Declaration
public DataTemplate DropDownContentTemplate { get; set; }
Property Value
System.Windows.DataTemplate

DropDownContentTemplateSelector

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

Declaration
public DataTemplateSelector DropDownContentTemplateSelector { get; set; }
Property Value
System.Windows.Controls.DataTemplateSelector

DropDownHeight

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

Declaration
public double DropDownHeight { get; set; }
Property Value
System.Double

DropDownIndicatorVisibility

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

Declaration
public Visibility DropDownIndicatorVisibility { get; set; }
Property Value
System.Windows.Visibility

DropDownMaxHeight

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

Declaration
public double DropDownMaxHeight { get; set; }
Property Value
System.Double

DropDownMaxWidth

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

Declaration
public double DropDownMaxWidth { get; set; }
Property Value
System.Double

DropDownPlacement

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

Declaration
public PlacementMode DropDownPlacement { get; set; }
Property Value
System.Windows.Controls.Primitives.PlacementMode

DropDownWidth

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

Declaration
public double DropDownWidth { get; set; }
Property Value
System.Double

InnerCornerRadius

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

Declaration
public CornerRadius InnerCornerRadius { get; set; }
Property Value
System.Windows.CornerRadius

IsBackgroundVisible

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

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

IsButtonPartVisible

Gets or sets whether the button part is visible.

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

IsChecked

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

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

IsEnabledCore

Gets a value that becomes the return value of System.Windows.UIElement.IsEnabled in derived classes.

Declaration
protected override bool IsEnabledCore { get; }
Property Value
System.Boolean

true if the element is enabled; otherwise, false.

IsFocused

Gets or sets the IsFocused property.

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

IsOpen

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

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

IsToggle

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

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

PopupAnimation

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

Declaration
public PopupAnimation PopupAnimation { get; set; }
Property Value
System.Windows.Controls.Primitives.PopupAnimation

ToggleCornerRadius

Gets or sets the ToggleCornerRadius dependency property.

Declaration
public CornerRadius ToggleCornerRadius { get; set; }
Property Value
System.Windows.CornerRadius

TogglePartStyle

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

Declaration
public Style TogglePartStyle { get; set; }
Property Value
System.Windows.Style

Methods

Dispose()

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

Declaration
public void Dispose()

GetToggleContentRotateAngle(DependencyObject)

Gets the ToggleContentRotateAngle property.

Declaration
public static double GetToggleContentRotateAngle(DependencyObject obj)
Parameters
System.Windows.DependencyObject obj

Returns
System.Double

OnActivate()

Raises the Activate event.

Declaration
protected virtual void OnActivate()

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()

OnChecked()

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

Declaration
protected virtual void OnChecked()

OnClick()

Toggle the IsOpen property and execute the associated Command.

Declaration
protected virtual void OnClick()

OnCreateAutomationPeer()

Creates a RadSplitButtonAutomationPeer.

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

OnDropDownContentChanged(Object, Object)

Declaration
protected virtual void OnDropDownContentChanged(object oldValue, object newValue)
Parameters
System.Object oldValue

System.Object newValue

OnDropDownContentTemplateChanged(DataTemplate, DataTemplate)

Called when the DropDownContentTemplate property of a RadSplitButton changes.

Declaration
protected virtual void OnDropDownContentTemplateChanged(DataTemplate oldValue, DataTemplate newValue)
Parameters
System.Windows.DataTemplate oldValue

The old value of the DropDownContentTemplate property.
System.Windows.DataTemplate newValue

The new value of the DropDownContentTemplate property.

OnDropDownContentTemplateSelectorChanged(DataTemplateSelector, DataTemplateSelector)

Called when the DropDownContentTemplateSelector property of a RadSplitButton changes.

Declaration
protected virtual void OnDropDownContentTemplateSelectorChanged(DataTemplateSelector oldValue, DataTemplateSelector newValue)
Parameters
System.Windows.Controls.DataTemplateSelector oldValue

The old value of the DropDownContentTemplateSelector property.
System.Windows.Controls.DataTemplateSelector newValue

The new value of the DropDownContentTemplateSelector property.

OnDropDownPlacementChanged(PlacementMode, PlacementMode)

Called when [drop down placement changed].

Declaration
protected virtual void OnDropDownPlacementChanged(PlacementMode newValue, PlacementMode oldValue)
Parameters
System.Windows.Controls.Primitives.PlacementMode newValue

The new value.
System.Windows.Controls.Primitives.PlacementMode oldValue

The old value.

OnGotFocus(RoutedEventArgs)

Called on got focus.

Declaration
protected override void OnGotFocus(RoutedEventArgs e)
Parameters
System.Windows.RoutedEventArgs e

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.

OnIsButtonPartVisibleChanged(Boolean, Boolean)

Declaration
protected virtual void OnIsButtonPartVisibleChanged(bool oldValue, bool newValue)
Parameters
System.Boolean oldValue

System.Boolean newValue

OnKeyDown(KeyEventArgs)

Closes the popup on Escape key.

Declaration
protected override void OnKeyDown(KeyEventArgs e)
Parameters
System.Windows.Input.KeyEventArgs e

OnLostFocus(RoutedEventArgs)

Called on lost focus.

Declaration
protected override void OnLostFocus(RoutedEventArgs e)
Parameters
System.Windows.RoutedEventArgs e

OnMouseEnter(MouseEventArgs)

Handles the mouse over and starts the auto open timer.

Declaration
protected override void OnMouseEnter(MouseEventArgs e)
Parameters
System.Windows.Input.MouseEventArgs e

OnMouseLeave(MouseEventArgs)

Handles the mouse over and stops the auto open timer.

Declaration
protected override void OnMouseLeave(MouseEventArgs e)
Parameters
System.Windows.Input.MouseEventArgs e

OnMouseMove(MouseEventArgs)

Restarts the auto open timer.

Declaration
protected override void OnMouseMove(MouseEventArgs e)
Parameters
System.Windows.Input.MouseEventArgs e

OnMouseWheel(MouseWheelEventArgs)

Declaration
protected override void OnMouseWheel(MouseWheelEventArgs e)
Parameters
System.Windows.Input.MouseWheelEventArgs e

OnToggle()

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

Declaration
protected virtual void OnToggle()

OnUnchecked()

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

Declaration
protected virtual void OnUnchecked()

SetToggleContentRotateAngle(DependencyObject, Double)

Sets the ToggleContentRotateAngle property.

Declaration
public static void SetToggleContentRotateAngle(DependencyObject obj, double value)
Parameters
System.Windows.DependencyObject obj

System.Double value

Events

Activate

Occurs when the action button is clicked.

Declaration
public event EventHandler<RadRoutedEventArgs> Activate
Event Type
System.EventHandler<RadRoutedEventArgs>

Checked

Occurs when the action button is checked.

Declaration
public event RoutedEventHandler Checked
Event Type
System.Windows.RoutedEventHandler

Click

Occurs when the action button is clicked.

Declaration
public event RoutedEventHandler Click
Event Type
System.Windows.RoutedEventHandler

DropDownClosed

Occurs when the Popup closed.

Declaration
public event RoutedEventHandler DropDownClosed
Event Type
System.Windows.RoutedEventHandler

DropDownOpened

Occurs when the Popup opened.

Declaration
public event RoutedEventHandler DropDownOpened
Event Type
System.Windows.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
public event RoutedEventHandler DropDownOpening
Event Type
System.Windows.RoutedEventHandler

Unchecked

Occurs when the action button is unchecked.

Declaration
public event RoutedEventHandler Unchecked
Event Type
System.Windows.RoutedEventHandler

Extension Methods