ComboBox Class

In This Topic

The ComboBox uses a small unintrusive Popup which displays, either horizontally or vertically, a list of items amongst which the user can make a single selection.

Object Model

Syntax

Visual Basic
C#

'Declaration
 
<DefaultPropertyAttribute("ItemsSource")>
<ContentPropertyAttribute("ItemsSource")>
Public Class ComboBox 
   Inherits Control
   Implements Microsoft.Maui.Controls.IAnimatable, Microsoft.Maui.Controls.IEffectControlProvider, Microsoft.Maui.Controls.IElementController, Microsoft.Maui.Controls.IGestureRecognizers, Microsoft.Maui.Controls.ILayout, Microsoft.Maui.Controls.ILayoutController, Microsoft.Maui.Controls.Internals.IGestureController, Microsoft.Maui.Controls.IViewController, Microsoft.Maui.Controls.IVisualElementController, Microsoft.Maui.HotReload.IHotReloadableView, Microsoft.Maui.IContentView, Microsoft.Maui.IContextFlyoutElement, Microsoft.Maui.ICrossPlatformLayout, Microsoft.Maui.IElement, Microsoft.Maui.IPadding, Microsoft.Maui.IPropertyMapperView, Microsoft.Maui.IReplaceableView, Microsoft.Maui.IToolTipElement, Microsoft.Maui.ITransform, Microsoft.Maui.IView, Microsoft.Maui.IVisualTreeElement

'Usage
 
Dim instance As ComboBox

[DefaultProperty("ItemsSource")]
[ContentProperty("ItemsSource")]
public class ComboBox : Control, Microsoft.Maui.Controls.IAnimatable, Microsoft.Maui.Controls.IEffectControlProvider, Microsoft.Maui.Controls.IElementController, Microsoft.Maui.Controls.IGestureRecognizers, Microsoft.Maui.Controls.ILayout, Microsoft.Maui.Controls.ILayoutController, Microsoft.Maui.Controls.Internals.IGestureController, Microsoft.Maui.Controls.IViewController, Microsoft.Maui.Controls.IVisualElementController, Microsoft.Maui.HotReload.IHotReloadableView, Microsoft.Maui.IContentView, Microsoft.Maui.IContextFlyoutElement, Microsoft.Maui.ICrossPlatformLayout, Microsoft.Maui.IElement, Microsoft.Maui.IPadding, Microsoft.Maui.IPropertyMapperView, Microsoft.Maui.IReplaceableView, Microsoft.Maui.IToolTipElement, Microsoft.Maui.ITransform, Microsoft.Maui.IView, Microsoft.Maui.IVisualTreeElement

Remarks

Xceed's ComboBox offers more flexibility than the Framework's Picker control, since, for example, it offers an editable TextBox, allows to filter data by using either multiple predefined filters or a custom filter, can display items based on a custom ItemTemplate & allows to use other things than Text as a Watermark.

Example

The following code would display this control:

XAML

<xctk:ComboBox WidthRequest="125"
               TextColor="Blue"
  <x:Array Type="{x:Type x:String}">
    <x:String>Montreal</x:String>
    <x:String>New York</x:String>
    <x:String>Sidney</x:String>
    <x:String>Tokyo</x:String>
    <x:String>Lima</x:String>
  </x:Array>
</xctk:ComboBox>

Inheritance Hierarchy

System.Object
   Microsoft.Maui.Controls.BindableObject
      Microsoft.Maui.Controls.Element
         Microsoft.Maui.Controls.NavigableElement
            Microsoft.Maui.Controls.VisualElement
               Microsoft.Maui.Controls.View
                  Microsoft.Maui.Controls.Compatibility.Layout
                     Microsoft.Maui.Controls.TemplatedView
                        Xceed.Maui.Toolkit.Control
                           Xceed.Maui.Toolkit.ComboBox

Public Constructors

	Name	Description
	ComboBox Constructor

Top

Public Fields

	Name	Description
	CustomFilterActionProperty
	DisplayMemberPathProperty
	FilterTextPathProperty
	FilterTypeProperty
	IsDropDownOpenProperty
	IsEditableProperty
	ItemsLayoutOrientationProperty
	ItemsSourceProperty
	ItemTemplateProperty
	MaxDropDownHeightRequestProperty
	SelectedIndexProperty
	SelectedItemProperty
	WatermarkProperty

