Class RadDropDownListElement

Inheritance
System.Object
DisposableObject
RadObject
RadElement
VisualElement
RadComponentElement
RadItem
RadEditorElement
EditorBaseElement
PopupEditorBaseElement
PopupEditorElement
RadDropDownListElement
AutoCompleteSuggestDropDownListElement
BaseDropDownListEditorElement
BreadCrumbAutoCompleteSuggestDropDownListElement
RadCheckedDropDownListElement
RadDomainUpDownElement
RadDropDownListEditorElement
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

[RadToolboxItem(true)]
public class RadDropDownListElement : PopupEditorElement, INotifyPropertyChanged, ICustomTypeDescriptor, ISupportSystemSkin, IComponent, IDisposable, IBindableComponent, ISupportDrag, ISupportDrop, IShortcutProvider, IStylableElement, IStylableNode, IInputEditor, IValueEditor, ISupportInitialize

Constructors

RadDropDownListElement()

Declaration
public RadDropDownListElement()

Fields

IsDropDownShownProperty

Declaration
public static RadProperty IsDropDownShownProperty
Field Value
RadProperty

Properties

ArrowButton

ArrowButton Property

Declaration
public virtual RadArrowButtonElement ArrowButton { get; set; }
Property Value
RadArrowButtonElement

ArrowButtonMinWidth

Get or sets the minimum width of the arrow button element.

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

AutoCompleteAppend

AutoCompleteAppend Property

Declaration
public virtual AutoCompleteAppendHelper AutoCompleteAppend { get; set; }
Property Value
AutoCompleteAppendHelper

AutoCompleteHelpers

Represent list of all AutoComplete Helpers

Declaration
public virtual List<BaseAutoComplete> AutoCompleteHelpers { get; }
Property Value
System.Collections.Generic.List<BaseAutoComplete>

AutoCompleteMode

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

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

AutoCompleteSuggest

AutoCompleteSuggest Property

Declaration
public virtual AutoCompleteSuggestHelper AutoCompleteSuggest { get; set; }
Property Value
AutoCompleteSuggestHelper

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

BindingContext

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

DataMember

Gets or sets the name of the list or table in the data source for which the RadDropDownListElement is displaying data.

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

DataSource

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

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

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
public virtual string DisplayMember { get; set; }
Property Value
System.String

DropDownAnimationEasing

Gets or sets the type of the DropDown animation.

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

DropDownAnimationEnabled

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

Declaration
public virtual 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 virtual int DropDownAnimationFrames { get; set; }
Property Value
System.Int32

DropDownSizingMode

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

DropDownStyle

Gets or sets a value specifying the style of the combo box.

Declaration
public virtual RadDropDownStyle DropDownStyle { get; set; }
Property Value
RadDropDownStyle

DropDownWidth

Gets or sets the drop down minimum width.

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

EditableElement

EditableElement Property

Declaration
public RadDropDownListEditableAreaElement EditableElement { get; set; }
Property Value
RadDropDownListEditableAreaElement

EditableElementText

Get or set the text in Editable area

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

EnableMouseWheel

Enable or disable Mouse Wheel Scrolling.

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

Filter

Gets or sets a Predicate that will be called for every data item in order to determine if the item will be visible.

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

FilterExpression

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

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

FormatInfo

Declaration
[RadDescription("FormatInfo", typeof(RadListElement))]
public virtual 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 virtual 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
public virtual 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

Gets a value that indicates if the popup associated with this RadDropDownListElement is open.

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

ItemHeight

Gets or sets the item height for the items.

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

Items

Declaration
public RadListDataItemCollection Items { get; }
Property Value
RadListDataItemCollection

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
public string NullText { get; set; }
Property Value
System.String

NullTextColor

Gets or sets the color of prompt text that is displayed when the TextBox contains no text

Declaration
[RadPropertyDefaultValue("NullTextColor", typeof(RadTextBoxItem))]
public Color NullTextColor { get; set; }
Property Value
System.Drawing.Color

RightToLeft

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

Overrides

SelectedIndex

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

SelectedItem

Declaration
[RadDescription("SelectedItem", typeof(RadListElement))]
public virtual RadListDataItem SelectedItem { get; set; }
Property Value
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

Declaration
[RadDescription("SelectedValue", typeof(RadListElement))]
public virtual 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

SelectionMode

For information on this property please refer to the MSDN.

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

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

