Class RadDropDownButton

Represents a drop down button. Essentially the RadDropDownButton class is a simple wrapper for RadDropDownButtonElement.

You can set items that appear when the drop down button is pressed. Also you can configure the visual appearance in numerous ways through themes.

The RadDropDownButtonElement class implements all UI and logic functionality. The RadDropDownButton acts to transfer the events to and from its RadDropDownButtonElementinstance.

Inheritance
System.Object
RadControl
RadDropDownButton
RadApplicationMenu
RadSplitButton
Inherited Members
Namespace: Telerik.WinControls.UI
Assembly: Telerik.WinControls.UI.dll

Syntax

public class RadDropDownButton : RadControl, INotifyPropertyChanged, ISupportInitializeNotification, ISupportInitialize, IComponentTreeHandler, ILayoutHandler, IPCHost, IAnalyticsProvider

Constructors

RadDropDownButton()

Initializes a new instance of the RadDropDownButton class.

Declaration
public RadDropDownButton()

Properties

AllowShowFocusCues

Indicates focus cues display, when available, based on the corresponding control type and the current UI state.

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

Overrides

ArrowDirection

Gets or sets the direction of the arrow shown on the button.

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

An ArrowDirection value that determines the arrow's direction. The default is Down.

DefaultSize

Declaration
protected override Size DefaultSize { get; }
Property Value
System.Drawing.Size

DisplayStyle

Gets or sets the display style that determines how text and images are shown on the button. Controls whether the button displays text only, image only, or both text and image.

Declaration
public virtual DisplayStyle DisplayStyle { get; set; }
Property Value
DisplayStyle

One of the DisplayStyle values. The default is ImageAndText.

DropDownButtonElement

Gets the RadDropDownButtonElement that represents the visual element of this drop-down button control. This element contains the visual styling and drop-down behavior logic for the button.

Declaration
public RadDropDownButtonElement DropDownButtonElement { get; }
Property Value
RadDropDownButtonElement

A RadDropDownButtonElement that represents the button's visual element.

DropDownDirection

Gets or sets the direction in which the dropdown menu opens.

Declaration
public RadDirection DropDownDirection { get; set; }
Property Value
RadDirection

A RadDirection value that determines the dropdown direction. The default is Down.

Image

Declaration
[RadDescription("Image", typeof(RadDropDownButtonElement))]
public Image Image { get; set; }
Property Value
System.Drawing.Image

ImageAlignment

Declaration
public ContentAlignment ImageAlignment { get; set; }
Property Value
System.Drawing.ContentAlignment

ImageIndex

Declaration
[RadDefaultValue("ImageIndex", typeof(RadDropDownButtonElement))]
[RadDescription("ImageIndex", typeof(RadDropDownButtonElement))]
public int ImageIndex { get; set; }
Property Value
System.Int32

ImageKey

Declaration
[RadDefaultValue("ImageKey", typeof(RadDropDownButtonElement))]
[RadDescription("ImageKey", typeof(RadDropDownButtonElement))]
public virtual string ImageKey { get; set; }
Property Value
System.String

IsPressed

Gets a value indicating whether the button is currently pressed.

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

true if the button is pressed; otherwise, false.

Items

Gets the collection of items displayed in the dropdown menu.

Declaration
[RadEditItemsAction]
public virtual RadItemOwnerCollection Items { get; }
Property Value
RadItemOwnerCollection

A RadItemOwnerCollection containing the items in the dropdown menu.

ShowArrow

Gets or sets a value indicating whether the dropdown arrow is displayed on the button.

Declaration
[RadDefaultValue("ShowArrow", typeof(RadDropDownButtonElement))]
[RadDescription("ShowArrow", typeof(RadDropDownButtonElement))]
public bool ShowArrow { get; set; }
Property Value
System.Boolean

true to show the dropdown arrow; otherwise, false.

SvgImage

Gets or sets the Svg Image.

Declaration
public RadSvgImage SvgImage { get; set; }
Property Value
RadSvgImage

SvgImageXml

Gets or sets the Svg Image as string.

Declaration
public string SvgImageXml { get; set; }
Property Value
System.String

Text

Gets or sets the text value that is displayed on the button.

Declaration
public override string Text { get; set; }
Property Value
System.String

Overrides

TextAlignment

Declaration
public ContentAlignment TextAlignment { get; set; }
Property Value
System.Drawing.ContentAlignment

TextImageRelation

Declaration
public TextImageRelation TextImageRelation { get; set; }
Property Value
System.Windows.Forms.TextImageRelation

Methods

ControlDefinesThemeForElement(RadElement)

Declaration
public override bool ControlDefinesThemeForElement(RadElement element)
Parameters
RadElement element

Returns
System.Boolean

Overrides

CreateAccessibilityInstance()

Declaration
protected override AccessibleObject CreateAccessibilityInstance()
Returns
System.Windows.Forms.AccessibleObject

CreateButtonElement()

Override this method to create custom main element. By default the main element is an instance of RadDropDownButtonElement.

Declaration
protected virtual RadDropDownButtonElement CreateButtonElement()
Returns
RadDropDownButtonElement

Instance of the one-and-only child of the root element of RadDropDownButton.

CreateChildItems(RadElement)

Creates and initializes the child elements of the drop-down button.

Declaration
protected override void CreateChildItems(RadElement parent)
Parameters
RadElement parent

The parent RadElement to which child elements will be added.
Overrides

Dispose(Boolean)

Declaration
protected override void Dispose(bool disposing)
Parameters
System.Boolean disposing

Overrides

HideDropDown()

Declaration
public virtual void HideDropDown()

IsInputKey(Keys)

Declaration
protected override bool IsInputKey(Keys keyData)
Parameters
System.Windows.Forms.Keys keyData

Returns
System.Boolean

Overrides

OnDropDownClosed(EventArgs)

Declaration
protected virtual void OnDropDownClosed(EventArgs e)
Parameters
System.EventArgs e

OnDropDownOpened(EventArgs)

Declaration
protected virtual void OnDropDownOpened(EventArgs e)
Parameters
System.EventArgs e

OnDropDownOpening(CancelEventArgs)

Declaration
protected virtual void OnDropDownOpening(CancelEventArgs e)
Parameters
System.ComponentModel.CancelEventArgs e

OnGotFocus(EventArgs)

Declaration
protected override void OnGotFocus(EventArgs e)
Parameters
System.EventArgs e

Overrides

OnLostFocus(EventArgs)

Declaration
protected override void OnLostFocus(EventArgs e)
Parameters
System.EventArgs e

Overrides

OnThemeChanged()

Declaration
protected override void OnThemeChanged()
Overrides

ProcessCodedUIMessage(ref IPCMessage)

Declaration
protected override void ProcessCodedUIMessage(ref IPCMessage request)
Parameters
IPCMessage request

Overrides

ProcessMnemonic(Char)

Declaration
protected override bool ProcessMnemonic(char charCode)
Parameters
System.Char charCode

Returns
System.Boolean

Overrides

ResetBackColorThemeOverrides()

Declaration
protected override void ResetBackColorThemeOverrides()
Overrides

ResetForeColorThemeOverrides()

Declaration
protected override void ResetForeColorThemeOverrides()
Overrides

SetBackColorThemeOverrides()

Declaration
protected override void SetBackColorThemeOverrides()
Overrides

SetForeColorThemeOverrides()

Declaration
protected override void SetForeColorThemeOverrides()
Overrides

ShowDropDown()

Declaration
public virtual void ShowDropDown()

Events

DropDownClosed

Declaration
public event EventHandler DropDownClosed
Event Type
System.EventHandler

DropDownOpened

Declaration
public event EventHandler DropDownOpened
Event Type
System.EventHandler

DropDownOpening

Declaration
public event EventHandler DropDownOpening
Event Type
System.EventHandler

Extension Methods