Class

RadMultiColumnComboBoxElement

Declaration

public RadMultiColumnComboBoxElement()

Fires when the ReadOnly property value is changed.

Declaration

public EventHandler ReadOnlyChanged

Field Value

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

Declaration

[Browsable(true)]
public override AutoCompleteMode AutoCompleteMode { get; set; }

Property Value

Overrides BaseComboBoxElement.AutoCompleteMode

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

Declaration

public virtual bool AutoFilter { get; set; }

Property Value

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

Declaration

public virtual BestFitColumnMode AutoSizeDropDownColumnMode { get; set; }

Property Value

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

Declaration

public bool AutoSizeDropDownHeight { get; set; }

Property Value

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

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

Declaration

public override BindingContext BindingContext { get; set; }

Property Value

Overrides RadObject.BindingContext

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

[Browsable(true)]
public bool ClearTextOnValidation { get; set; }

Property Value

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

Declaration

[Browsable(false)]
public GridViewColumnCollection Columns { get; }

Property Value

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

Declaration

public PopupEditorState CurrentState { get; }

Property Value

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

Declaration

public override object DataSource { get; set; }

Property Value

Overrides BaseComboBoxElement.DataSource

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

Declaration

public GridEventType DesiredEvents { get; }

Property Value

Implements IGridViewEventListener.DesiredEvents

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

Declaration

public GridEventProcessMode DesiredProcessMode { get; }

Property Value

Implements IGridViewEventListener.DesiredProcessMode

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

Declaration

[TypeConverter("System.Windows.Forms.Design.DataMemberFieldConverter, System.Design, Version=2.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a")]
public override string DisplayMember { get; set; }

Property Value

Overrides BaseComboBoxElement.DisplayMember

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

Declaration

[Browsable(true)]
public override SizingMode DropDownSizingMode { get; set; }

Property Value

Overrides BaseComboBoxElement.DropDownSizingMode

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

This property is not relevant for this class.

Declaration

[Browsable(false)]
public override IFormatProvider FormatInfo { get; set; }

Property Value

Overrides BaseComboBoxElement.FormatInfo

This property is not relevant for this class.

Declaration

public override string FormatString { get; set; }

Property Value

Overrides BaseComboBoxElement.FormatString

This property is not relevant for this class.

Declaration

public override bool FormattingEnabled { get; set; }

Property Value

Overrides BaseComboBoxElement.FormattingEnabled

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

Declaration

protected override bool IndexChanging { get; set; }

Property Value

Overrides BaseComboBoxElement.IndexChanging

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

Declaration

public override bool IntegralHeight { get; set; }

Property Value

Overrides BaseComboBoxElement.IntegralHeight

The popup form that hosts the RadGridView.

Declaration

public MultiColumnComboPopupForm MultiColumnPopupForm { get; }

Property Value

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

Declaration

public string NullText { get; set; }

Property Value

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

Declaration

public EventListenerPriority Priority { get; }

Property Value

Implements IGridViewEventListener.Priority

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

Declaration

[Browsable(true)]
public bool ReadOnly { get; set; }

Property Value

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

Declaration

[Browsable(false)]
public GridViewRowCollection Rows { get; }

Property Value

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

Declaration

[Browsable(true)]
public override int SelectedIndex { get; set; }

Property Value

Overrides BaseComboBoxElement.SelectedIndex

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

Declaration

[Browsable(false)]
[Bindable(true)]
public override object SelectedItem { get; set; }

Property Value

Overrides BaseComboBoxElement.SelectedItem

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

Declaration

[Browsable(false)]
[Bindable(true)]
public override object SelectedValue { get; set; }

Property Value

Overrides BaseComboBoxElement.SelectedValue

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

Declaration

public override object Value { get; set; }

Property Value

Overrides BaseComboBoxElement.Value

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

Declaration

[TypeConverter("System.Windows.Forms.Design.DataMemberFieldConverter, System.Design, Version=2.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a")]
public override string ValueMember { get; set; }

Property Value

Overrides BaseComboBoxElement.ValueMember

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

Declaration

[Browsable(true)]
public override bool Virtualized { get; set; }

Property Value

Overrides BaseComboBoxElement.Virtualized

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