ShowImageInEditorArea

Gets or sets that RadListDataItem Image will be displayd in Editor Element when DropDownStyle is set to DropDownStyleList

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

SortStyle

Gets or sets the sort style. It can be Ascending, Descending or None. Sorting is performed according to the property specified by DisplayMember.

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

SuspendSelectionEvents

Gets or sets a value that determines whether to stop the selection events from firing. These are SelectedIndexChanged, SelectedIndexChanging and SelectedValueChanged.

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

SyncSelectionWithText

Gets or sets a value indicating whether the SelectedIndex is synchronized with the text in the editable area.

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

TextBox

TextBox Property

Declaration
public RadDropDownTextBoxElement TextBox { get; set; }
Property Value
RadDropDownTextBoxElement

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
public virtual string ValueMember { get; set; }
Property Value
System.String

Methods

BeginUpdate()

Declaration
public virtual void BeginUpdate()

CallClosePopupCore()

This method is used internally!

Declaration
public void CallClosePopupCore()

CallTextChanged(Object, EventArgs)

Declaration
protected virtual void CallTextChanged(object sender, EventArgs e)
Parameters
System.Object sender

System.EventArgs e

CanClosePopUp(RadPopupCloseReason, MouseButtons)

Declaration
protected virtual bool CanClosePopUp(RadPopupCloseReason reason, MouseButtons buttons)
Parameters
RadPopupCloseReason reason

System.Windows.Forms.MouseButtons buttons

Returns
System.Boolean

CanCreateArrowButtonElement()

Declaration
protected virtual bool CanCreateArrowButtonElement()
Returns
System.Boolean

ClosePopup(RadPopupCloseReason)

Declaration
public override void ClosePopup(RadPopupCloseReason reason)
Parameters
RadPopupCloseReason reason

Overrides

ClosePopupCore()

Declaration
protected virtual void ClosePopupCore()

CreateArrowButtonElement()

Declaration
protected virtual RadDropDownListArrowButtonElement CreateArrowButtonElement()
Returns
RadDropDownListArrowButtonElement

CreateAutoCompleteAppendHandler()

Creates the auto complete append handler.

Declaration
protected virtual AutoCompleteAppendHelper CreateAutoCompleteAppendHandler()
Returns
AutoCompleteAppendHelper

CreateAutoCompleteSuggestHelper()

Creates the auto complete suggest helper.

Declaration
protected virtual AutoCompleteSuggestHelper CreateAutoCompleteSuggestHelper()
Returns
AutoCompleteSuggestHelper

CreateChildElements()

Declaration
protected override void CreateChildElements()
Overrides

CreateElementsContainer()

Declaration
protected virtual StackLayoutElement CreateElementsContainer()
Returns
StackLayoutElement

CreatePopupForm()

Declaration
protected override RadPopupControlBase CreatePopupForm()
Returns
RadPopupControlBase

Overrides

CreateTextEditorElement()

Declaration
protected virtual RadDropDownListEditableAreaElement CreateTextEditorElement()
Returns
RadDropDownListEditableAreaElement

DeferRefresh()

Defers the refresh.

Declaration
public virtual IDisposable DeferRefresh()
Returns
System.IDisposable

DisposeManagedResources()

Declaration
protected override void DisposeManagedResources()
Overrides

EndUpdate()

Declaration
public virtual void EndUpdate()

EnterPressedOrLeaveControl()

Declaration
protected virtual void EnterPressedOrLeaveControl()

FindString(String)

Searches for an item related to the specified string. The relation is described by the object assigned to FindStringComparer property. By default FindStringComparer uses the System.String.StartsWith() method. This method starts searching from the specified index. If the algorithm reaches the end of the Items collection it wraps to the beginning and continues until one before the provided index.

Declaration
public int FindString(string s)
Parameters
System.String s

The string with which every item will be compared.
Returns
System.Int32

The index of the found item or -1 if no item is found.

FindString(String, Int32)

Searches for an item related to the specified string. The relation is described by the object assigned to FindStringComparer property. By default FindStringComparer uses the System.String.StartsWith() method. This method starts searching from the specified index. If the algorithm reaches the end of the Items collection it wraps to the beginning and continues until one before the provided index.

Declaration
public int FindString(string s, int startIndex)
Parameters
System.String s

The string with which every item will be compared.
System.Int32 startIndex

The index from which to start searching.
Returns
System.Int32

