Class RadDropDownButton

A DropDownButton control.

Inheritance
System.Object
RadButton
RadDropDownButton
RadGeometryDropDownButton
RadRibbonDropDownButton
Inherited Members
Namespace: Telerik.Windows.Controls
Assembly: Telerik.Windows.Controls.dll

Syntax

[TelerikToolboxCategory("Buttons")]
public class RadDropDownButton : RadButton, IPopupHost, IPopupWrapperOwner, IDisposable

Constructors

RadDropDownButton()

Initializes a new instance of the RadDropDownButton class.

Declaration
public RadDropDownButton()

Fields

AutoOpenDelayProperty

Identifies the AutoOpenDelay property.

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

CloseOnEnterProperty

Identifies the CloseOnEnter property.

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

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

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

DropDownMinHeightProperty

Identifies the DropDownMinHeight property.

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

DropDownMinWidthProperty

Identifies the DropDownMinWidth property.

Declaration
public static readonly DependencyProperty DropDownMinWidthProperty
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 DropDownPlacement 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

IsOpenProperty

Identifies the IsOpen property.

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

KeepOpenProperty

Identifies the KeepOpen property.

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

PopupAnimationProperty

Identifies the PopupAnimation property.

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

PopupPlacementTargetProperty

Identifies the PopupPlacementTarget property.

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

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

CloseOnEnter

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

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

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

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 the drop-down area's content. 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-selector 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 drop-down area. This is a dependency property.

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

DropDownIndicatorVisibility

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

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

DropDownMaxHeight

Gets or sets the MaxHeight of the drop-down area. This is a dependency property.

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

DropDownMaxWidth

Gets or sets the MaxWidth of the drop-down area. This is a dependency property.

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

DropDownMinHeight

Gets or sets the MinHeight of the drop-down area. This is a dependency property.

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

DropDownMinWidth

Gets or sets the MinWidth of the drop-down area. This is a dependency property.

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

DropDownPlacement

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

Declaration
public PlacementMode DropDownPlacement { get; set; }
Property Value
PlacementMode

DropDownWidth

Gets or sets the Width of the drop-down area. This is a dependency property.

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

IsOpen

Gets or sets whether the drop-down area is opened. This is a dependency property.

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

KeepOpen

Gets or sets whether the drop-down area should remain opened. This is a dependency property.

Declaration
public bool KeepOpen { 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

PopupPlacementTarget

Get/set the placement for the popup element.

Declaration
public FrameworkElement PopupPlacementTarget { get; set; }
Property Value
System.Windows.FrameworkElement

Methods

ApplyDropDownButtonPosition()

Initializes the position of the DropDown indicator and correct the placement of the Popup window.

Declaration
protected virtual void ApplyDropDownButtonPosition()

ApplyPopupPlacement()

Set the placement of the Popup window.

Declaration
protected virtual void ApplyPopupPlacement()

Dispose()

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

Declaration
public void Dispose()

Finalize()

Releases unmanaged resources and performs other cleanup operations before the RadDropDownButton is reclaimed by garbage collection.

Declaration
protected override void Finalize()

OnActivate()

Raises the Activate event.

Declaration
protected override void OnActivate()
Overrides

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

OnClick()

Invoke the base OnClick and toggle the IsOpen property.

Declaration
protected override void OnClick()
Overrides

OnCreateAutomationPeer()

Creates a RadDropDownButtonAutomationPeer.

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

Overrides

OnDropDownContentChanged(Object, Object)

Called when the DropDownContent property of a RadDropDownButton changes.

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

The old value of the DropDownContent property.
System.Object newValue

The new value of the DropDownContent property.

OnDropDownContentTemplateChanged(DataTemplate, DataTemplate)

Called when the DropDownContentTemplate property of a RadDropDownButton 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 RadDropDownButton 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(DataTemplate, DataTemplate)

Called when the DropDownPlacement property of a RadDropDownButton changes.

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

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

The new value of the DropDownPlacement property.

OnHover()

Invocated when the hover happens.

Declaration
protected override void OnHover()
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

OnIsOpenChanged(Boolean, Boolean)

Called when [is open changed].

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

The new value.
System.Boolean oldValue

The old value.

OnKeyDown(KeyEventArgs)

Closes the popup on Escape key.

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

OnLostKeyboardFocus(KeyboardFocusChangedEventArgs)

Called when an element loses keyboard focus.

Declaration
protected override void OnLostKeyboardFocus(KeyboardFocusChangedEventArgs e)
Parameters
System.Windows.Input.KeyboardFocusChangedEventArgs e

The event data for the System.Windows.IInputElement.LostKeyboardFocus event.

OnMouseLeftButtonDown(MouseButtonEventArgs)

Provides class handling for the System.Windows.UIElement.MouseLeftButtonDown routed event that occurs when the left mouse button is pressed while the mouse pointer is over this control.

Declaration
protected override void OnMouseLeftButtonDown(MouseButtonEventArgs e)
Parameters
System.Windows.Input.MouseButtonEventArgs e

The event data.

OnMouseLeftButtonUp(MouseButtonEventArgs)

Invoked when an unhandled System.Windows.UIElement.MouseLeftButtonUp routed event reaches an element in its route that is derived from this class. Implement this method to add class handling for this event.

Declaration
protected override void OnMouseLeftButtonUp(MouseButtonEventArgs e)
Parameters
System.Windows.Input.MouseButtonEventArgs e

The System.Windows.Input.MouseButtonEventArgs that contains the event data. The event data reports that the left mouse button was released.

OnMouseWheel(MouseWheelEventArgs)

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

Events

DropDownClosed

Occurs when the Popup is closed.

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

DropDownOpened

Occurs when the Popup is opened.

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

DropDownOpening

Occurs when the Popup is opening.

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

Extension Methods