Class CommandBarDropDownList

Represents a drop down list in CommandBarStripElement.

Inheritance
System.Object
DisposableObject
RadObject
RadElement
VisualElement
RadComponentElement
RadItem
UIItemBase
LightVisualElement
RadCommandBarVisualElement
RadCommandBarBaseItem
CommandBarDropDownList
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Telerik.WinControls.UI
Assembly: Telerik.WinControls.UI.dll

Syntax

public class CommandBarDropDownList : RadCommandBarBaseItem, INotifyPropertyChanged, ICustomTypeDescriptor, ISupportSystemSkin, IComponent, IDisposable, IBindableComponent, ISupportDrag, ISupportDrop, IShortcutProvider, IStylableElement, IStylableNode, IPrimitiveElement, IShapedElement, IFillElement, IBorderElement, IBoxStyle, IBoxElement, IDrawFillElement, IImageElement, ITextPrimitive, ITextProvider

Constructors

CommandBarDropDownList()

Declaration
public CommandBarDropDownList()

Properties

AutoCompleteDataSource

Gets or sets the object that is responsible for providing data objects for the AutoComplete Suggest.

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

AutoCompleteDisplayMember

Gets or sets a string which will be used to get a text string for each visual item. This value can not be set to null. Setting it to null will cause it to contain an empty string.

Declaration
[RadDescription("DisplayMember", typeof(RadListElement))]
public string AutoCompleteDisplayMember { get; set; }
Property Value
System.String

AutoCompleteMode

Specifies the mode for the automatic completion feature used in the DropDownList and the TextBox controls.

Declaration
[RadDescription("AutoCompleteMode", typeof(RadDropDownListElement))]
public AutoCompleteMode AutoCompleteMode { get; set; }
Property Value
System.Windows.Forms.AutoCompleteMode

AutoCompleteValueMember

Gets or sets the string through which the SelectedValue property will be determined. This property can not be set to null. Setting it to null will cause it to contain an empty string.

Declaration
[RadDescription("ValueMember", typeof(RadListElement))]
public string AutoCompleteValueMember { get; set; }
Property Value
System.String

AutoSize

Determines whether control's height will be determined automatically, depending on the current Font.

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

Overrides

AutoSizeItems

Gets or sets a value that indicates whether items will be sized according to their content. If this property is true the user can set the Height property of each individual RadListDataItem in the Items collection in order to override the automatic sizing.

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

BindingContext

Gets or sets the BindingContext for the object.

Declaration
[RadPropertyDefaultValue("BindingContext", typeof(RadObject))]
public override BindingContext BindingContext { get; set; }
Property Value
System.Windows.Forms.BindingContext

Overrides

CaseSensitive

Gets or sets a value indicating whether string comparisons are case-sensitive.

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

CommandBarDropDownListElement

Gets or sets the hosted RadDropDownListElement.

Declaration
public RadDropDownListElement CommandBarDropDownListElement { get; set; }
Property Value
RadDropDownListElement

DataBindings

Gets the collection of data-binding objects for this IBindableComponent.

Declaration
public override ControlBindingsCollection DataBindings { get; }
Property Value
System.Windows.Forms.ControlBindingsCollection

Overrides

DataSource

Gets or sets the object that is responsible for providing data objects for the RadListElement.

Declaration
[RadDefaultValue("DataSource", typeof(RadListElement))]
[RadDescription("DataSource", typeof(RadListElement))]
public object DataSource { get; set; }
Property Value
System.Object

DefaultItemsCountInDropDown

DefaultItems count in drop-down portion of the RadDropDownList.

Declaration
public int DefaultItemsCountInDropDown { get; set; }
Property Value
System.Int32

DisplayMember

Gets or sets a string which will be used to get a text string for each visual item. This value can not be set to null. Setting it to null will cause it to contain an empty string.

Declaration
[RadDescription("DisplayMember", typeof(RadListElement))]
public string DisplayMember { get; set; }
Property Value
System.String

DropDownAnimationEasing

Gets or sets the easing type of the animation.

Declaration
public RadEasingType DropDownAnimationEasing { get; set; }
Property Value
RadEasingType