The index of the found item or -1 if no item is found.

FindStringExact(String)

Searches for an item in the same manner as FindString() but matches an item only if its text is exactly equal to the provided string.

Declaration
public virtual int FindStringExact(string s)
Parameters
System.String s

Returns
System.Int32

FindStringExact(String, Int32)

Searches for an item in the same manner as FindString() but matches an item only if its text is exactly equal to the provided string.

Declaration
public virtual int FindStringExact(string s, int startIndex)
Parameters
System.String s

System.Int32 startIndex

Returns
System.Int32

Focus()

Declaration
public override bool Focus()
Returns
System.Boolean

Overrides

HandleEnterCore()

Declaration
protected virtual void HandleEnterCore()

HandleOnKeyUpKeyDownPress(KeyEventArgs)

Declaration
protected virtual void HandleOnKeyUpKeyDownPress(KeyEventArgs keyEventArgs)
Parameters
System.Windows.Forms.KeyEventArgs keyEventArgs

HandleSelectNextOrPrev(Boolean, Boolean)

Declaration
protected virtual void HandleSelectNextOrPrev(bool next, bool startFromBeginningIfEndReached)
Parameters
System.Boolean next

System.Boolean startFromBeginningIfEndReached

IsUpdating()

Declaration
public virtual bool IsUpdating()
Returns
System.Boolean

listElement_DataItemPropertyChanged(Object, RadPropertyChangedEventArgs)

Declaration
protected override void listElement_DataItemPropertyChanged(object sender, RadPropertyChangedEventArgs e)
Parameters
System.Object sender

RadPropertyChangedEventArgs e

Overrides

MeasureOverride(SizeF)

Declaration
protected override SizeF MeasureOverride(SizeF availableSize)
Parameters
System.Drawing.SizeF availableSize

Returns
System.Drawing.SizeF

Overrides

NotifyOwner(PopupEditorNotificationData)

main update entry point

Declaration
public override void NotifyOwner(PopupEditorNotificationData notificationData)
Parameters
PopupEditorNotificationData notificationData

contains notification context
Overrides

OnAutoCompeleteDataSourceChanged()

Declaration
protected override void OnAutoCompeleteDataSourceChanged()
Overrides

OnBubbleEvent(RadElement, RoutedEventArgs)

Declaration
protected override void OnBubbleEvent(RadElement sender, RoutedEventArgs args)
Parameters
RadElement sender

RoutedEventArgs args

Overrides

OnDoubleClick(EventArgs)

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

Overrides

OnItemsChanged()

Declaration
protected virtual void OnItemsChanged()

OnItemsClear()

Declaration
protected virtual void OnItemsClear()

OnKeyDown(KeyEventArgs)

Declaration
public virtual void OnKeyDown(KeyEventArgs e)
Parameters
System.Windows.Forms.KeyEventArgs e

OnKeyPress(KeyPressEventArgs)

Declaration
public virtual void OnKeyPress(KeyPressEventArgs e)
Parameters
System.Windows.Forms.KeyPressEventArgs e

OnKeyPress(RadDropDownListEditableAreaElement, KeyPressEventArgs)

Declaration
protected void OnKeyPress(RadDropDownListEditableAreaElement sender, KeyPressEventArgs e)
Parameters
RadDropDownListEditableAreaElement sender

System.Windows.Forms.KeyPressEventArgs e

OnKeyUp(KeyEventArgs)

Declaration
public virtual void OnKeyUp(KeyEventArgs e)
Parameters
System.Windows.Forms.KeyEventArgs e

OnListItemDataBinding(Object, ListItemDataBindingEventArgs)

Declaration
protected virtual void OnListItemDataBinding(object sender, ListItemDataBindingEventArgs args)
Parameters
System.Object sender

ListItemDataBindingEventArgs args

OnListItemDataBound(Object, ListItemDataBoundEventArgs)

Declaration
protected virtual void OnListItemDataBound(object sender, ListItemDataBoundEventArgs args)
Parameters
System.Object sender

ListItemDataBoundEventArgs args

OnLoaded()

Declaration
protected override void OnLoaded()
Overrides

OnMouseWheel(MouseEventArgs)

Declaration
protected override void OnMouseWheel(MouseEventArgs e)
Parameters
System.Windows.Forms.MouseEventArgs e

Overrides

OnMouseWheelCore(MouseEventArgs)

