C1ComboBox Class

The C1ComboBox control combines an editable text box with an auto-searchable drop-down list. The list can be shown or hidden by clicking the control’s drop-down arrow.

Inheritance

object

DispatcherObject

C1ComboBox

Implements

IAnimatable

IFrameworkInputElement

Namespace: C1.WPF

Assembly: C1.WPF.4.6.2.dll

Syntax

[TemplatePart(Name = "ComboHeader", Type = typeof(C1TextEditableContentControl))]
[TemplatePart(Name = "ScrollViewer", Type = typeof(ScrollViewer))]
[TemplatePart(Name = "DropDown", Type = typeof(C1DropDown))]
[TemplatePart(Name = "HeaderClickInterceptor", Type = typeof(FrameworkElement))]
[TemplateVisualState(Name = "Open", GroupName = "DropDownOpenStates")]
[TemplateVisualState(Name = "Closed", GroupName = "DropDownOpenStates")]
[TemplateVisualState(Name = "MouseOver", GroupName = "CommonStates")]
[TemplateVisualState(Name = "Disabled", GroupName = "CommonStates")]
[TemplateVisualState(Name = "Normal", GroupName = "CommonStates")]
[TemplateVisualState(Name = "Focused", GroupName = "FocusStates")]
[TemplateVisualState(Name = "Unfocused", GroupName = "FocusStates")]
[TemplateVisualState(Name = "Valid", GroupName = "ValidationStatesStates")]
[TemplateVisualState(Name = "InvalidUnfocused", GroupName = "ValidationStatesStates")]
[TemplateVisualState(Name = "InvalidFocused", GroupName = "ValidationStatesStates")]
[StyleTypedProperty(Property = "ItemContainerStyle", StyleTargetType = typeof(C1ComboBoxItem))]
[StyleTypedProperty(Property = "ScrollBarStyle", StyleTargetType = typeof(ScrollBar))]
[StyleTypedProperty(Property = "ValidationDecoratorStyle", StyleTargetType = typeof(C1ValidationDecorator))]
public class C1ComboBox : ItemsControl, IAnimatable, IFrameworkInputElement, IInputElement, ISupportInitialize, IQueryAmbient, IAddChild, IContainItemStorage

<TemplatePart(Name:="ComboHeader", Type:=GetType(C1TextEditableContentControl))>
<TemplatePart(Name:="ScrollViewer", Type:=GetType(ScrollViewer))>
<TemplatePart(Name:="DropDown", Type:=GetType(C1DropDown))>
<TemplatePart(Name:="HeaderClickInterceptor", Type:=GetType(FrameworkElement))>
<TemplateVisualState(Name:="Open", GroupName:="DropDownOpenStates")>
<TemplateVisualState(Name:="Closed", GroupName:="DropDownOpenStates")>
<TemplateVisualState(Name:="MouseOver", GroupName:="CommonStates")>
<TemplateVisualState(Name:="Disabled", GroupName:="CommonStates")>
<TemplateVisualState(Name:="Normal", GroupName:="CommonStates")>
<TemplateVisualState(Name:="Focused", GroupName:="FocusStates")>
<TemplateVisualState(Name:="Unfocused", GroupName:="FocusStates")>
<TemplateVisualState(Name:="Valid", GroupName:="ValidationStatesStates")>
<TemplateVisualState(Name:="InvalidUnfocused", GroupName:="ValidationStatesStates")>
<TemplateVisualState(Name:="InvalidFocused", GroupName:="ValidationStatesStates")>
<StyleTypedProperty(Property:="ItemContainerStyle", StyleTargetType:=GetType(C1ComboBoxItem))>
<StyleTypedProperty(Property:="ScrollBarStyle", StyleTargetType:=GetType(ScrollBar))>
<StyleTypedProperty(Property:="ValidationDecoratorStyle", StyleTargetType:=GetType(C1ValidationDecorator))>
Public Class C1ComboBox
    Inherits ItemsControl
    Implements IAnimatable, IFrameworkInputElement, IInputElement, ISupportInitialize, IQueryAmbient, IAddChild, IContainItemStorage

Constructors

Name	Description
C1ComboBox()	Initializes a new instance of a C1ComboBox.

Fields

