Class BaseComboBoxElement

Represents a combo box element.

Inheritance
System.Object
DisposableObject
RadObject
RadElement
VisualElement
RadComponentElement
RadItem
RadEditorElement
EditorBaseElement
PopupEditorBaseElement
BaseComboBoxElement
RadMultiColumnComboBoxElement
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

[ComVisible(false)]
public abstract class BaseComboBoxElement : PopupEditorBaseElement, INotifyPropertyChanged, ICustomTypeDescriptor, ISupportSystemSkin, IComponent, IDisposable, IBindableComponent, ISupportDrag, ISupportDrop, IShortcutProvider, IStylableElement, IStylableNode, IInputEditor, IValueEditor, ISupportInitialize

Constructors

BaseComboBoxElement()

Initializes a new instance of the RadComboBoxElement class.

Declaration
public BaseComboBoxElement()

Fields

IsDropDownShownProperty

Declaration
public static RadProperty IsDropDownShownProperty
Field Value
RadProperty

lastPressedChar

Declaration
protected char lastPressedChar
Field Value
System.Char

LastTypedText

Declaration
protected string LastTypedText
Field Value
System.String

layoutPanel

Declaration
protected ComboBoxEditorLayoutPanel layoutPanel
Field Value
ComboBoxEditorLayoutPanel

textBox

Declaration
protected RadTextBoxItem textBox
Field Value
RadTextBoxItem

Properties

ArrowButton

Gets the arrow button element.

Declaration
public RadArrowButtonElement ArrowButton { get; }
Property Value
RadArrowButtonElement

ArrowButtonMinWidth

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

AutoCompleteMode

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

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

AutoFilterDelay

Gets or set the value in Milliseconds indicating delay between last key press and filtering operation

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

CaseSensitive

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

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

ComboBoxBorder

Gets the border element.

Declaration
public BorderPrimitive ComboBoxBorder { get; }
Property Value
BorderPrimitive

ComboBoxFill

Gets the fill element.

Declaration
public FillPrimitive ComboBoxFill { get; }
Property Value
FillPrimitive

ComboboxLayoutPanel

Gets a layout panel that contains editor and arrow panel

Declaration
public ComboBoxEditorLayoutPanel ComboboxLayoutPanel { get; }
Property Value
ComboBoxEditorLayoutPanel

DataSource

Gets or sets the data source.

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

DblClickRotate

Rotate items on double click in the edit box part

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

DisplayMember

Gets or sets the property to display.

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

DropDownAnimationEasing

Gets or sets the type of the DropDown animation.

Declaration
[RadPropertyDefaultValue("DropDownAnimationEasing", typeof(BaseComboBoxElement))]
public RadEasingType DropDownAnimationEasing { get; set; }
Property Value
RadEasingType

DropDownAnimationEnabled

Gets or sets a value indicating whether the ComboBox DropDown will be enabled when it shows.

Declaration
[RadPropertyDefaultValue("DropDownAnimationEnabled", typeof(BaseComboBoxElement))]
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
[RadPropertyDefaultValue("DropDownAnimationFrames", typeof(BaseComboBoxElement))]
public int DropDownAnimationFrames { get; set; }
Property Value
System.Int32

DropDownHeight

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

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

DropDownMaxSize

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

DropDownMinSize

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

DropDownSizingMode

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

DropDownStyle

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

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

DropDownWidth

Gets or sets the width of the of the drop-down portion of a combo box.

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

FormatInfo

Gets or sets the IFormatProvider that provides custom formatting behavior.

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

FormatString

Gets or sets the format-specifier characters that indicate how a value is to be displayed.

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

FormattingEnabled

Gets or sets a value indicating whether formatting is applied to the DisplayMember property.

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

IndexChanging

Declaration
protected abstract bool IndexChanging { get; set; }
Property Value
System.Boolean

IntegralHeight

Gets or sets a value indicating whether the control should show or not partial items.

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

IsDropDownShown

Gets a value indicating whether the drop down is shown.

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

IsDroppedDown

Gets a value indicating whether the combo box is displaying its drop-down portion.

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

IsWritable

Gets whether the text input control of the combo box is in editable mode.

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

Items

Gets a collection representing the items contained in this ComboBox.

Declaration
public abstract RadItemCollection Items { get; }
Property Value
RadItemCollection

KeyboardCommandIssued

Gets a value indicating whether a keyboard command has been issued.

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

LimitToList

LimitToList Property

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

MaxDropDownItems

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

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
[RadDefaultValue("MaxLength", typeof(RadTextBoxItem))]
public int MaxLength { get; set; }
Property Value
System.Int32

NullText

Gets or sets the text that is displayed when the ComboBox contains a null reference.

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

ScrollOnMouseWheel

