Class RadMultiColumnComboBoxElement

Represents a multi column combo box element. The RadMultiColumnComboBox class is a simple wrapper for the RadMultiColumnComboBoxElement class. The RadMultiColumnComboBox acts to transfer events to and from its corresponding RadMultiColumnComboBoxElement instance. The RadMultiColumnComboBoxElement which is essentially the RadMultiColumnComboBox control may be nested in other telerik controls. The RadMultiColumnComboBoxElement class implements all logical and UI functionality.

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.GridView.dll

Syntax

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

Constructors

RadMultiColumnComboBoxElement()

Declaration
public RadMultiColumnComboBoxElement()

Fields

ReadOnlyChanged

Fires when the ReadOnly property value is changed.

Declaration
public EventHandler ReadOnlyChanged
Field Value
System.EventHandler

Properties

AutoCompleteMode

Gets or sets the mode for the automatic completion feature used in the multi-column combo box.

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

Overrides

AutoFilter

Gets or sets a value indicating whether automatic filtering is enabled based on the entered text.

Declaration
[RadDefaultValue("AutoFilter", typeof(MultiColumnComboPopupForm))]
public virtual bool AutoFilter { get; set; }
Property Value
System.Boolean

AutoSizeDropDownColumnMode

Gets or sets the mode for automatically sizing columns when AutoSizeDropDownToBestFit is enabled.

Declaration
public virtual BestFitColumnMode AutoSizeDropDownColumnMode { get; set; }
Property Value
BestFitColumnMode

AutoSizeDropDownHeight

Determines whether the drop-down height will be auto-sized when filtering is applied.

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

AutoSizeDropDownToBestFit

Determines whether the drop-down portion of the control will be auto-sized to best fit all columns. The DropDownWidth property must be set to its default value (-1) to allow this setting to work properly.

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

BindingContext

Gets or sets the binding context for the multi-column combo box element.

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

The BindingContext for this element.
Overrides

ClearTextOnValidation

Gets or sets a value indicating whether the text should be cleared when validation fails if the text does not match any entry in the DisplayMember column.

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

Columns

Gets a collection that contains the all columns in the MasterGridViewTemplate.

Declaration
public GridViewColumnCollection Columns { get; }
Property Value
GridViewColumnCollection

CurrentState

Gets a value from the PopupEditorState enumerator that represents the current state of the MultiColumnComboBox control.

Declaration
public PopupEditorState CurrentState { get; }
Property Value
PopupEditorState

DataSource

Gets or sets the data source for the multi-column combo box.

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

The object that serves as the data source.
Overrides

DesiredEvents

Gets the event types that this listener is interested in processing.

Declaration
public GridEventType DesiredEvents { get; }
Property Value
GridEventType

A GridEventType value specifying the events to process.
Implements

DesiredProcessMode

Gets the event processing mode that determines when this listener should be called.

Declaration
public GridEventProcessMode DesiredProcessMode { get; }
Property Value
GridEventProcessMode

A GridEventProcessMode value indicating the processing mode.
Implements

DisplayMember

Gets or sets the property name or column name of the data source to display in the combo box text area.

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

A string specifying the name of the property or column to display.
Overrides

DropDownSizingMode

Gets or sets the drop-down sizing mode that determines how the popup can be resized.

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

A SizingMode value that specifies the resizing behavior.
Overrides

EditorControl

The input control hosted in the popup form. In the case of RadMultiColumnComboBoxElement the control is a RadGridView.

Declaration
public RadGridView EditorControl { get; }
Property Value
RadGridView

FormatInfo

This property is not relevant for this class.

Declaration
[RadDescription("FormatInfo", typeof(BaseComboBoxElement))]
[RadDefaultValue("FormatInfo", typeof(BaseComboBoxElement))]
public override IFormatProvider FormatInfo { get; set; }
Property Value
System.IFormatProvider

Overrides

FormatString

This property is not relevant for this class.

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

Overrides

FormattingEnabled

This property is not relevant for this class.

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

Overrides

IndexChanging

Gets a value whether the current row is being changed at the moment.

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

Overrides

IntegralHeight

Gets or sets a value indicating whether the dropdown portion of the combo box is resized to avoid showing partial items.

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

Overrides

Items

This property is not relevant for this class. Use the Rows collection instead.

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

