MultiSelectComboBox Class

Reference

Definition

Namespace:: Microsoft.VisualStudio.PlatformUI

Assembly:: Microsoft.VisualStudio.Shell.15.0.dll

Package:: Microsoft.VisualStudio.Shell.15.0 v17.9.37000

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

This control allows the user to select multiple values in a combo box drop down popup and display the selections as a comma joined string

[System.Windows.TemplatePart(Name="PART_ListBox", Type=typeof(System.Windows.Controls.ListBox))]
[System.Windows.TemplatePart(Name="PART_ContentPresenter", Type=typeof(System.Windows.Controls.ContentPresenter))]
public class MultiSelectComboBox : System.Windows.Controls.ComboBox

[<System.Windows.TemplatePart(Name="PART_ListBox", Type=typeof(System.Windows.Controls.ListBox))>]
[<System.Windows.TemplatePart(Name="PART_ContentPresenter", Type=typeof(System.Windows.Controls.ContentPresenter))>]
type MultiSelectComboBox = class
    inherit ComboBox

Public Class MultiSelectComboBox
Inherits ComboBox

Inheritance: ComboBox
MultiSelectComboBox

Attributes: TemplatePartAttribute

Constructors

MultiSelectComboBox()

Fields

DelimiterChar	The delimiter char
DelimiterStr	The delimiter string
IsSelectAllCheckedProperty	The DependencyProperty for the IsSelectAllChecked property
SelectedItemsProperty	The DependencyProperty for the SelectedItems property
SelectedItemsTextConverterProperty	The DependencyProperty for the SelectedItemsTextConverter property
SelectedItemsTextProperty	The DependencyProperty for the SelectedItemsText property
ShowSelectAllProperty	The DependencyProperty for the ShowSelectAll property
SurrogateItemsSourceProperty	The DependencyProperty for the Microsoft.VisualStudio.PlatformUI.MultiSelectComboBox.SurrogateItemsSource property
WatermarkProperty	The DependencyProperty for the Watermark property

Properties

IsSelectAllChecked	The state of the checkbox for the Select All option
SelectedItems	The selected items
SelectedItemsText	The selected items text string that represents the choices that should be selected initially, if any
SelectedItemsTextConverter	The selected items converter that can be used to customize the text of what is selected when SelectedItems is the value. If SelectedItemsText is already passed in, we use that for what is displayed instead of this converter. If SelectedItemsText is null and SelectedItemsTextConverter is null, we concatenate a string with the SelectedItems using DelimiterStr.
ShowSelectAll	The option to enable Select All
Watermark	The string for the watermark

Methods

EnableItems(Boolean, IEnumerable<Object>)	Enables or disables items in the MultiSelectComboBox.
OnApplyTemplate()	Called when ApplyTemplate() is called.
OnCreateAutomationPeer()	Provides an appropriate ComboBoxAutomationPeer implementation for this control, as part of the WPF infrastructure.
OnItemsSourceChanged(IEnumerable, IEnumerable)	System.Windows.Controls.ComboBox.OnItemsSourceChanged(System.Collections.IEnumerable,System.Collections.IEnumerable)

Applies to

Share via