Name	Description
AutoCompleteProperty	Identifies the AutoComplete dependency property.
ButtonBackgroundProperty	Identifies the ButtonBackground dependency property.
ButtonForegroundProperty	Identifies the ButtonForeground dependency property.
CaretBrushProperty	Identifies the CaretBrush dependency property.
ConditionProperty	Identifies the Condition dependency property.
CornerRadiusProperty	Identifies the CornerRadius dependency property.
DefaultItemHeightProperty	Identifies the DefaultItemHeight dependency property.
DisabledCuesVisibilityProperty	Identifies the DisabledCuesVisibility dependency property.
DropDownDirectionProperty	Identifies the DropDownDirection dependency property.
DropDownHeightProperty	Identifies the DropDownHeight dependency property.
DropDownWidthProperty	Identifies the DropDownWidth dependency property.
FocusBrushProperty	Identifies the FocusBrush dependency property.
FocusCuesVisibilityProperty	Identifies the FocusCuesVisibility dependency property.
IsDropDownOpenProperty	Identifies the IsDropDownOpen dependency property.
IsEditableProperty	Identifies the IsEditable dependency property.
IsFocusedProperty	Identifies the IsFocused dependency property.
ItemContainerStyleProperty	Identifies the ItemContainerStyle dependency property.
ItemConverterProperty	Identifies the ItemConverter dependency property.
MaxDropDownHeightProperty	Identifies the MaxDropDownHeight dependency property.
MaxDropDownItemsProperty	Identifies the MaxDropDownItems dependency property.
MaxDropDownWidthProperty	Identifies the MaxDropDownWidth dependency property.
MouseOverBrushProperty	Identifies the MouseOverBrush dependency property.
MultipleSelectionSeparatorProperty	Identifies the MultipleSelectionSeparator dependency property.
PressedBrushProperty	Identifies the PressedBrush dependency property.
ScrollBarStyleProperty	Identifies the ScrollBarStyle dependency property.
SelectedBackgroundProperty	Identifies the SelectedBackground dependency property.
SelectedIndexProperty	Identifies the SelectedIndex dependency property.
SelectedItemProperty	Identifies the SelectedItem dependency property.
SelectedValuePathProperty	Identifies the SelectedValuePath dependency property.
SelectedValueProperty	Identifies the SelectedValue dependency property.
SelectionBackgroundProperty	Identifies the C1.WPF.C1ComboBox.SelectionBackground dependency property.
SelectionForegroundProperty	Identifies the C1.WPF.C1ComboBox.SelectionForeground dependency property.
SelectionModeProperty	Identifies the SelectionMode dependency property.
TextAlignmentProperty	Identifies the TextAlignment dependency property.
TextProperty	Identifies the Text dependency property.
ValidationDecoratorStyleProperty	Identifies the ValidationDecoratorStyle dependency property.
WatermarkProperty	Identifies the Watermark dependency property.

Properties

Name	Description
AutoComplete	Gets or sets whether the control should try to automatically complete entries using the list items as an item source.
ButtonBackground	Gets or sets the Brush that will be assigned to the Background of the buttons inside the control.
ButtonForeground	Gets or sets the Brush that will be assigned to the Foreground of the buttons inside the control.
CaretBrush	Gets or sets the Brush of the blinking cursor of an input control. When .NET Framework is v3.5, 'CaretBrush' takes no effect.
Condition	Gets or sets the filter condition of item source.
CornerRadius	Gets or sets a value that represents the degree to which the corners of the element are rounded.
DefaultItemHeight	Obsolete. Use ItemContainerStyle.
DisabledCuesVisibility	Gets or sets a value indicating whether the disabled visuals of the control are visible.
DropDownDirection	Specifies the expand direction of the C1ComboBox drop down.
DropDownHeight	Gets or sets the height of the dropdown (set to Double.NaN to size automatically).
DropDownWidth	Gets or sets the width of the drop-down box (set to Double.NaN to size automatically).
FocusBrush	Gets or sets the Brush used to highlight the focused control.
FocusCuesVisibility	Gets or sets a value indicating whether the focus visuals of the control are visible.
IsDropDownOpen	Open or close the C1ComboBox popup.
IsEditable	Get/Set if the user can select a value not contained in the C1ComboBox' Items collection.
IsFocused	Returns true if the control has the focus.
ItemContainerStyle	Gets or sets the style used for the inner C1ComboBox's items.
ItemConverter	Item converter used to convert the items to string and vice versa.
MaxDropDownHeight	Gets or sets maximum height constraint of the drop-down box.
MaxDropDownItems	Obsolete. Use MaxDropDownHeight.
MaxDropDownWidth	Gets or sets maximum width constraint of the drop-down box.
MouseOverBrush	Gets or sets the Brush used to highlight the control when it has the mouse over.
MultipleSelectionSeparator	Gets or sets text header separator in multi-select mode.
PressedBrush	Gets or sets the Brush used to paint a button when it is pressed.
ScrollBarStyle	Gets or sets the style used for the inner scrollbar.
SelectedBackground	Gets or sets the Brush used to highlight the control when it is selected.
SelectedIndex	Gets or sets the current selected index or returns -1 if there is no selection, or the selection doesn't belong to the Items collection.
SelectedItem	Gets or sets the current selected item or returns null if there is no selection.
SelectedItems	Gets or set the list of items which are selected.
SelectedValue	Gets or sets the value of the SelectedItem, obtained by using SelectedValuePath.
SelectedValuePath	Gets or sets the path that is used to get the SelectedValue from the SelectedItem.
SelectionMode	Gets or sets the selection mode.
Text	Gets or sets the text in the C1ComboBox. The behavior depends on the AutoComplete and IsEditable properties.
TextAlignment	Gets or sets a value that indicates the horizontal alignment of text content.
ValidationDecoratorStyle	Gets or sets the style that is applied to the inner C1ValidationDecorator.
Watermark	Gets or sets the watermark content displayed when the control is empty.