Overrides

MultiColumnPopupForm

The popup form that hosts the RadGridView.

Declaration
public MultiColumnComboPopupForm MultiColumnPopupForm { get; }
Property Value
MultiColumnComboPopupForm

NullText

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

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

The text to display when the value is null.

Priority

Gets the priority level for this event listener in the processing queue.

Declaration
public EventListenerPriority Priority { get; }
Property Value
EventListenerPriority

An EventListenerPriority value indicating the listener priority.
Implements

ReadOnly

Gets or sets a value indicating whether the control is in read-only mode.

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

Rows

Gets a collection that contains the all rows in the MasterGridViewTemplate.

Declaration
public GridViewRowCollection Rows { get; }
Property Value
GridViewRowCollection

SelectedIndex

Gets or sets the index of the currently selected item in the multi-column combo box.

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

The zero-based index of the currently selected item, or -1 if no item is selected.
Overrides

SelectedItem

Gets or sets the currently selected item in the multi-column combo box.

Declaration
[RadDescription("SelectedItem", typeof(BaseComboBoxElement))]
public override object SelectedItem { get; set; }
Property Value
System.Object

The currently selected GridViewRowInfo.
Overrides

SelectedValue

Gets or sets the value of the member property specified by the ValueMember property.

Declaration
[RadDescription("SelectedValue", typeof(BaseComboBoxElement))]
public override object SelectedValue { get; set; }
Property Value
System.Object

The value of the member property specified by the ValueMember property.
Overrides

Value

Gets or sets the value of the selected item in the multi-column combo box.

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

The value of the selected item.
Overrides

ValueMember

Gets or sets the property name or column name of the data source whose contents you want to bind to the SelectedValue property.

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

A string specifying the name of the property or column to use as the value.
Overrides

Virtualized

This property is not relevant for this class. Virtualization is always disabled for multi-column combo boxes.

Declaration
[RadDefaultValue("Virtualized", typeof(BaseComboBoxElement))]
public override bool Virtualized { get; set; }
Property Value
System.Boolean

Overrides

Methods

AnalyzeQueue(List<GridViewEvent>)

Analyzes the queue of grid view events to determine processing requirements.

Declaration
public bool AnalyzeQueue(List<GridViewEvent> events)
Parameters
System.Collections.Generic.List<GridViewEvent> events

The list of events to analyze.
Returns
System.Boolean

true if the events require special processing; otherwise, false.
Implements

ApplyFilter()

Applies filtering to the multi-column combo box based on the current text input and display member.

Declaration
public virtual void ApplyFilter()

BeginEdit()

Begins the edit operation.

Declaration
public override void BeginEdit()
Overrides

BeginUpdate()

Suspends repainting of the multi-column combo box until the EndUpdate() method is called.

Declaration
public override void BeginUpdate()
Overrides

BestFitColumns()

Automatically adjusts the width of all columns based on the content of visible rows.

Declaration
public void BestFitColumns()

BestFitColumns(Boolean, Boolean)

Automatically adjusts the width of all columns based on the content, with options for combo box sizing and row iteration.

Declaration
public void BestFitColumns(bool adjustComboBoxSize, bool bestFitAllRows)
Parameters
System.Boolean adjustComboBoxSize

Determines whether to adjust the drop-down size according to the columns width.
System.Boolean bestFitAllRows

Determines whether to calculate the optimal width by iterating all rows, including non-visible rows.

CheckForCompleteMatchAndUpdateText()

Checks for complete match and update text.

Declaration
protected virtual void CheckForCompleteMatchAndUpdateText()

ClearFilter()

Clears all applied filters on the multi-column combo box.

Declaration
public virtual void ClearFilter()

ClearFilterDescriptor(FilterDescriptor)

Clears the filter descriptor.

Declaration
protected virtual void ClearFilterDescriptor(FilterDescriptor descriptor)
Parameters
FilterDescriptor descriptor

The descriptor.

CreateChildElements()

Called by the element when constructed. Allows inheritors to build the element tree.

Declaration
protected override void CreateChildElements()
Overrides

CreatePopupForm()

Creates the popup instance. You have to override this method in order to provide a popup that is specialized by its content. Example: In a combo box you have to override and provide a specialized class that contains and handles the listbox element.