Top

Protected Fields

	Name	Description
	propertyMapper	(Inherited from Microsoft.Maui.Controls.View)

Top

Public Properties

	Name	Description
	AnchorX	(Inherited from Microsoft.Maui.Controls.VisualElement)
	AnchorY	(Inherited from Microsoft.Maui.Controls.VisualElement)
	AutomationId	(Inherited from Microsoft.Maui.Controls.Element)
	Background	Gets or sets the Brush that will be used to paint the Control's background. (Inherited from Xceed.Maui.Toolkit.Control)
	BackgroundColor	(Inherited from Microsoft.Maui.Controls.VisualElement)
	Behaviors	(Inherited from Microsoft.Maui.Controls.VisualElement)
	BindingContext	(Inherited from Microsoft.Maui.Controls.BindableObject)
	BorderBrush	Gets or sets the Brush that will be used to paint the Control's Border. (Inherited from Xceed.Maui.Toolkit.Control)
	BorderThickness	Gets or sets the thickness of this Control's Border. (Inherited from Xceed.Maui.Toolkit.Control)
	Bounds	(Inherited from Microsoft.Maui.Controls.VisualElement)
	CascadeInputTransparent	(Inherited from Microsoft.Maui.Controls.Compatibility.Layout)
	class	(Inherited from Microsoft.Maui.Controls.NavigableElement)
	ClassId	(Inherited from Microsoft.Maui.Controls.Element)
	Clip	(Inherited from Microsoft.Maui.Controls.VisualElement)
	ControlTemplate	(Inherited from Microsoft.Maui.Controls.TemplatedView)
	CornerRadius	Gets or sets the radius for the 4 corners of this Control. (Inherited from Xceed.Maui.Toolkit.Control)
	CustomFilterAction	Gets or sets a custom filter that will filter the ItemsSource while text is being typed in the ComboBox.
	DesiredSize	(Inherited from Microsoft.Maui.Controls.VisualElement)
	Dispatcher	(Inherited from Microsoft.Maui.Controls.BindableObject)
	DisplayMemberPath	Gets or sets a path pointing to a value within the source object in order to provide a visual representation of said object.
	Effects	(Inherited from Microsoft.Maui.Controls.Element)
	FilterTextPath	Gets or sets a path pointing to a value within the source object which will be used to filter the text entered in the ComboBox.
	FilterType	Gets or sets the type of filter that will be used to filter the ItemsSource as the user types in the ComboBox.
	FlowDirection	(Inherited from Microsoft.Maui.Controls.VisualElement)
	FontAttributes	Gets or sets the FontAttributes that will be applied to the Control's textual Content. (Inherited from Xceed.Maui.Toolkit.Control)
	FontFamily	Gets or sets the font family that will be used to display the Control's textual Content. (Inherited from Xceed.Maui.Toolkit.Control)
	FontSize	Gets or sets the font size that will determine the scale of the Control's textual Content. (Inherited from Xceed.Maui.Toolkit.Control)
	Frame	(Inherited from Microsoft.Maui.Controls.VisualElement)
	GestureRecognizers	(Inherited from Microsoft.Maui.Controls.View)
	Handler	(Inherited from Microsoft.Maui.Controls.VisualElement)
	Height	(Inherited from Microsoft.Maui.Controls.VisualElement)
	HeightRequest	(Inherited from Microsoft.Maui.Controls.VisualElement)
	HorizontalContentOptions	Gets or sets how the Control's Content is aligned horizontally. (Inherited from Xceed.Maui.Toolkit.Control)
	HorizontalOptions	(Inherited from Microsoft.Maui.Controls.View)
	Id	(Inherited from Microsoft.Maui.Controls.Element)
	InputTransparent	(Inherited from Microsoft.Maui.Controls.VisualElement)
	IsClippedToBounds	(Inherited from Microsoft.Maui.Controls.Compatibility.Layout)
	IsDropDownOpen	Gets or sets if the ComboBox's Popup is opened or closed.
	IsEditable	Gets or sets if the ComboBox offers an editable TextBox when the Popup is opened.
	IsEnabled	(Inherited from Microsoft.Maui.Controls.VisualElement)
	IsFocused	(Inherited from Microsoft.Maui.Controls.VisualElement)
	IsLoaded	(Inherited from Microsoft.Maui.Controls.VisualElement)
	IsVisible	(Inherited from Microsoft.Maui.Controls.VisualElement)
	ItemsLayoutOrientation	Gets or sets if the ComboBox's items will be displayed as a vertical or horizontal list.
	ItemsSource	Gets or sets the items that will be listed in the ComboBox.
	ItemTemplate	Gets or sets the DataTemplate that will be used to display the items appearing in the ComboBox's Popup.
	Margin	(Inherited from Microsoft.Maui.Controls.View)
	MaxDropDownHeightRequest	Gets or sets the maximum Height for the ComboBox's Popup.
	MaximumHeightRequest	(Inherited from Microsoft.Maui.Controls.VisualElement)
	MaximumWidthRequest	(Inherited from Microsoft.Maui.Controls.VisualElement)
	MinimumHeightRequest	(Inherited from Microsoft.Maui.Controls.VisualElement)
	MinimumWidthRequest	(Inherited from Microsoft.Maui.Controls.VisualElement)
	Navigation	(Inherited from Microsoft.Maui.Controls.NavigableElement)
	Opacity	(Inherited from Microsoft.Maui.Controls.VisualElement)
	OverrideDefaultVisualStates	Gets or sets if the Control's VisualStates are overridden or not. (Inherited from Xceed.Maui.Toolkit.Control)
	Padding	Gets or sets the amount of padding added around the Control. (Inherited from Xceed.Maui.Toolkit.Control)
	Parent	(Inherited from Microsoft.Maui.Controls.Element)
	Resources	(Inherited from Microsoft.Maui.Controls.VisualElement)
	Rotation	(Inherited from Microsoft.Maui.Controls.VisualElement)
	RotationX	(Inherited from Microsoft.Maui.Controls.VisualElement)
	RotationY	(Inherited from Microsoft.Maui.Controls.VisualElement)
	Scale	(Inherited from Microsoft.Maui.Controls.VisualElement)
	ScaleX	(Inherited from Microsoft.Maui.Controls.VisualElement)
	ScaleY	(Inherited from Microsoft.Maui.Controls.VisualElement)
	SelectedIndex	Gets or sets the index associated with the currently selected item.
	SelectedItem	Gets or sets which item is selected in the ComboBox.
	Shadow	(Inherited from Microsoft.Maui.Controls.VisualElement)
	Style	(Inherited from Microsoft.Maui.Controls.NavigableElement)
	StyleClass	(Inherited from Microsoft.Maui.Controls.NavigableElement)
	StyleId	(Inherited from Microsoft.Maui.Controls.Element)
	TextColor	Gets or sets the text's Color. (Inherited from Xceed.Maui.Toolkit.Control)
	TranslationX	(Inherited from Microsoft.Maui.Controls.VisualElement)
	TranslationY	(Inherited from Microsoft.Maui.Controls.VisualElement)
	Triggers	(Inherited from Microsoft.Maui.Controls.VisualElement)
	VerticalContentOptions	Gets or sets how the Control's Content is aligned vertically. (Inherited from Xceed.Maui.Toolkit.Control)
	VerticalOptions	(Inherited from Microsoft.Maui.Controls.View)
	Visual	(Inherited from Microsoft.Maui.Controls.VisualElement)
	Watermark	Gets or sets the watermark that will be displayed when no item is selected in the ComboBox.
	Width	(Inherited from Microsoft.Maui.Controls.VisualElement)
	WidthRequest	(Inherited from Microsoft.Maui.Controls.VisualElement)
	Window	(Inherited from Microsoft.Maui.Controls.VisualElement)
	X	(Inherited from Microsoft.Maui.Controls.VisualElement)
	Y	(Inherited from Microsoft.Maui.Controls.VisualElement)
	ZIndex	(Inherited from Microsoft.Maui.Controls.VisualElement)