Declaration

public bool AnalyzeQueue(List<GridViewEvent> events)

Parameters

Returns

Implements IGridViewEventListener.AnalyzeQueue(List<GridViewEvent>)

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

Declaration

public virtual void ApplyFilter()

Begins the edit operation.

Declaration

public override void BeginEdit()

Overrides BaseComboBoxElement.BeginEdit()

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

Declaration

public override void BeginUpdate()

Overrides BaseComboBoxElement.BeginUpdate()

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

Declaration

public void BestFitColumns()

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

Checks for complete match and update text.

Declaration

protected virtual void CheckForCompleteMatchAndUpdateText()

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

Declaration

public virtual void ClearFilter()

Clears the filter descriptor.

Declaration

protected virtual void ClearFilterDescriptor(FilterDescriptor descriptor)

Parameters

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

Declaration

protected override void CreateChildElements()

Overrides BaseComboBoxElement.CreateChildElements()

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

Overrides PopupEditorBaseElement.CreatePopupForm()

Disposes the managed resources.

Declaration

protected override void DisposeManagedResources()

Overrides BaseComboBoxElement.DisposeManagedResources()

Executes scroll line down.

Declaration

protected override void DoScrollLineDown()

Overrides BaseComboBoxElement.DoScrollLineDown()

Executes scroll line up.

Declaration

protected override void DoScrollLineUp()

Overrides BaseComboBoxElement.DoScrollLineUp()

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 EditorBaseElement.EndInit()

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

Declaration

public override void EndUpdate()

Overrides BaseComboBoxElement.EndUpdate()

Finds all items that start with the specified text.

Declaration

public override ArrayList FindAllItems(string startsWith)

Parameters

Returns

Overrides BaseComboBoxElement.FindAllItems(string)

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

Declaration

protected override object FindItem(string startsWith)

Parameters

Returns

Overrides BaseComboBoxElement.FindItem(string)

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

Declaration

protected override object FindItemExact(string text)

Parameters

Returns

Overrides BaseComboBoxElement.FindItemExact(string)

Finds the item exact.

Declaration

protected virtual GridViewRowInfo FindItemExact(string text, string field)

Parameters

Returns

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

Returns

Overrides BaseComboBoxElement.FindItemIndexExact(string)

Gets the active item.

Declaration

protected override object GetActiveItem()

Returns

Overrides BaseComboBoxElement.GetActiveItem()

Gets the current row.

Declaration

protected virtual GridViewRowInfo GetCurrentRow(bool getFirstPossibleIfNoCurrentAvailable)

Parameters

Returns

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

Declaration

public override int GetItemHeight(int index)

Parameters

Returns

Overrides BaseComboBoxElement.GetItemHeight(int)

Gets the text representation of the specified item.

Declaration

public override string GetItemText(object item)

Parameters

Returns

Overrides BaseComboBoxElement.GetItemText(object)

Gets the display size for the popup.

Declaration

protected override Size GetPopupSize(RadPopupControlBase popup, bool measure)

Parameters

Returns

Overrides PopupEditorBaseElement.GetPopupSize(RadPopupControlBase, bool)

Gets the text.

Declaration

protected override string GetText(object item)

Parameters

Returns

Overrides BaseComboBoxElement.GetText(object)

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

Declaration

public override void Initialize(object value)

Parameters

Overrides EditorBaseElement.Initialize(object)

Raises the DoubleClick event.

Declaration

protected override void OnDoubleClick(EventArgs e)

Parameters

Overrides BaseComboBoxElement.OnDoubleClick(EventArgs)

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

Declaration

protected override void OnLoaded()

Overrides RadElement.OnLoaded()

Raises the standard .NET PropertyChanged event to notify subscribers of property value changes using the provided event arguments.

Declaration

protected override void OnNotifyPropertyChanged(PropertyChangedEventArgs e)

Parameters

Overrides RadObject.OnNotifyPropertyChanged(PropertyChangedEventArgs)

Notifies for a change in the Parent value.

Declaration

protected override void OnParentChanged(RadElement previousParent)

Parameters

Overrides RadElement.OnParentChanged(RadElement)

Raises the event.

Declaration