Declaration
protected override RadPopupControlBase CreatePopupForm()
Returns
RadPopupControlBase

The popup instance.
Overrides

DisposeManagedResources()

Disposes the managed resources.

Declaration
protected override void DisposeManagedResources()
Overrides

DoScrollLineDown()

Executes scroll line down.

Declaration
protected override void DoScrollLineDown()
Overrides

DoScrollLineUp()

Executes scroll line up.

Declaration
protected override void DoScrollLineUp()
Overrides

EndInit()

Ends the initialization of a RadComboBoxElement control that is used on a form or used by another component. The initialization occurs at run time.

Declaration
public override void EndInit()
Overrides

EndUpdate()

Resumes repainting of the multi-column combo box that was suspended by the BeginUpdate() method.

Declaration
public override void EndUpdate()
Overrides

FindAllItems(String)

Finds all items that start with the specified text.

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

The text to search for at the beginning of items.
Returns
System.Collections.ArrayList

An System.Collections.ArrayList containing all matching items.
Overrides

FindItem(String)

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

Declaration
protected override 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.
Overrides

FindItemExact(String)

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

Declaration
protected override 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.
Overrides

FindItemExact(String, String)

Finds the item exact.

Declaration
protected virtual GridViewRowInfo FindItemExact(string text, string field)
Parameters
System.String text

The text.
System.String field

The field.
Returns
GridViewRowInfo

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 override 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.
Overrides

GetActiveItem()

Gets the active item.

Declaration
protected override object GetActiveItem()
Returns
System.Object

Overrides

GetCurrentRow(Boolean)

Gets the current row.

Declaration
protected virtual GridViewRowInfo GetCurrentRow(bool getFirstPossibleIfNoCurrentAvailable)
Parameters
System.Boolean getFirstPossibleIfNoCurrentAvailable

The get first possible if no current available.
Returns
GridViewRowInfo

GetItemHeight(Int32)

Retrieves the height of list items in the multi-column combo box.

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

The zero-based index of the item whose height is to be retrieved.
Returns
System.Int32

The height of the specified item in pixels.
Overrides

GetItemText(Object)

Gets the text representation of the specified item.

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

The item to get the text for.
Returns
System.String

An empty string as this method is not applicable for multi-column combo boxes.
Overrides

GetPopupSize(RadPopupControlBase, Boolean)

Gets the display size for the popup.

Declaration
protected override Size GetPopupSize(RadPopupControlBase popup, bool measure)
Parameters
RadPopupControlBase popup

The popup which size should beretrieved.
System.Boolean measure

True to perform explicit measure, false otherwise.
Returns
System.Drawing.Size

Overrides

GetText(Object)

Gets the text.

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

The item.
Returns
System.String

Overrides

Initialize(Object)

Initializes the multi-column combo box element with the specified value.

Declaration
public override void Initialize(object value)
Parameters
System.Object value

The value to be pre-loaded inside the initialized editor.
Overrides

OnDoubleClick(EventArgs)

Raises the DoubleClick event.

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

Overrides

OnLoaded()

Called when the element has been successfully loaded. That includes loading of all its children as well.

Declaration
protected override void OnLoaded()
Overrides

OnNotifyPropertyChanged(PropertyChangedEventArgs)

Declaration
protected override void OnNotifyPropertyChanged(PropertyChangedEventArgs e)
Parameters
System.ComponentModel.PropertyChangedEventArgs e

Overrides

OnParentChanged(RadElement)

Notifies for a change in the Parent value.

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

The previous parent element (if any)
Overrides

OnPopupClosed(RadPopupClosedEventArgs)

Raises the PopupClosed event.

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

The RadPopupClosedEventArgs instance containing the event data.
Overrides

OnPopupOpening(CancelEventArgs)

Raises the PopupOpening event.

Declaration
protected override void OnPopupOpening(CancelEventArgs e)
Parameters
System.ComponentModel.CancelEventArgs e

The System.ComponentModel.CancelEventArgs instance containing the event data.
Overrides

OnPropertyChanged(RadPropertyChangedEventArgs)

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

Overrides

OnReadOnlyChanged()

Declaration
protected virtual void OnReadOnlyChanged()

PostProcessEvent(GridViewEvent)

Allows additional processing of a grid view event that has been dispatched.

