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.
Definition
Namespace:Telerik.WinControls.UI
Assembly:Telerik.WinControls.GridView.dll
Syntax:
[ComVisible(false)]
public class RadMultiColumnComboBoxElement : BaseComboBoxElement, INotifyPropertyChanged, ICustomTypeDescriptor, ISupportSystemSkin, IBindableComponent, IComponent, IDisposable, ISupportDrag, ISupportDrop, IShortcutProvider, IStylableElement, IStylableNode, IInputEditor, IValueEditor, ISupportInitialize, IGridViewEventListenerInheritance: objectDisposableObjectRadObjectRadElementVisualElementRadComponentElementRadItemRadEditorElementEditorBaseElementPopupEditorBaseElementBaseComboBoxElementRadMultiColumnComboBoxElement...
Implements:
Inherited Members
Constructors
public RadMultiColumnComboBoxElement()Fields
Fires when the ReadOnly property value is changed.
public EventHandler ReadOnlyChangedProperties
Gets or sets the mode for the automatic completion feature used in the multi-column combo box.
[Browsable(true)]
public override AutoCompleteMode AutoCompleteMode { get; set; }Overrides:
Gets or sets a value indicating whether automatic filtering is enabled based on the entered text.
public virtual bool AutoFilter { get; set; }Gets or sets the mode for automatically sizing columns when AutoSizeDropDownToBestFit is enabled.
public virtual BestFitColumnMode AutoSizeDropDownColumnMode { get; set; }Determines whether the drop-down height will be auto-sized when filtering is applied.
public bool AutoSizeDropDownHeight { get; set; }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.
public bool AutoSizeDropDownToBestFit { get; set; }Gets or sets the binding context for the multi-column combo box element.
public override BindingContext BindingContext { get; set; }The BindingContext for this element.
Overrides:
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.
[Browsable(true)]
public bool ClearTextOnValidation { get; set; }Gets a collection that contains the all columns in the MasterGridViewTemplate.
[Browsable(false)]
public GridViewColumnCollection Columns { get; }Gets a value from the PopupEditorState enumerator that represents the current state of the MultiColumnComboBox control.
public PopupEditorState CurrentState { get; }Gets or sets the data source for the multi-column combo box.
public override object DataSource { get; set; }The object that serves as the data source.
Overrides:
Gets the event types that this listener is interested in processing.
public GridEventType DesiredEvents { get; }A GridEventType value specifying the events to process.
Implements:
Gets the event processing mode that determines when this listener should be called.
public GridEventProcessMode DesiredProcessMode { get; }A GridEventProcessMode value indicating the processing mode.
Implements:
Gets or sets the property name or column name of the data source to display in the combo box text area.
[TypeConverter("System.Windows.Forms.Design.DataMemberFieldConverter, System.Design, Version=2.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a")]
public override string DisplayMember { get; set; }A string specifying the name of the property or column to display.
Overrides:
Gets or sets the drop-down sizing mode that determines how the popup can be resized.
[Browsable(true)]
public override SizingMode DropDownSizingMode { get; set; }A SizingMode value that specifies the resizing behavior.
Overrides:
The input control hosted in the popup form. In the case of RadMultiColumnComboBoxElement the control is a RadGridView.
public RadGridView EditorControl { get; }This property is not relevant for this class.
[Browsable(false)]
public override IFormatProvider FormatInfo { get; set; }Overrides:
This property is not relevant for this class.
public override string FormatString { get; set; }Overrides:
This property is not relevant for this class.
public override bool FormattingEnabled { get; set; }Overrides:
Gets a value whether the current row is being changed at the moment.
protected override bool IndexChanging { get; set; }Overrides:
Gets or sets a value indicating whether the dropdown portion of the combo box is resized to avoid showing partial items.
public override bool IntegralHeight { get; set; }Overrides:
The popup form that hosts the RadGridView.
public MultiColumnComboPopupForm MultiColumnPopupForm { get; }Gets or sets the text that is displayed when the combo box contains a null reference.
public string NullText { get; set; }The text to display when the value is null.
Gets the priority level for this event listener in the processing queue.
public EventListenerPriority Priority { get; }An EventListenerPriority value indicating the listener priority.
Implements:
Gets or sets a value indicating whether the control is in read-only mode.
[Browsable(true)]
public bool ReadOnly { get; set; }Gets a collection that contains the all rows in the MasterGridViewTemplate.
[Browsable(false)]
public GridViewRowCollection Rows { get; }Gets or sets the index of the currently selected item in the multi-column combo box.
[Browsable(true)]
public override int SelectedIndex { get; set; }The zero-based index of the currently selected item, or -1 if no item is selected.
Overrides:
Gets or sets the currently selected item in the multi-column combo box.
[Browsable(false)]
[Bindable(true)]
public override object SelectedItem { get; set; }The currently selected GridViewRowInfo.
Overrides:
Gets or sets the value of the member property specified by the ValueMember property.
[Browsable(false)]
[Bindable(true)]
public override object SelectedValue { get; set; }The value of the member property specified by the ValueMember property.
Overrides:
Gets or sets the value of the selected item in the multi-column combo box.
public override object Value { get; set; }The value of the selected item.
Overrides:
Gets or sets the property name or column name of the data source whose contents you want to bind to the SelectedValue property.
[TypeConverter("System.Windows.Forms.Design.DataMemberFieldConverter, System.Design, Version=2.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a")]
public override string ValueMember { get; set; }A string specifying the name of the property or column to use as the value.
Overrides:
This property is not relevant for this class. Virtualization is always disabled for multi-column combo boxes.
[Browsable(true)]
public override bool Virtualized { get; set; }Overrides:
Methods
Analyzes the queue of grid view events to determine processing requirements.
public bool AnalyzeQueue(List<GridViewEvent> events)The list of events to analyze.
Returns:true if the events require special processing; otherwise, false.
Implements:
Applies filtering to the multi-column combo box based on the current text input and display member.
public virtual void ApplyFilter()Begins the edit operation.
public override void BeginEdit()Overrides:
Suspends repainting of the multi-column combo box until the EndUpdate() method is called.
public override void BeginUpdate()Overrides:
Automatically adjusts the width of all columns based on the content of visible rows.
public void BestFitColumns()Automatically adjusts the width of all columns based on the content, with options for combo box sizing and row iteration.
public void BestFitColumns(bool adjustComboBoxSize, bool bestFitAllRows)Determines whether to adjust the drop-down size according to the columns width.
bestFitAllRowsboolDetermines whether to calculate the optimal width by iterating all rows, including non-visible rows.
Checks for complete match and update text.
protected virtual void CheckForCompleteMatchAndUpdateText()Clears all applied filters on the multi-column combo box.
public virtual void ClearFilter()Clears the filter descriptor.
protected virtual void ClearFilterDescriptor(FilterDescriptor descriptor)The descriptor.
Called by the element when constructed. Allows inheritors to build the element tree.
protected override void CreateChildElements()Overrides:
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.
protected override RadPopupControlBase CreatePopupForm()The popup instance.
Overrides:
Disposes the managed resources.
protected override void DisposeManagedResources()Overrides:
Executes scroll line down.
protected override void DoScrollLineDown()Overrides:
Executes scroll line up.
protected override void DoScrollLineUp()Overrides:
Ends the initialization of a RadComboBoxElement control that is used on a form or used by another component. The initialization occurs at run time.
public override void EndInit()Overrides:
Resumes repainting of the multi-column combo box that was suspended by the BeginUpdate() method.
public override void EndUpdate()Overrides:
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.
Gets the active item.
Gets the current row.
protected virtual GridViewRowInfo GetCurrentRow(bool getFirstPossibleIfNoCurrentAvailable)The get first possible if no current available.
Returns:Gets the display size for the popup.
protected override Size GetPopupSize(RadPopupControlBase popup, bool measure)The popup which size should beretrieved.
measureboolTrue to perform explicit measure, false otherwise.
Returns:Overrides:
Initializes the multi-column combo box element with the specified value.
public override void Initialize(object value)The value to be pre-loaded inside the initialized editor.
Overrides:
Raises the DoubleClick event.
Called when the element has been successfully loaded. That includes loading of all its children as well.
protected override void OnLoaded()Overrides:
Raises the standard .NET PropertyChanged event to notify subscribers of property value changes using the provided event arguments.
protected override void OnNotifyPropertyChanged(PropertyChangedEventArgs e)The PropertyChangedEventArgs containing the property change information.
Overrides:
Notifies for a change in the Parent value.
protected override void OnParentChanged(RadElement previousParent)The previous parent element (if any)
Overrides:
Raises the event.
protected override void OnPopupClosed(RadPopupClosedEventArgs e)The RadPopupClosedEventArgs instance containing the event data.
Overrides:
Raises the event.
protected override void OnPopupOpening(CancelEventArgs e)The CancelEventArgs instance containing the event data.
Overrides:
Called when a property value has changed, handling item-specific property change logic including text, visual state, and animation properties.
protected override void OnPropertyChanged(RadPropertyChangedEventArgs e)The property changed event arguments.
Overrides:
protected virtual void OnReadOnlyChanged()Allows additional processing of a grid view event that has been dispatched.
public GridViewEventResult PostProcessEvent(GridViewEvent eventData)The event data that was processed.
Returns:A GridViewEventResult indicating how the event should be handled.
Implements:
Allows previewing of a grid view event that is about to be dispatched.
public GridViewEventResult PreProcessEvent(GridViewEvent eventData)The event data to be processed.
Returns:A GridViewEventResult indicating how the event should be handled.
Implements:
Processes the delete key.
protected override void ProcessDeleteKey(KeyEventArgs e)The KeyEventArgs instance containing the event data.
Overrides:
Processes the Escape key to cancel filtering or close the popup.
public override bool ProcessEscKey(KeyEventArgs e)A KeyEventArgs that contains the event data.
Returns:true if the event was processed; otherwise, false.
Overrides:
Core entry point for receiving and processing a grid view event.
public GridViewEventResult ProcessEvent(GridViewEvent eventData)The event data to be processed.
Returns:A GridViewEventResult indicating how the event should be handled.
Implements:
Processes the filter descriptor.
protected virtual void ProcessFilterDescriptor(FilterDescriptor descriptor, string textToSearch)The descriptor.
textToSearchstringThe text to search.
Processes the key down.
protected override void ProcessKeyDown(object sender, KeyEventArgs e)The sender.
eKeyEventArgsThe KeyEventArgs instance containing the event data.
Overrides:
Processes the page up down keys.
protected override void ProcessPageUpDownKeys(KeyEventArgs e)The KeyEventArgs instance containing the event data.
Overrides:
Processes the Enter key
public override void ProcessReturnKey(KeyEventArgs e)An instance of KeyEventArgs
Overrides:
Processes the text key up.
protected override void ProcessTextKeyUp(object sender, KeyEventArgs e)The sender.
eKeyEventArgsThe KeyEventArgs instance containing the event data.
Overrides:
Scrolls the item into view.
Scrolls to home.
protected override void ScrollToHome()Overrides:
Selects the first row.
protected virtual void SelectFirstRow()Selects the next item.
protected override void SelectNextItem()Overrides:
Selects the previous item.
protected override void SelectPreviousItem()Overrides:
Sets the active item.
Sets the active item.
Sets the append auto complete.
protected override void SetAppendAutoComplete(KeyPressEventArgs e)The KeyPressEventArgs instance containing the event data.
Overrides:
protected virtual void SetEditorControlBindingContext()protected override void TextBox_TextChanging(object sender, TextChangingEventArgs e)Overrides:
Unwires the popup form events.
protected override void UnwirePopupFormEvents(RadPopupControlBase popup)The popup.
Overrides:
Wires the popup form events.
protected override void WirePopupFormEvents(RadPopupControlBase popup)The popup.
Overrides: