Class MultiSelectionComboBox

Inheritance
System.Object
ButtonEdit
MultiSelectionComboBox
Inherited Members
Namespace: Syncfusion.Windows.Forms.Tools
Assembly: Syncfusion.Tools.Windows.dll
Syntax
public class MultiSelectionComboBox : ButtonEdit, IThemeProvider, IEditControlsEmbed, IButtonEditParent, IPopupParent, IPopupItem, IThemedControl, ISupportInitialize, INonClientPaintingSupport, IVisualStyle

Constructors

MultiSelectionComboBox()

Initializes a new instance of the MultiSelectionComboboxControl class.

Declaration
public MultiSelectionComboBox()
Remarks

The MultiSelectionComboboxControl class also creates the controls that it hosts such as the MultiSelectionComboBox control.

Fields

HandleDelimiterUpdate

To handle DelimiterUpdate

Declaration
public bool HandleDelimiterUpdate
Field Value
Type
System.Boolean

Properties

AutoSizeMode

Gets/Sets the AutoSizeMode

Declaration
public AutoSizeModes AutoSizeMode { get; set; }
Property Value
Type
AutoSizeModes

AutoSuggestMode

Gets/Sets the AutoCompleteMode

Declaration
public AutoSuggestMode AutoSuggestMode { get; set; }
Property Value
Type
AutoSuggestMode

Buttons

Gets the collection of Buttons

Declaration
public ButtonEdit.ButtonEditChildButtonCollection Buttons { get; }
Property Value
Type
ButtonEdit.ButtonEditChildButtonCollection

DataSource

Gets or sets the data source for this System.Windows.Forms.ListControl object.

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

DelimiterChar

Gets/Sets the Delimiter Character by which selectedItems can be separated.

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

DisplayMember

Gets or sets a string that specifies the property of the data source whose contents you want to display.

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

DisplayMode

Gets/Sets the SelectionMode

Declaration
public DisplayMode DisplayMode { get; set; }
Property Value
Type
DisplayMode

DropDownButton

Gets/Sets the DropDown Button.

Declaration
public ButtonEditChildButton DropDownButton { get; }
Property Value
Type
ButtonEditChildButton

DropDownHeight

Gets/Sets the PopupControl height

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

DropDownWidth

Gets/Sets the DropDown control width

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

EmptyResultText

Gets/Sets the Empty Result Text which gets displayed in DropDown window upon no match found for user input.

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

GroupHeaderBackColor

Gets/Sets the DropDown Grouping Header back color

Declaration
public Color GroupHeaderBackColor { get; set; }
Property Value
Type
System.Drawing.Color

GroupHeaderCollection

Gets the GroupHeaderCollection for Header text Localization purpose

Declaration
public List<HeaderTextLocalizer> GroupHeaderCollection { get; }
Property Value
Type
System.Collections.Generic.List<HeaderTextLocalizer>

GroupHeaderForeColor

Gets/Sets DropDown window GroupHeader ForeColor

Declaration
public Color GroupHeaderForeColor { get; set; }
Property Value
Type
System.Drawing.Color

GroupHeaderSeparatorColor

Gets/Sets the DropDown Group Header Separator color

Declaration
public Color GroupHeaderSeparatorColor { get; set; }
Property Value
Type
System.Drawing.Color

IsDroppedDown

Gets whether the drop-down window is displayed or not.

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

Items

Gets an object representing the collection of the items contained in this MultiSelectionComboBox.

Declaration
public MultiSelectionComboBox.ObjectCollection Items { get; }
Property Value
Type
MultiSelectionComboBox.ObjectCollection

ItemsHeight

Gets or sets the height of an item in the MultiSelectionComboBox drop down window.

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

MaxDropDownItems

Gets/Sets the Maximum number of DropDown Items

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

PopupControl

Gets the PopupContainerControl to Display DropDown window

Declaration
public ComboBoxPopupControl PopupControl { get; }
Property Value
Type
ComboBoxPopupControl

SelectedIndex

Gets/Sets the Selected Index

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

SelectedItem

Gets or sets currently selected item

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

SelectedItems

Declaration
public MultiSelectionComboBox.SelectedObjectCollection SelectedItems { get; }
Property Value
Type
MultiSelectionComboBox.SelectedObjectCollection

SelectedValue

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

ShowCheckBox

Gets/Sets whether the CheckBox needs to be displayed in DropDown

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

ShowGroups

Gets/ Set whether the DropDown Items can be Grouped based on initial character

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

Style

Gets of sets the style of the MultiSelectionComboBox

Declaration
public MultiSelectionComboBoxStyle Style { get; set; }
Property Value
Type
MultiSelectionComboBoxStyle

Text

Gets/Sets the MultiSelectionComboBox Text

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

TickColor

Gets/Sets the DropDown items check marker color

Declaration
public Color TickColor { get; set; }
Property Value
Type
System.Drawing.Color

ValueMember

Gets or sets a string that specifies the property of the data source from which to draw the value.

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

VisualItemBackColor

Gets/Sets the VisualItem BackColor

Declaration
public Color VisualItemBackColor { get; set; }
Property Value
Type
System.Drawing.Color

VisualItemBorderColor

Gets/Sets the VisualItem Border Color

Declaration
public Color VisualItemBorderColor { get; set; }
Property Value
Type
System.Drawing.Color

VisualItemDisplayMember

Gets or sets a string that specifies the property to display the value for the VisualItems, when VisualItemInputMode is set as VisualItemMode.

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

VisualItemForeColor

Gets/Sets the VisualItem ForeColor

Declaration
public Color VisualItemForeColor { get; set; }
Property Value
Type
System.Drawing.Color

VisualItemInputMode

Gets/Sets the VisualItemInput Mode.

Declaration
public VisualItemInputMode VisualItemInputMode { get; set; }
Property Value
Type
VisualItemInputMode

VisualItemRowCount

To specify the Row count of VisualItem in Scrolling This property is applicable when AutoSizeModes is specified as None and DisplayMode is set as VisualItem.

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

VisualItems

Gets/Sets the VisualItem collection.

Declaration
public ButtonEdit.VisualItemCollection VisualItems { get; }
Property Value
Type
ButtonEdit.VisualItemCollection

VisualItemSelectionColor

Gets/Sets the VisualItem background color upon selection

Declaration
public Color VisualItemSelectionColor { get; set; }
Property Value
Type
System.Drawing.Color

VisualItemSelectionForeColor

Gets/Sets the VisualItem text color upon selection

Declaration
public Color VisualItemSelectionForeColor { get; set; }
Property Value
Type
System.Drawing.Color

Methods

AddVisualItem(Object)

Adds Visual Item in ComboBoxAutoComplete

Declaration
public void AddVisualItem(object Item)
Parameters
Type Name Description
System.Object Item

AttachTextBox()

To Attach TextBox

Declaration
public override void AttachTextBox()
Overrides

CreateAccessibilityInstance()

Declaration
protected override AccessibleObject CreateAccessibilityInstance()
Returns
Type
System.Windows.Forms.AccessibleObject

CreateTextBox()

To Create TextBox

Declaration
protected override TextBoxExt CreateTextBox()
Returns
Type
TextBoxExt
Overrides

DetachTextBox()

To Deattach TextBox

Declaration
public override void DetachTextBox()
Overrides

Dispose(Boolean)

Cleans up any resources being used.

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

Bool disposing
Overrides

GetDataManager(Object)

Returns the BindingManagerBase for the datasource.

Declaration
public BindingManagerBase GetDataManager(object dataSource)
Parameters
Type Name Description
System.Object dataSource
Returns
Type
System.Windows.Forms.BindingManagerBase

GetItemText(Object)

To return display member column

Declaration
public string GetItemText(object item)
Parameters
Type Name Description
System.Object item
Returns
Type
System.String

HandleTextBoxKeyDownEvent(Object, KeyEventArgs)

This event will be triggered once Key pressed in TextBox

Declaration
protected void HandleTextBoxKeyDownEvent(object sender, KeyEventArgs e)
Parameters
Type Name Description
System.Object sender
System.Windows.Forms.KeyEventArgs e

LockWindowUpdate(IntPtr)

To Reduce Flickering WINAPI

Declaration
public static bool LockWindowUpdate(IntPtr hWndLock)
Parameters
Type Name Description
System.IntPtr hWndLock
Returns
Type
System.Boolean

OnControlAdded(ControlEventArgs)

This will be triggered once control is added

Declaration
protected override void OnControlAdded(ControlEventArgs e)
Parameters
Type Name Description
System.Windows.Forms.ControlEventArgs e

OnControlRemoved(ControlEventArgs)

This will be triggered once control is removed

Declaration
protected override void OnControlRemoved(ControlEventArgs e)
Parameters
Type Name Description
System.Windows.Forms.ControlEventArgs e