Gets or sets a boolean value determining whether the user can scroll through the items when the popup is closed by using the mouse wheel.

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

SelectedIndex

Gets or sets the index specifying the currently selected item.

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

SelectedItem

Gets or sets the currently selected item.

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

SelectedText

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

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

SelectedValue

Gets or sets value specifying the currently selected item.

Declaration
public abstract 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

Sorted

Gets or sets a value indicating the sort style the of items in the combo box.

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

Text

Gets or sets the displayed text.

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

Overrides

TextboxContentElement

Declaration
public LightVisualElement TextboxContentElement { get; set; }
Property Value
LightVisualElement

TextBoxElement

Gets the TextBoxElement which is used in the ComboBox.

Declaration
public RadTextBoxElement TextBoxElement { get; }
Property Value
RadTextBoxElement

Value

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

Overrides

ValueMember

Gets or sets t he property to use as the actual value for the items.

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

Virtualized

Gets or sets a value indicating whether RadScrollViewer uses UI virtualization.

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

VisualMode

Declaration
public override EditorVisualMode VisualMode { get; }
Property Value
EditorVisualMode

Overrides

Methods

ApplyThemeToPopupForm()

Declaration
protected virtual void ApplyThemeToPopupForm()

BeginEdit()

Declaration
public override void BeginEdit()
Overrides

BeginUpdate()

Call BeginUpdate at the begining of a block that makes many modifications in the GUI EndUpdate()

Declaration
public abstract void BeginUpdate()

CallOnSelectedIndexChanged(EventArgs)

Declaration
public void CallOnSelectedIndexChanged(EventArgs e)
Parameters
System.EventArgs e

CallOnSelectedValueChanged(EventArgs)

Declaration
public void CallOnSelectedValueChanged(EventArgs e)
Parameters
System.EventArgs e

CallOnSortedChanged(EventArgs)

Declaration
public void CallOnSortedChanged(EventArgs e)
Parameters
System.EventArgs e

CallOnTextChanged(EventArgs)

Declaration
public void CallOnTextChanged(EventArgs e)
Parameters
System.EventArgs e

CreateChildElements()

Declaration
protected override void CreateChildElements()
Overrides

DisposeManagedResources()

Declaration
protected override void DisposeManagedResources()
Overrides

DoScrollLineDown()

Declaration
protected abstract void DoScrollLineDown()

DoScrollLineUp()

Declaration
protected abstract void DoScrollLineUp()

EndUpdate()

Call BeginUpdate at the end of a block that makes many modifications in the GUI BeginUpdate()

Declaration
public abstract void EndUpdate()

FindAllItems(String)

Declaration
public abstract ArrayList FindAllItems(string startsWith)
Parameters
System.String startsWith

Returns
System.Collections.ArrayList

FindItem(String)

Finds the first item in the combo box that starts with the specified string.

Declaration
protected abstract object FindItem(string startsWith)
Parameters
System.String startsWith

The String to search for.
Returns
System.Object

The first RadCOmboBoxItem found; returns null if no match is found.

FindItemExact(String)

Finds the first item in the combo box that matches the specified string.

Declaration
protected abstract object FindItemExact(string text)
Parameters
System.String text

The String to search for.
Returns
System.Object

The first item found; returns null if no match is found.

FindItemIndexExact(String)

Finds the index of the item with the specified text. The passed argument is compared with the DisplayMember value for each item in the items collection.

Declaration
protected abstract int FindItemIndexExact(string text)
Parameters
System.String text

The text of the item which index is to be acquired.
Returns
System.Int32

The index of the item if found, otherwise -1.

GetActiveItem()

Declaration
protected virtual object GetActiveItem()
Returns
System.Object

GetItemHeight(Int32)

Call the GetItemHeight member function to retrieve the height of list items in a combo box.

Declaration
public abstract int GetItemHeight(int index)
Parameters
System.Int32 index

Specifies the item of the combo box whose height is to be retrieved.
Returns
System.Int32

GetItemText(Object)

Gets the text of the specified item.

Declaration
public abstract string GetItemText(object item)
Parameters
System.Object item

Returns
System.String

GetText(Object)

Declaration
protected virtual string GetText(object item)
Parameters
System.Object item

Returns
System.String

OnBubbleEvent(RadElement, RoutedEventArgs)

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

RoutedEventArgs args

Overrides

OnCaseSensitiveChanged(EventArgs)

Raises the CaseSensitiveChanged event.

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

OnDoubleClick(EventArgs)

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

Overrides

OnDropDownStyleChanged(EventArgs)

Raises the DropDownStyleChanged event.

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

OnMouseWheel(MouseEventArgs)

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

Overrides

OnNotifyPropertyChanged(String)

Declaration
protected override void OnNotifyPropertyChanged(string propertyName)
Parameters
System.String propertyName