Declaration
public GridViewEventResult PostProcessEvent(GridViewEvent eventData)
Parameters
GridViewEvent eventData

The event data that was processed.
Returns
GridViewEventResult

A GridViewEventResult indicating how the event should be handled.
Implements

PreProcessEvent(GridViewEvent)

Allows previewing of a grid view event that is about to be dispatched.

Declaration
public GridViewEventResult PreProcessEvent(GridViewEvent eventData)
Parameters
GridViewEvent eventData

The event data to be processed.
Returns
GridViewEventResult

A GridViewEventResult indicating how the event should be handled.
Implements

ProcessDeleteKey(KeyEventArgs)

Processes the delete key.

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

The System.Windows.Forms.KeyEventArgs instance containing the event data.
Overrides

ProcessEscKey(KeyEventArgs)

Processes the Escape key to cancel filtering or close the popup.

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

A System.Windows.Forms.KeyEventArgs that contains the event data.
Returns
System.Boolean

true if the event was processed; otherwise, false.
Overrides

ProcessEvent(GridViewEvent)

Core entry point for receiving and processing a grid view event.

Declaration
public GridViewEventResult ProcessEvent(GridViewEvent eventData)
Parameters
GridViewEvent eventData

The event data to be processed.
Returns
GridViewEventResult

A GridViewEventResult indicating how the event should be handled.
Implements

ProcessFilterDescriptor(FilterDescriptor, String)

Processes the filter descriptor.

Declaration
protected virtual void ProcessFilterDescriptor(FilterDescriptor descriptor, string textToSearch)
Parameters
FilterDescriptor descriptor

The descriptor.
System.String textToSearch

The text to search.

ProcessKeyDown(Object, KeyEventArgs)

Processes the key down.

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

The sender.
System.Windows.Forms.KeyEventArgs e

The System.Windows.Forms.KeyEventArgs instance containing the event data.
Overrides

ProcessPageUpDownKeys(KeyEventArgs)

Processes the page up down keys.

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

The System.Windows.Forms.KeyEventArgs instance containing the event data.
Overrides

ProcessReturnKey(KeyEventArgs)

Processes the Enter key

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

An instance of System.Windows.Forms.KeyEventArgs
Overrides

ProcessTextChanged(Object, EventArgs)

Processes the text changed.

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

The sender.
System.EventArgs e

The System.EventArgs instance containing the event data.
Overrides

ProcessTextKeyUp(Object, KeyEventArgs)

Processes the text key up.

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

The sender.
System.Windows.Forms.KeyEventArgs e

The System.Windows.Forms.KeyEventArgs instance containing the event data.
Overrides

ScrollItemIntoView(Object)

Scrolls the item into view.

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

The item.
Overrides

ScrollToHome()

Scrolls to home.

Declaration
protected override void ScrollToHome()
Overrides

SelectFirstRow()

Selects the first row.

Declaration
protected virtual void SelectFirstRow()

SelectNextItem()

Selects the next item.

Declaration
protected override void SelectNextItem()
Overrides

SelectPreviousItem()

Selects the previous item.

Declaration
protected override void SelectPreviousItem()
Overrides

SetActiveItem(Object)

Sets the active item.

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

The item.
Overrides

SetActiveItem(String)

Sets the active item.

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

The text.
Overrides

SetAppendAutoComplete(KeyPressEventArgs)

Sets the append auto complete.

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

The System.Windows.Forms.KeyPressEventArgs instance containing the event data.
Overrides

SetCurrentRowOnReturnOrTabKey(KeyEventArgs)

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

SetEditorControlBindingContext()

Declaration
protected virtual void SetEditorControlBindingContext()

TextBox_TextChanging(Object, TextChangingEventArgs)

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

TextChangingEventArgs e

Overrides

TextBoxPanel_Pasted(Object, EventArgs)

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

System.EventArgs e

Overrides

UnwirePopupFormEvents(RadPopupControlBase)

Unwires the popup form events.

Declaration
protected override void UnwirePopupFormEvents(RadPopupControlBase popup)
Parameters
RadPopupControlBase popup

The popup.
Overrides

WirePopupFormEvents(RadPopupControlBase)

Wires the popup form events.

Declaration
protected override void WirePopupFormEvents(RadPopupControlBase popup)
Parameters
RadPopupControlBase popup

The popup.
Overrides

Extension Methods