OnDataManagerPositionChanged()

Declaration
protected void OnDataManagerPositionChanged()

OnDataSourceChanged(EventArgs)

Raises the DataSourceChanged event.

Declaration
protected virtual void OnDataSourceChanged(EventArgs e)
Parameters
Type Name Description
System.EventArgs e

The System.EventArgs instance containing the event data.

OnEndInit()

This will be triggered once initialization is over

Declaration
protected override void OnEndInit()
Overrides

OnFontChanged(EventArgs)

On Font Changed

Declaration
protected override void OnFontChanged(EventArgs e)
Parameters
Type Name Description
System.EventArgs e

OnForeColorChanged(EventArgs)

Declaration
protected override void OnForeColorChanged(EventArgs e)
Parameters
Type Name Description
System.EventArgs e

OnLayout(LayoutEventArgs)

Occurs on layout is changed

Declaration
protected override void OnLayout(LayoutEventArgs levent)
Parameters
Type Name Description
System.Windows.Forms.LayoutEventArgs levent
Overrides

OnMouseMove(MouseEventArgs)

Declaration
protected override void OnMouseMove(MouseEventArgs e)
Parameters
Type Name Description
System.Windows.Forms.MouseEventArgs e

OnSizeChanged(EventArgs)

Occurs on Size changed

Declaration
protected override void OnSizeChanged(EventArgs e)
Parameters
Type Name Description
System.EventArgs e
Overrides

ProcessCmdKey(ref Message, Keys)

Declaration
protected override bool ProcessCmdKey(ref Message msg, Keys keyData)
Parameters
Type Name Description
System.Windows.Forms.Message msg
System.Windows.Forms.Keys keyData
Returns
Type
System.Boolean

ResetAutoSizeMode()

To Reset the AutoSizeMode

Declaration
public void ResetAutoSizeMode()

ResetAutoSuggestMode()

To Reset AutoCompleteMode

Declaration
public void ResetAutoSuggestMode()

ResetDelimiterChar()

To Reset the DelimiterChar

Declaration
public void ResetDelimiterChar()

ResetDisplayMember()

To Reset Display member.

Declaration
public void ResetDisplayMember()

ResetDisplayMode()

To Reset the DisplayMode

Declaration
public void ResetDisplayMode()

ResetDropDownHeight()

To Reset the DropDownHeight

Declaration
public void ResetDropDownHeight()

ResetDropDownWidth()

To Reset the DropDownWidth

Declaration
public void ResetDropDownWidth()

ResetEmptyResultText()

To Reset the EmptyResultText

Declaration
public void ResetEmptyResultText()

ResetGroupHeaderBackColor()

To Reset the GroupHeaderBackColor

Declaration
public void ResetGroupHeaderBackColor()

ResetGroupHeaderForeColor()

To reset GroupHeaderForeColor

Declaration
public void ResetGroupHeaderForeColor()

ResetGroupHeaderSeparatorColor()

To reset GroupHeaderSeparatorColor

Declaration
public void ResetGroupHeaderSeparatorColor()

ResetItemsHeight()

To Reset the ItemsHeight

Declaration
public void ResetItemsHeight()

ResetMaxDropDownItems()

To Reset the MaximumDropDownItems

Declaration
public void ResetMaxDropDownItems()

ResetSelectedIndex()

To Reset the SelectedIndex

Declaration
public void ResetSelectedIndex()

ResetSelectedValue()

To Reset the SelectedValue

Declaration
public void ResetSelectedValue()

ResetShowCheckBox()

To reset ShowCheckBox visibility

Declaration
public void ResetShowCheckBox()

ResetShowGroups()

To reset ShowGroups

Declaration
public void ResetShowGroups()

ResetText()

To Reset the Text

Declaration
public void ResetText()

ResetTickColor()

To Reset the TickColor

Declaration
public void ResetTickColor()

ResetValueMember()

To Reset Value member.

Declaration
public void ResetValueMember()

ResetVisualItemBackColor()

To Reset the VisualItemBackColor

Declaration
public void ResetVisualItemBackColor()

ResetVisualItemBorderColor()

To Reset the VisualItemBorderColor

Declaration
public void ResetVisualItemBorderColor()

ResetVisualItemDisplayMember()

To Reset VisualItemDisplayMember

Declaration
public void ResetVisualItemDisplayMember()

ResetVisualItemForeColor()

To Reset the VisualItemForeColor

Declaration
public void ResetVisualItemForeColor()