Overrides

OnPopupClosed(RadPopupClosedEventArgs)

Declaration
protected override void OnPopupClosed(RadPopupClosedEventArgs e)
Parameters
RadPopupClosedEventArgs e

Overrides

OnPopupOpened(EventArgs)

Declaration
protected override void OnPopupOpened(EventArgs args)
Parameters
System.EventArgs args

Overrides

OnPropertyChanged(RadPropertyChangedEventArgs)

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

Overrides

OnPropertyChanging(RadPropertyChangingEventArgs)

Declaration
protected override void OnPropertyChanging(RadPropertyChangingEventArgs args)
Parameters
RadPropertyChangingEventArgs args

Overrides

OnSelectedIndexChanged(EventArgs)

Raises the SelectedIndexChanged event.

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

OnSelectedValueChanged(EventArgs)

Raises the SelectedValueChanged event.

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

OnSortedChanged(EventArgs)

Raises the SortedChanged event.

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

OnTunnelEvent(RadElement, RoutedEventArgs)

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

RoutedEventArgs args

Overrides

ProcessDeleteKey(KeyEventArgs)

Declaration
protected virtual void ProcessDeleteKey(KeyEventArgs e)
Parameters
System.Windows.Forms.KeyEventArgs e

ProcessEscKey(KeyEventArgs)

Processes the Escape key

Declaration
public virtual bool ProcessEscKey(KeyEventArgs e)
Parameters
System.Windows.Forms.KeyEventArgs e

An instance of System.Windows.Forms.KeyEventArgs
Returns
System.Boolean

true if the event is processed, false otherwise

ProcessKeyDown(Object, KeyEventArgs)

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

System.Windows.Forms.KeyEventArgs e

ProcessPageUpDownKeys(KeyEventArgs)

Declaration
protected virtual void ProcessPageUpDownKeys(KeyEventArgs e)
Parameters
System.Windows.Forms.KeyEventArgs e

ProcessReturnKey(KeyEventArgs)

Processes the Enter key

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

An instance of System.Windows.Forms.KeyEventArgs

ProcessTextChanged(Object, EventArgs)

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

System.EventArgs e

ProcessTextKeyUp(Object, KeyEventArgs)

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

System.Windows.Forms.KeyEventArgs e

ScrollItemIntoView(Object)

Declaration
protected abstract void ScrollItemIntoView(object item)
Parameters
System.Object item

ScrollToHome()

Declaration
protected abstract void ScrollToHome()

Select(Int32, Int32)

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

Declaration
public void Select(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.

SelectAll()

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

Declaration
public void SelectAll()

SelectAllText(String)

Declaration
public bool SelectAllText(string text)
Parameters
System.String text

Returns
System.Boolean

SelectNextItem()

Declaration
protected virtual void SelectNextItem()

SelectPreviousItem()

Declaration
protected virtual void SelectPreviousItem()

SetActiveItem(Object)

Declaration
protected abstract void SetActiveItem(object item)
Parameters
System.Object item

SetActiveItem(String)

Declaration
protected abstract void SetActiveItem(string text)
Parameters
System.String text

SetAppendAutoComplete(KeyPressEventArgs)

Declaration
protected abstract void SetAppendAutoComplete(KeyPressEventArgs e)
Parameters
System.Windows.Forms.KeyPressEventArgs e

SetSuggestAutoComplete()

Declaration
protected virtual void SetSuggestAutoComplete()

ShowPopup()

Declaration
public override void ShowPopup()
Overrides

TextBox_TextChanging(Object, TextChangingEventArgs)

Declaration
protected virtual void TextBox_TextChanging(object sender, TextChangingEventArgs e)
Parameters
System.Object sender

TextChangingEventArgs e

TextBoxPanel_Pasted(Object, EventArgs)

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

System.EventArgs e

UnwireEvents()

Declaration
protected virtual void UnwireEvents()

WireEvents()

Declaration
protected virtual void WireEvents()

Events

CaseSensitiveChanged

Occurs when the CaseSensitive property has changed.

Declaration
public event EventHandler CaseSensitiveChanged
Event Type
System.EventHandler

DropDownStyleChanged

Declaration
public event EventHandler DropDownStyleChanged
Event Type
System.EventHandler

SelectedIndexChanged

Occurs when the SelectedIndex property has changed.

Declaration
public event EventHandler SelectedIndexChanged
Event Type
System.EventHandler

SelectedValueChanged

Fires when the selected value is changed.

Declaration
public event EventHandler SelectedValueChanged
Event Type
System.EventHandler

SortedChanged

Occurs when the Sorted property has changed.

Declaration
public event EventHandler SortedChanged
Event Type
System.EventHandler

Extension Methods