Top

Protected Properties

	Name	Description
	GestureController	(Inherited from Microsoft.Maui.Controls.View)
	IsEnabledCore	(Inherited from Microsoft.Maui.Controls.VisualElement)

Top

Public Methods

	Name	Description
	AddLogicalChild	(Inherited from Microsoft.Maui.Controls.Element)
	Arrange	(Inherited from Microsoft.Maui.Controls.VisualElement)
	BatchBegin	(Inherited from Microsoft.Maui.Controls.VisualElement)
	BatchCommit	(Inherited from Microsoft.Maui.Controls.VisualElement)
	ClearLogicalChildren	(Inherited from Microsoft.Maui.Controls.Element)
	ClearValue	Overloaded. (Inherited from Microsoft.Maui.Controls.BindableObject)
	CoerceValue	Overloaded. (Inherited from Microsoft.Maui.Controls.BindableObject)
	CrossPlatformArrange	(Inherited from Microsoft.Maui.Controls.Compatibility.Layout)
	CrossPlatformMeasure	(Inherited from Microsoft.Maui.Controls.Compatibility.Layout)
	FindByName	(Inherited from Microsoft.Maui.Controls.Element)
	Focus	(Inherited from Microsoft.Maui.Controls.VisualElement)
	ForceLayout	(Inherited from Microsoft.Maui.Controls.Compatibility.Layout)
	GetChildElements	(Inherited from Microsoft.Maui.Controls.View)
	GetValue	(Inherited from Microsoft.Maui.Controls.BindableObject)
	InsertLogicalChild	(Inherited from Microsoft.Maui.Controls.Element)
	IsSet	(Inherited from Microsoft.Maui.Controls.BindableObject)
	Layout	(Inherited from Microsoft.Maui.Controls.VisualElement)
	LowerChild	(Inherited from Microsoft.Maui.Controls.Compatibility.Layout)
	Measure	(Inherited from Microsoft.Maui.Controls.Compatibility.Layout)
	RaiseChild	(Inherited from Microsoft.Maui.Controls.Compatibility.Layout)
	RemoveBinding	(Inherited from Microsoft.Maui.Controls.BindableObject)
	RemoveDynamicResource	(Inherited from Microsoft.Maui.Controls.Element)
	RemoveLogicalChild	(Inherited from Microsoft.Maui.Controls.Element)
	ResolveControlTemplate	(Inherited from Microsoft.Maui.Controls.TemplatedView)
	SetBinding	(Inherited from Microsoft.Maui.Controls.BindableObject)
	SetDynamicResource	(Inherited from Microsoft.Maui.Controls.Element)
	SetValue	Overloaded. (Inherited from Microsoft.Maui.Controls.BindableObject)
	Unfocus	(Inherited from Microsoft.Maui.Controls.VisualElement)

Top

Protected Methods

	Name	Description
	ApplyBindings	(Inherited from Microsoft.Maui.Controls.BindableObject)
	ArrangeOverride	(Inherited from Microsoft.Maui.Controls.TemplatedView)
	ChangeVisualState	(Inherited from Microsoft.Maui.Controls.View)
	Finalize	(Inherited from Microsoft.Maui.Controls.VisualElement)
	GetRendererOverrides	(Inherited from Microsoft.Maui.Controls.View)
	GetTemplateChild	(Inherited from Microsoft.Maui.Controls.TemplatedView)
	InvalidateLayout	(Inherited from Microsoft.Maui.Controls.Compatibility.Layout)
	InvalidateMeasure	(Inherited from Microsoft.Maui.Controls.VisualElement)
	InvalidateMeasureOverride	(Inherited from Microsoft.Maui.Controls.Compatibility.Layout)
	LayoutChildren	(Inherited from Microsoft.Maui.Controls.TemplatedView)
	MeasureOverride	(Inherited from Microsoft.Maui.Controls.TemplatedView)
	OnApplyTemplate	Overridden.
	OnBindingContextChanged	(Inherited from Microsoft.Maui.Controls.View)
	OnChildAdded	(Inherited from Microsoft.Maui.Controls.VisualElement)
	OnChildMeasureInvalidated	Overloaded. (Inherited from Microsoft.Maui.Controls.Compatibility.Layout)
	OnChildRemoved	(Inherited from Microsoft.Maui.Controls.TemplatedView)
	OnChildrenReordered	(Inherited from Microsoft.Maui.Controls.VisualElement)
	OnDisplayMemberPathChanged
	OnFontAttributesChanged	Overridden.
	OnFontFamilyChanged	Overridden.
	OnFontSizeChanged	Overridden.
	OnHandlerChanged	(Inherited from Microsoft.Maui.Controls.Element)
	OnHandlerChanging	(Inherited from Microsoft.Maui.Controls.Element)
	OnIsDropDownOpenChanged
	OnItemsSourceChanged
	OnItemsTemplateChanged
	OnMeasure	(Inherited from Microsoft.Maui.Controls.TemplatedView)
	OnParentChanged	(Inherited from Microsoft.Maui.Controls.Element)
	OnParentChanging	(Inherited from Microsoft.Maui.Controls.Element)
	OnParentSet	(Inherited from Microsoft.Maui.Controls.NavigableElement)
	OnPropertyChanged	(Inherited from Xceed.Maui.Toolkit.Control)
	OnPropertyChanging	(Inherited from Microsoft.Maui.Controls.BindableObject)
	OnSelectedIndexChanged
	OnSelectedItemChanged
	OnSizeAllocated	(Inherited from Microsoft.Maui.Controls.Compatibility.Layout)
	OnTextColorChanged	Overridden.
	RefreshIsEnabledProperty	(Inherited from Microsoft.Maui.Controls.VisualElement)
	ShouldInvalidateOnChildAdded	(Inherited from Microsoft.Maui.Controls.Compatibility.Layout)
	ShouldInvalidateOnChildRemoved	(Inherited from Microsoft.Maui.Controls.Compatibility.Layout)
	SizeAllocated	(Inherited from Microsoft.Maui.Controls.VisualElement)
	UnapplyBindings	(Inherited from Microsoft.Maui.Controls.BindableObject)
	UpdateChildrenLayout	(Inherited from Microsoft.Maui.Controls.Compatibility.Layout)