Declaration
protected virtual void OnMouseWheelCore(MouseEventArgs e)
Parameters
System.Windows.Forms.MouseEventArgs e

OnParentChanged(RadElement)

Declaration
protected override void OnParentChanged(RadElement previousParent)
Parameters
RadElement previousParent

Overrides

OnPopupClosed(Object, RadPopupClosedEventArgs)

Declaration
protected override void OnPopupClosed(object sender, RadPopupClosedEventArgs args)
Parameters
System.Object sender

RadPopupClosedEventArgs args

Overrides

OnPopupOpened(Object, EventArgs)

Declaration
protected override void OnPopupOpened(object sender, EventArgs e)
Parameters
System.Object sender

System.EventArgs e

Overrides

OnPropertyChanged(RadPropertyChangedEventArgs)

Declaration
protected override void OnPropertyChanged(RadPropertyChangedEventArgs e)
Parameters
RadPropertyChangedEventArgs e

Overrides

OnSelectedIndexChanged(Object, PositionChangedEventArgs)

Declaration
protected virtual void OnSelectedIndexChanged(object sender, PositionChangedEventArgs e)
Parameters
System.Object sender

PositionChangedEventArgs e

OnSelectedIndexChanging(Object, PositionChangingCancelEventArgs)

Declaration
protected bool OnSelectedIndexChanging(object sender, PositionChangingCancelEventArgs e)
Parameters
System.Object sender

PositionChangingCancelEventArgs e

Returns
System.Boolean

OnSelectedValueChanged(Object, ValueChangedEventArgs)

Declaration
protected virtual void OnSelectedValueChanged(object sender, ValueChangedEventArgs e)
Parameters
System.Object sender

ValueChangedEventArgs e

OnSortStyleChanged(SortStyle)

Declaration
protected virtual void OnSortStyleChanged(SortStyle sortStyle)
Parameters
SortStyle sortStyle

OnTextChanged(RadDropDownListEditableAreaElement, EventArgs)

Declaration
protected void OnTextChanged(RadDropDownListEditableAreaElement sender, EventArgs args)
Parameters
RadDropDownListEditableAreaElement sender

System.EventArgs args

OnVisualElementCreated(Object, CreatingVisualListItemEventArgs)

Declaration
protected virtual void OnVisualElementCreated(object sender, CreatingVisualListItemEventArgs args)
Parameters
System.Object sender

CreatingVisualListItemEventArgs args

OnVisualItemFormatting(RadListVisualItem)

Declaration
protected virtual void OnVisualItemFormatting(RadListVisualItem item)
Parameters
RadListVisualItem item

ProcessKeyDown(Object, KeyEventArgs)

Declaration
protected virtual void ProcessKeyDown(object sender, KeyEventArgs e)
Parameters
System.Object sender

System.Windows.Forms.KeyEventArgs e

ProcessKeyUp(Object, KeyEventArgs)

Declaration
protected virtual void ProcessKeyUp(object sender, KeyEventArgs e)
Parameters
System.Object sender

System.Windows.Forms.KeyEventArgs e

ScrollToItemFromText(String)

Declaration
protected virtual void ScrollToItemFromText(string text)
Parameters
System.String text

SelectAll()

Selects all items if the SelectionMode allows it.

Declaration
public void SelectAll()
Exceptions
System.InvalidOperationException

Selecting all items is not a valid operation in the current selection mode. SelectionMode = + this.selectionMode.ToString() + .

SelectAllText()

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

Declaration
public void SelectAllText()

SelectItemFromText(String)

Declaration
protected virtual int SelectItemFromText(string text)
Parameters
System.String text

Returns
System.Int32

SelectRange(Int32, Int32)

Declaration
public void SelectRange(int startIndex, int endIndex)
Parameters
System.Int32 startIndex

System.Int32 endIndex

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.

ShowPopup()

Declaration
public override void ShowPopup()
Overrides

SyncVisualProperties(RadListDataItem)

Declaration
protected virtual void SyncVisualProperties(RadListDataItem listItem)
Parameters
RadListDataItem listItem

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

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

KeyPress

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

KeyUp

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

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

Declaration
public event EventHandler TextChanged
Event Type
System.EventHandler

VisualItemFormatting

Declaration
public event VisualListItemFormattingEventHandler VisualItemFormatting
Event Type
VisualListItemFormattingEventHandler

Extension Methods