DropDownAnimationEnabled

Gets or sets a value indicating whether the RadDropDownList will be animated when displaying.

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

DropDownAnimationFrames

Gets or sets the number of frames that will be used when the DropDown is being animated.

Declaration
public int DropDownAnimationFrames { get; set; }
Property Value
System.Int32

DropDownHeight

Gets or sets the height in pixels of the drop-down portion of the RadDropDownList.

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

DropDownListElement

Represent the DropDownListElement element

Declaration
public RadDropDownListElement DropDownListElement { get; set; }
Property Value
RadDropDownListElement

DropDownMaxSize

Declaration
[RadDefaultValue("DropDownMaxSize", typeof(RadDropDownListElement))]
public Size DropDownMaxSize { get; set; }
Property Value
System.Drawing.Size

DropDownMinSize

Declaration
public Size DropDownMinSize { get; set; }
Property Value
System.Drawing.Size

DropDownSizingMode

Gets or sets a value of the SizingMode enumeration. This value determines how the pop-up form can be resized: vertically, horizontally or both.

Declaration
public SizingMode DropDownSizingMode { get; set; }
Property Value
SizingMode

DropDownStyle

Gets or sets a value specifying the style of the DropDownList

Declaration
[RadPropertyDefaultValue("DropDownStyle", typeof(RadDropDownListElement))]
public RadDropDownStyle DropDownStyle { get; set; }
Property Value
RadDropDownStyle

EnableMouseWheel

Enable or disable Mouse Wheel Scrolling.

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

Filter

Gets or sets a predicate which filters which items can be visible.

Declaration
public Predicate<RadListDataItem> Filter { get; set; }
Property Value
System.Predicate<RadListDataItem>

FilterExpression

Gets or sets a filter expression which determines which items will be visible.

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

FitItemsToSize

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

FormatInfo

Gets or sets an object that implements the IFormatProvider interface. This object is used when formatting items. The default object is CultureInfo.CurrentCulture.

Declaration
public IFormatProvider FormatInfo { get; set; }
Property Value
System.IFormatProvider

FormatString

Gets or sets a format string that will be used for visual item formatting if FormattingEnabled is set to true.

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

FormattingEnabled

Gets or sets a value that determines whether text formatting is enabled for the visual items.

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

IsFilterActive

Gets a value indicating whether there is a Filter or FilterExpression set.

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

IsPopupVisible

Indicating whether the Popup part of the control are displayed.

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

Items

Gets the items collection of the RadDropDownListElement.

Declaration
public RadListDataItemCollection Items { get; }
Property Value
RadListDataItemCollection

ListElement

Represent the List element

Declaration
public RadListElement ListElement { get; }
Property Value
RadListElement

MaxDropDownItems

Gets or sets the maximum number of items to be shown in the drop-down portion of the RadDropDownList.

Declaration
public int MaxDropDownItems { get; set; }
Property Value
System.Int32

MaxLength

Gets or sets the maximum number of characters the user can type or paste into the text box control.

Declaration
public int MaxLength { get; set; }
Property Value
System.Int32

NullText

Gets or sets the text that is displayed when RadDropDownList has no text set.

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

Popup

Gets a reference to the drop down form associated with this RadDropDownList.

Declaration
public RadEditorPopupControlBase Popup { get; }
Property Value
RadEditorPopupControlBase

SelectedIndex

Gets or sets the position of the selection. Setting this property will cause the SelectedIndexChanging and SelectedIndexChanged events to fire.

Declaration
public int SelectedIndex { get; set; }
Property Value
System.Int32

SelectedItem

Gets or sets the selected logical list item. Setting this property will cause the selection events to fire.

Declaration
public RadListDataItem SelectedItem { get; set; }
Property Value
RadListDataItem

SelectedItems

Provides a readonly interface to the currently selected items.

Declaration
public IReadOnlyCollection<RadListDataItem> SelectedItems { get; }
Property Value
IReadOnlyCollection<RadListDataItem>

SelectedText

Gets or sets the text that is selected in the editable portion of the DropDownList.

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

SelectedValue

Gets or sets the currently selected value. Setting the SelectedValue to a value that is shared between many items causes the first item to be selected. This property triggers the selection events.

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

SelectionLength

Gets or sets the number of characters selected in the editable portion of the combo box.

Declaration
public int SelectionLength { get; set; }
Property Value
System.Int32

SelectionStart

Gets or sets the starting index of text selected in the combo box.

Declaration
public int SelectionStart { get; set; }
Property Value
System.Int32

SelectNextOnDoubleClick

Rotate items on double click in the edit box part

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

Text

Gets or sets the text associated with this item.

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

Overrides

ValueMember

Gets or sets the string through which the SelectedValue property will be determined. This property can not be set to null. Setting it to null will cause it to contain an empty string.

Declaration
[RadDescription("ValueMember", typeof(RadListElement))]
public string ValueMember { get; set; }
Property Value
System.String

VisibleInStrip

Show or hide item from the strip

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

Overrides

Methods

CreateChildElements()

Declaration
protected override void CreateChildElements()
Overrides

Select()

selects the hosted control

Declaration
public void Select()

SelectAllText()

Selects all the text in the editable portion of the DropDownList box.

Declaration
public void SelectAllText()

SelectText(Int32, Int32)

Selects a range of text in the editable portion of the combo box

Declaration
public void SelectText(int start, int length)
Parameters
System.Int32 start

The position of the first character in the current text selection within the text box.
System.Int32 length

The number of characters to select.

Events

CreatingVisualItem

Declaration
public event CreatingVisualListItemEventHandler CreatingVisualItem
Event Type
CreatingVisualListItemEventHandler

ItemDataBinding

Declaration
public event ListItemDataBindingEventHandler ItemDataBinding
Event Type
ListItemDataBindingEventHandler

ItemDataBound

Declaration
public event ListItemDataBoundEventHandler ItemDataBound
Event Type
ListItemDataBoundEventHandler

KeyDown

Occurs when the CommandBarTextBox has focus and the user presses a key down

Declaration
public event KeyEventHandler KeyDown
Event Type
System.Windows.Forms.KeyEventHandler

KeyPress

Occurs when the CommandBarTextBox has focus and the user presses a key

Declaration
public event KeyPressEventHandler KeyPress
Event Type
System.Windows.Forms.KeyPressEventHandler

KeyUp

Occurs when the CommandBarTextBox has focus and the user releases the pressed key up

Declaration
public event KeyEventHandler KeyUp
Event Type
System.Windows.Forms.KeyEventHandler

PopupClosed

Occurs when the popup is closed.

Declaration
public event RadPopupClosedEventHandler PopupClosed
Event Type
RadPopupClosedEventHandler

PopupClosing

Occurs when the popup is about to be closed.

Declaration
public event RadPopupClosingEventHandler PopupClosing
Event Type
RadPopupClosingEventHandler

PopupOpened

Occurs when the popup is opened.

Declaration
public event EventHandler PopupOpened
Event Type
System.EventHandler

PopupOpening

Occurs when the popup is about to be opened.

Declaration
public event CancelEventHandler PopupOpening
Event Type
System.ComponentModel.CancelEventHandler

SelectedIndexChanged

Declaration
public event PositionChangedEventHandler SelectedIndexChanged
Event Type
PositionChangedEventHandler

SelectedIndexChanging

Declaration
public event PositionChangingEventHandler SelectedIndexChanging
Event Type
PositionChangingEventHandler

SelectedValueChanged

Declaration
public event ValueChangedEventHandler SelectedValueChanged
Event Type
ValueChangedEventHandler

SortStyleChanged

Declaration
public event SortStyleChangedEventHandler SortStyleChanged
Event Type
SortStyleChangedEventHandler

TextChanged

Occurs when the Text property value changes.

Declaration
public event EventHandler TextChanged
Event Type
System.EventHandler

TextChanging

Occurs when the Text property value is about to be changed.

Declaration
public event TextChangingEventHandler TextChanging
Event Type
TextChangingEventHandler

VisualItemFormatting

Declaration
public event VisualListItemFormattingEventHandler VisualItemFormatting
Event Type
VisualListItemFormattingEventHandler

Extension Methods