Top

Public Events

	Name	Description
	BindingContextChanged	(Inherited from Microsoft.Maui.Controls.BindableObject)
	ChildAdded	(Inherited from Microsoft.Maui.Controls.Element)
	ChildRemoved	(Inherited from Microsoft.Maui.Controls.Element)
	ChildrenReordered	(Inherited from Microsoft.Maui.Controls.VisualElement)
	DescendantAdded	(Inherited from Microsoft.Maui.Controls.Element)
	DescendantRemoved	(Inherited from Microsoft.Maui.Controls.Element)
	DropDownClosed	This event is raised when the ComboBox's Popup is closed.
	DropDownOpened	This event is raised when the ComboBox's Popup is opened.
	Focused	(Inherited from Microsoft.Maui.Controls.VisualElement)
	HandlerChanged	(Inherited from Microsoft.Maui.Controls.Element)
	HandlerChanging	(Inherited from Microsoft.Maui.Controls.Element)
	LayoutChanged	(Inherited from Microsoft.Maui.Controls.Compatibility.Layout)
	Loaded	(Inherited from Microsoft.Maui.Controls.VisualElement)
	MeasureInvalidated	(Inherited from Microsoft.Maui.Controls.VisualElement)
	ParentChanged	(Inherited from Microsoft.Maui.Controls.Element)
	ParentChanging	(Inherited from Microsoft.Maui.Controls.Element)
	PropertyChanged	(Inherited from Microsoft.Maui.Controls.BindableObject)
	PropertyChanging	(Inherited from Microsoft.Maui.Controls.BindableObject)
	SelectionChanged	This event is raised when a new item is selected in the ComboBox.
	SizeChanged	(Inherited from Microsoft.Maui.Controls.VisualElement)
	Unfocused	(Inherited from Microsoft.Maui.Controls.VisualElement)
	Unloaded	(Inherited from Microsoft.Maui.Controls.VisualElement)

Top

Requirements

Target Platforms: Windows 11, Windows 10, Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

Reference

ComboBox Members
Xceed.Maui.Toolkit Namespace

Send Feedback

Business Suite

Ultimate Suite

Reference