ResetVisualItemInputMode()

To reset Visual Item input mode

Declaration
public void ResetVisualItemInputMode()

ResetVisualItemRowCount()

To Reset the VisualItemRowCount

Declaration
public void ResetVisualItemRowCount()

ResetVisualItemSelectionColor()

To Reset the VisualItemSelectionColor

Declaration
public void ResetVisualItemSelectionColor()

ResetVisualItemSelectionForeColor()

To Reset the VisualItemSelectionForeColor

Declaration
public void ResetVisualItemSelectionForeColor()

SelectAll()

Method to select all the items in DropDown

Declaration
public void SelectAll()

SetBoundsCore(Int32, Int32, Int32, Int32, BoundsSpecified)

To set bounds of control

Declaration
protected override void SetBoundsCore(int x, int y, int width, int height, BoundsSpecified specified)
Parameters
Type Name Description
System.Int32 x
System.Int32 y
System.Int32 width
System.Int32 height
System.Windows.Forms.BoundsSpecified specified
Overrides

SetItemCore(Int32, Object)

Sets the internal items.

Declaration
protected void SetItemCore(int index, object value)
Parameters
Type Name Description
System.Int32 index

The index of item.
System.Object value

The value.

SetItemsCore(IList)

Declaration
protected void SetItemsCore(IList items)
Parameters
Type Name Description
System.Collections.IList items

ShouldSerializeAutoSizeMode()

To indicate whether to serialize AutoSizeMode

Declaration
public bool ShouldSerializeAutoSizeMode()
Returns
Type
System.Boolean

ShouldSerializeAutoSuggestMode()

Indicates whether to serialize AutoCompleteMode

Declaration
public bool ShouldSerializeAutoSuggestMode()
Returns
Type
System.Boolean

ShouldSerializeDelimiterChar()

To indicate whether to serialize DelimiterChar

Declaration
public bool ShouldSerializeDelimiterChar()
Returns
Type
System.Boolean

ShouldSerializeDisplayMember()

To indicate whether to serialize Display Member

Declaration
public bool ShouldSerializeDisplayMember()
Returns
Type
System.Boolean

ShouldSerializeDisplayMode()

To indicate whether to serialize DisplayMode

Declaration
public bool ShouldSerializeDisplayMode()
Returns
Type
System.Boolean

ShouldSerializeDropDownHeight()

To indicate whether to serialize PopupHeight

Declaration
public bool ShouldSerializeDropDownHeight()
Returns
Type
System.Boolean

ShouldSerializeDropDownWidth()

To indicate whether to serialize PopupWidth

Declaration
public bool ShouldSerializeDropDownWidth()
Returns
Type
System.Boolean

ShouldSerializeEmptyResultText()

To indicate whether to serialize EmptyResultText

Declaration
public bool ShouldSerializeEmptyResultText()
Returns
Type
System.Boolean

ShouldSerializeGroupHeaderBackColor()

To indicate whether to serialize GroupHeaderBackColor

Declaration
public bool ShouldSerializeGroupHeaderBackColor()
Returns
Type
System.Boolean

ShouldSerializeGroupHeaderForeColor()

To Specify GroupHeaderForeColor to be serialized or not

Declaration
public bool ShouldSerializeGroupHeaderForeColor()
Returns
Type
System.Boolean

ShouldSerializeGroupHeaderSeparatorColor()

To Specify whether GroupHeader separator color can be serialized or not

Declaration
public bool ShouldSerializeGroupHeaderSeparatorColor()
Returns
Type
System.Boolean

ShouldSerializeItemsHeight()

To indicate whether to serialize ItemsHeight

Declaration
public bool ShouldSerializeItemsHeight()
Returns
Type
System.Boolean

ShouldSerializeMaxDropDownItems()

To indicate whether to serialize MaximumDropDownItems

Declaration
public bool ShouldSerializeMaxDropDownItems()
Returns
Type
System.Boolean

ShouldSerializeSelectedIndex()

To indicate whether to serialize SelectedIndex

Declaration
public bool ShouldSerializeSelectedIndex()
Returns
Type
System.Boolean

ShouldSerializeSelectedValue()

To indicate whether to serialize SelectedValue

Declaration
public bool ShouldSerializeSelectedValue()
Returns
Type
System.Boolean

ShouldSerializeShowCheckBox()

To Specify whether ShowCheckBox can be serialized or not

Declaration
public bool ShouldSerializeShowCheckBox()
Returns
Type
System.Boolean

