Class RadMultiColumnComboBox

Represents a multi column combo box control.

Inheritance
System.Object
RadControl
RadEditorControl
RadMultiColumnComboBox
Inherited Members
Namespace: Telerik.WinControls.UI
Assembly: Telerik.WinControls.GridView.dll

Syntax

[TelerikToolboxCategory("Data Controls")]
public class RadMultiColumnComboBox : RadEditorControl, INotifyPropertyChanged, ISupportInitializeNotification, ISupportInitialize, IComponentTreeHandler, ILayoutHandler, IPCHost, IAnalyticsProvider

Constructors

RadMultiColumnComboBox()

Initializes a new instance of the RadMultiColumnComboBox.

Declaration
public RadMultiColumnComboBox()

Properties

AutoCompleteMode

Specifies the mode for the automatic completion feature used in the MultiColumnComboBox.

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

AutoFilter

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

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

AutoSize

Gets or sets whether the edit control is auto-sized

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

Overrides

AutoSizeDropDownColumnMode

Determines whether the drop-down portion of the control will be auto-sized to best fit all columns.

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

ClearTextOnValidation

Specifies the mode for the Text clearing if the text does not match the text in the DisplayMembar column.

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

Columns

Gets a collection that contains all the columns in the grid contained in the drop down.

Declaration
public GridViewColumnCollection Columns { get; }
Property Value
GridViewColumnCollection

DataSource

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

DblClickRotate

Rotate items on double click in the edit box part

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

DefaultSize

Gets the default size of the control.

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

The default System.Drawing.Size of the control.

DisplayMember

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

DropDownMaxSize

Gets or sets the maximum size allowed for the drop-down of the RadMultiColumnComboBox control.

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

DropDownMinSize

Gets or sets the minimum size allowed for the drop-down of the RadMultiColumnComboBox control.

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

DropDownSizingMode

Gets or sets the drop down sizing mode. The mode can be: horizontal, vertical or a combination of them.

Declaration
[RadDefaultValue("DropDownSizingMode", typeof(RadMultiColumnComboBoxElement))]
public SizingMode DropDownSizingMode { get; set; }
Property Value
SizingMode

DropDownStyle

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

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

EditorControl

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

Declaration
public virtual RadGridView EditorControl { get; }
Property Value
RadGridView

MultiColumnComboBoxElement

Gets the hosted RadMultiColumnComboBoxElement.

Declaration
public RadMultiColumnComboBoxElement MultiColumnComboBoxElement { get; }
Property Value
RadMultiColumnComboBoxElement

MultiColumnPopupForm

Gets the multi column popup form.

Declaration
protected MultiColumnComboPopupForm MultiColumnPopupForm { get; }
Property Value
MultiColumnComboPopupForm

The multi column popup form.

NullText

Gets or sets the text that is displayed when the Text property contains empty string or is null.

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

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

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

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

SelectedItem

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

SelectedValue

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

ShowItemToolTips

Gets or sets a value indicating whether ToolTips are shown for the RadItem objects contained in the RadControl.

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

Overrides

Text

Gets or sets displayed text.

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

Overrides

ValueMember

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

Methods

BestFitColumns()

Widens / shrinks all columns based on the space required by the text in the columns. Applies only on the visible rows.

Declaration
public void BestFitColumns()

BestFitColumns(Boolean, Boolean)

Widens / shrinks all columns based on the space required by the text in the columns.

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

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

Determines whether to calculate the optimal with by iterating all rows (including non-visible rows).

ControlDefinesThemeForElement(RadElement)

Checks whether the element's theme is defined by the control.

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

The element to should be checked.
Returns
System.Boolean

true if the control defines theme for this element, false otherwise.
Overrides
Remarks

If true is returned the ThemeResolutionService would not not set any theme to the element to avoid duplicating the style settings of the element.

CreateChildItems(RadElement)

Creates the child items.

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

The parent.
Overrides

CreateMultiColumnComboBoxElement()

Creates the multi column combo box element.

Declaration
protected virtual RadMultiColumnComboBoxElement CreateMultiColumnComboBoxElement()
Returns
RadMultiColumnComboBoxElement

Dispose(Boolean)

Disposes the specified object.

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

The disposing.
Overrides

EndInit()

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

Declaration
public override void EndInit()
Overrides

IsInputKey(Keys)

Determines whether the specified key data is input key.

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

The key data.
Returns
System.Boolean

Overrides

OnBindingContextChanged(EventArgs)

Raises the BindingContextChanged event.

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

The System.EventArgs instance containing the event data.
Overrides

OnCaseSensitiveChanged(EventArgs)

Raises the CaseSensitiveChanged event.

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

OnDataBindingComplete(GridViewBindingCompleteEventArgs)

Declaration
protected virtual void OnDataBindingComplete(GridViewBindingCompleteEventArgs e)
Parameters
GridViewBindingCompleteEventArgs e

OnDropDownClosed(RadPopupClosedEventArgs)

Raises the DropDownClosed event.