protected override void OnPopupClosed(RadPopupClosedEventArgs e)

Parameters

Overrides BaseComboBoxElement.OnPopupClosed(RadPopupClosedEventArgs)

Raises the event.

Declaration

protected override void OnPopupOpening(CancelEventArgs e)

Parameters

Overrides PopupEditorBaseElement.OnPopupOpening(CancelEventArgs)

Called when a property value has changed, handling item-specific property change logic including text, visual state, and animation properties.

Declaration

protected override void OnPropertyChanged(RadPropertyChangedEventArgs e)

Parameters

Overrides BaseComboBoxElement.OnPropertyChanged(RadPropertyChangedEventArgs)

Declaration

protected virtual void OnReadOnlyChanged()

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

Declaration

public GridViewEventResult PostProcessEvent(GridViewEvent eventData)

Parameters

Returns

Implements IGridViewEventListener.PostProcessEvent(GridViewEvent)

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

Declaration

public GridViewEventResult PreProcessEvent(GridViewEvent eventData)

Parameters

Returns

Implements IGridViewEventListener.PreProcessEvent(GridViewEvent)

Processes the delete key.

Declaration

protected override void ProcessDeleteKey(KeyEventArgs e)

Parameters

Overrides BaseComboBoxElement.ProcessDeleteKey(KeyEventArgs)

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

Declaration

public override bool ProcessEscKey(KeyEventArgs e)

Parameters

Returns

Overrides BaseComboBoxElement.ProcessEscKey(KeyEventArgs)

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

Declaration

public GridViewEventResult ProcessEvent(GridViewEvent eventData)

Parameters

Returns

Implements IGridViewEventListener.ProcessEvent(GridViewEvent)

Processes the filter descriptor.

Declaration

protected virtual void ProcessFilterDescriptor(FilterDescriptor descriptor, string textToSearch)

Parameters

Processes the key down.

Declaration

protected override void ProcessKeyDown(object sender, KeyEventArgs e)

Parameters

Overrides BaseComboBoxElement.ProcessKeyDown(object, KeyEventArgs)

Processes the page up down keys.

Declaration

protected override void ProcessPageUpDownKeys(KeyEventArgs e)

Parameters

Overrides BaseComboBoxElement.ProcessPageUpDownKeys(KeyEventArgs)

Processes the Enter key

Declaration

public override void ProcessReturnKey(KeyEventArgs e)

Parameters

Overrides BaseComboBoxElement.ProcessReturnKey(KeyEventArgs)

Processes the text changed.

Declaration

protected override void ProcessTextChanged(object sender, EventArgs e)

Parameters

Overrides BaseComboBoxElement.ProcessTextChanged(object, EventArgs)

Processes the text key up.

Declaration

protected override void ProcessTextKeyUp(object sender, KeyEventArgs e)

Parameters

Overrides BaseComboBoxElement.ProcessTextKeyUp(object, KeyEventArgs)

Scrolls the item into view.

Declaration

protected override void ScrollItemIntoView(object item)

Parameters

Overrides BaseComboBoxElement.ScrollItemIntoView(object)

Scrolls to home.

Declaration

protected override void ScrollToHome()

Overrides BaseComboBoxElement.ScrollToHome()

Selects the first row.

Declaration

protected virtual void SelectFirstRow()

Selects the next item.

Declaration

protected override void SelectNextItem()

Overrides BaseComboBoxElement.SelectNextItem()

Selects the previous item.

Declaration

protected override void SelectPreviousItem()

Overrides BaseComboBoxElement.SelectPreviousItem()

Sets the active item.

Declaration

protected override void SetActiveItem(object item)

Parameters

Overrides BaseComboBoxElement.SetActiveItem(object)

Sets the active item.

Declaration

protected override void SetActiveItem(string text)

Parameters

Overrides BaseComboBoxElement.SetActiveItem(string)

Sets the append auto complete.

Declaration

protected override void SetAppendAutoComplete(KeyPressEventArgs e)

Parameters

Overrides BaseComboBoxElement.SetAppendAutoComplete(KeyPressEventArgs)

Declaration

protected virtual void SetCurrentRowOnReturnOrTabKey(KeyEventArgs e)