ShouldSerializeShowGroups()

To Specify ShowGroups to be serialized or not

Declaration
public bool ShouldSerializeShowGroups()
Returns
Type
System.Boolean

ShouldSerializeText()

To indicate whether to serialize Text

Declaration
public bool ShouldSerializeText()
Returns
Type
System.Boolean

ShouldSerializeTickColor()

To indicate whether to serialize TickColor

Declaration
public bool ShouldSerializeTickColor()
Returns
Type
System.Boolean

ShouldSerializeValueMember()

To indicate whether to serialize Value Member

Declaration
public bool ShouldSerializeValueMember()
Returns
Type
System.Boolean

ShouldSerializeVisualItemBackColor()

To indicate whether to serialize VisualItemBackColor

Declaration
public bool ShouldSerializeVisualItemBackColor()
Returns
Type
System.Boolean

ShouldSerializeVisualItemBorderColor()

To indicate whether to serialize VisualItemBorderColor

Declaration
public bool ShouldSerializeVisualItemBorderColor()
Returns
Type
System.Boolean

ShouldSerializeVisualItemDisplayMember()

To indicate whether to serialize VisualItemDisplayMember

Declaration
public bool ShouldSerializeVisualItemDisplayMember()
Returns
Type
System.Boolean

ShouldSerializeVisualItemForeColor()

To indicate whether to serialize VisualItemForeColor

Declaration
public bool ShouldSerializeVisualItemForeColor()
Returns
Type
System.Boolean

ShouldSerializeVisualItemInputMode()

Indicate whether to serialize VisualItem Input Mode

Declaration
public bool ShouldSerializeVisualItemInputMode()
Returns
Type
System.Boolean

ShouldSerializeVisualItemRowCount()

To indicate whether to serialize VisualItemRowCount

Declaration
public bool ShouldSerializeVisualItemRowCount()
Returns
Type
System.Boolean

ShouldSerializeVisualItemSelectionColor()

To indicate whether to serialize VisualItemSelectionColor

Declaration
public bool ShouldSerializeVisualItemSelectionColor()
Returns
Type
System.Boolean

ShouldSerializeVisualItemSelectionForeColor()

To indicate whether to serialize VisualItemSelectionForeColor

Declaration
public bool ShouldSerializeVisualItemSelectionForeColor()
Returns
Type
System.Boolean

ShowPopup()

To Open DropDown window

Declaration
public void ShowPopup()

UnSelectAll()

Method to un select all the items in DropDown

Declaration
public void UnSelectAll()

UpdateVisibleItems()

To Update Visible Item position

Declaration
public void UpdateVisibleItems()

WndProc(ref Message)

Overrides the Windows Message.

Declaration
protected override void WndProc(ref Message m)
Parameters
Type Name Description
System.Windows.Forms.Message m

The Message
Overrides

Events

AutoSizeStateChanged

This event will be triggered once MultiSelectionComboBox AutoSizeState is changed

Declaration
public event AutoSizeModeEventHandler AutoSizeStateChanged
Event Type
Type
AutoSizeModeEventHandler

CheckChanged

This event will be triggered once MultiSelectionComboBox DropDown items checked state is changed.

Declaration
public event CheckedStateEventHandler CheckChanged
Event Type
Type
CheckedStateEventHandler

DataSourceChanged

This event will be triggered once MultiSelectionComboBox datasource is changed

Declaration
public event EventHandler DataSourceChanged
Event Type
Type
System.EventHandler

DropDown

This Event will be triggered upon MultiSelectionComboBox DropDown window visiblity is changed

Declaration
public event DropDownStateEventHandler DropDown
Event Type
Type
DropDownStateEventHandler

SelectedItemCollectionChanged

This event will be triggered upon MultiSelectionComboBox SelectedItem collection is changed.

Declaration
public event SelectedItemCollectionChangedHandler SelectedItemCollectionChanged
Event Type
Type
SelectedItemCollectionChangedHandler

TextChanged

This event will be triggered once MultiSelectionComboBox text is changed

Declaration
public event EventHandler TextChanged
Event Type
Type
System.EventHandler

VisualItemsCollectionChanged

This event will be triggered MultiSelectionComboBox VisualItemCollection changes

Declaration
public event VisualItemCollectionChangedHandler VisualItemsCollectionChanged
Event Type
Type
VisualItemCollectionChangedHandler

Implements

System.ComponentModel.ISupportInitialize