Declaration
protected virtual void OnDropDownClosed(RadPopupClosedEventArgs e)
Parameters
RadPopupClosedEventArgs e

OnDropDownClosing(RadPopupClosingEventArgs)

Raises the DropDownClosing event.

Declaration
protected virtual void OnDropDownClosing(RadPopupClosingEventArgs e)
Parameters
RadPopupClosingEventArgs e

An instance of the RadPopupClosingEventArgs which contains information about the event.

OnDropDownOpened(EventArgs)

Raises the DropDownOpened event.

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

OnDropDownOpening(CancelEventArgs)

Raises the DropDownOpening event.

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

An instance of the CancelEventArgs which contains information about the event.

OnDropDownStyleChanged(EventArgs)

Raises the DropDownStyleChanged event.

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

OnEnter(EventArgs)

Raises the System.Windows.Forms.Control.Enter event.

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

An System.EventArgs that contains the event data.

OnGotFocus(EventArgs)

Raises the System.Windows.Forms.Control.GotFocus event.

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

An System.EventArgs that contains the event data.
Overrides

OnLeave(EventArgs)

Raises the System.Windows.Forms.Control.Leave event.

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

An System.EventArgs that contains the event data.

OnLostFocus(EventArgs)

Raises the System.Windows.Forms.Control.LostFocus event.

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

An System.EventArgs that contains the event data.
Overrides

OnParentChanged(EventArgs)

Raises the ParentChanged event.

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

The System.EventArgs instance containing the event data.
Overrides

OnParentVisibleChanged(EventArgs)

Raises the System.Windows.Forms.Control.VisibleChanged event when the System.Windows.Forms.Control.Visible property value of the control's container changes.

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

An System.EventArgs that contains the event data.

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

OnVisibleChanged(EventArgs)

Fires when the Visible property is changed.

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

An System.EventArgs that contains the event data.
Overrides

ProcessAutoSizeChanged(Boolean)

Processes the auto size changed.

Declaration
protected override void ProcessAutoSizeChanged(bool value)
Parameters
System.Boolean value

The value.
Overrides

ProcessCmdKey(ref Message, Keys)

Processes a command key.

Declaration
protected override bool ProcessCmdKey(ref Message msg, Keys keyData)
Parameters
System.Windows.Forms.Message msg

A System.Windows.Forms.Message, passed by reference, that represents the window message to process.
System.Windows.Forms.Keys keyData

One of the System.Windows.Forms.Keys values that represents the key to process.
Returns
System.Boolean

true if the character was processed by the control; otherwise, false.

ResetBackColorThemeOverrides()

Resets the back color theme overrides.

Declaration
protected override void ResetBackColorThemeOverrides()
Overrides

ResetForeColorThemeOverrides()

Resets the fore color theme overrides.

Declaration
protected override void ResetForeColorThemeOverrides()
Overrides

SetBackColorThemeOverrides()

Sets the back color theme overrides.

Declaration
protected override void SetBackColorThemeOverrides()
Overrides

SetEditorControlBindingContext()

Declaration
protected virtual void SetEditorControlBindingContext()

SetForeColorThemeOverrides()

Sets the fore color theme overrides.

Declaration
protected override void SetForeColorThemeOverrides()
Overrides

UnwireEditorControlDataBindingEvent()

Declaration
protected virtual void UnwireEditorControlDataBindingEvent()

UnwireEvents()

Unwires all events.

Declaration
protected virtual void UnwireEvents()

WireEditorControlDataBindingEvent()

Declaration
protected virtual void WireEditorControlDataBindingEvent()

WireEvents()

Wires all events.

Declaration
protected virtual void WireEvents()

Events

CaseSensitiveChanged

Occurs when the CaseSensitive property has changed.

Declaration
public event EventHandler CaseSensitiveChanged
Event Type
System.EventHandler

DataBindingComplete

Occurs when the data binding process finishes.

Declaration
public event GridViewBindingCompleteEventHandler DataBindingComplete
Event Type
GridViewBindingCompleteEventHandler

DropDownClosed

Occurs when the drop-down window has closed.

Declaration
public event RadPopupClosedEventHandler DropDownClosed
Event Type
RadPopupClosedEventHandler

DropDownClosing

Occurs when the drop-down window is about to close.

Declaration
public event RadPopupClosingEventHandler DropDownClosing
Event Type
RadPopupClosingEventHandler

DropDownOpened

Occurs before the drop-down window appears.

Declaration
public event EventHandler DropDownOpened
Event Type
System.EventHandler

DropDownOpening

Occurs when the drop-down window is about to open.

Declaration
public event RadPopupOpeningEventHandler DropDownOpening
Event Type
RadPopupOpeningEventHandler

DropDownStyleChanged

Occurs when the DropDownStyle property has changed.

Declaration
public event EventHandler DropDownStyleChanged
Event Type
System.EventHandler

ReadOnlyChanged

Fires when the ReadOnly property value is changed.

Declaration
public event EventHandler ReadOnlyChanged
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