Methods

Name	Description
BeginEdit(string)	Begins the edit.
ChangeVisualStateCommon(bool)	Updates the current visual state of the Common visual state group to match the object's properties.
ChangeVisualStateDropDownOpen(bool)	Updates the current visual state of the DropDownOpen visual state group to match the object's properties.
ChangeVisualStateFocus(bool)	Updates the current visual state of the Focus visual state group to match the object's properties.
GetContainerForItemOverride()
IsItemItsOwnContainerOverride(object)
IsOpenKey(Key)	Return true if that key should open the combo box. Override to handle you own keyboard selection strategy.
MoveListBox(Key, int, out int)	Get the next item in the ListBox when a key is pressed. You may override this to implement your own keyboard selection strategy.
OnApplyTemplate()	Builds the visual tree for the C1ComboBox control when a new template is applied.
OnEditCompleted()	Fires the EditCompleted event.
OnItemsChanged(NotifyCollectionChangedEventArgs)	Called when the value of the Items property changes.
OnMouseLeftButtonDown(MouseButtonEventArgs)	Called before the MouseLeftButtonDown event occurs.
OnPropertyChanged(DependencyPropertyChangedEventArgs)	Invoked whenever the effective value of any dependency property has been updated.
OnSelectionCommitted()	Fires the SelectionCommitted event.
PrepareContainerForItemOverride(DependencyObject, object)
SelectAll()	Select all data item in multi Select mode.
UnselectAll()	Unselect all data item in multi Select mode.

Events

Name	Description
EditCompleted	Handle this event to know when the user has completed the edits.
IsDropDownOpenChanged	Event raised when the IsDropDownOpen property has changed.
IsMouseOverChanged	Event raised when the IsMouseOver property has changed.
KeyDownInPopup	Handle this event to provide your own custom navigation when the popup is opened. Receives the key that was pressed and the current index, and returns the new index that should be selected.
SelectedIndexChanged	Event raised when the SelectedIndex property has changed.
SelectedItemChanged	Event raised when the SelectedItem property has changed.
SelectedValueChanged	Event raised when the SelectedValue property has changed.
SelectionChanged	Event fired when the SelectedItems is changed in multi selection mode.
SelectionCommitted	Event fired when the select item is committed.
ValidateInput	Event fired when new text is added to an editable C1ComboBox. Catch this event to validate the new input.

Extension Methods

Extensions.FindParent<T>(FrameworkElement)

Extensions.GetAllParents(FrameworkElement)

Extensions.GetVisualStateGroup(FrameworkElement, string)

Extensions.SetBinding<T>(FrameworkElement, DependencyProperty, T, Expression<Func<T, object>>)

Extensions.SetBinding<T>(FrameworkElement, DependencyProperty, T, Expression<Func<T, object>>, IValueConverter)

Extensions.C1TransformToVisual(UIElement, UIElement)