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

C1ComboBox

Implements

INotifyPropertyChanged

Namespace: C1.WPF.Input

Assembly: C1.WPF.Input.dll

Syntax

[StyleTypedProperty(Property = "ItemContainerStyle", StyleTargetType = typeof(ContentControl))]
[StyleTypedProperty(Property = "ScrollBarStyle", StyleTargetType = typeof(ScrollBar))]
[StyleTypedProperty(Property = "ValidationDecoratorStyle", StyleTargetType = typeof(C1ValidationDecorator))]
[StyleTypedProperty(Property = "PopupStyle", StyleTargetType = typeof(C1PopupBorder))]
[TemplatePart(Name = "Header", Type = typeof(C1Button))]
[TemplatePart(Name = "TextBox", Type = typeof(C1AutoCompleteTextBox))]
[TemplatePart(Name = "ListView", Type = typeof(C1ListView))]
[TemplatePart(Name = "DropDown", Type = typeof(C1DropDown))]
[TemplatePart(Name = "ValidationDecorator", Type = typeof(C1ValidationDecorator))]
public class C1ComboBox : C1ItemsControl, INotifyPropertyChanged

<StyleTypedProperty(Property:="ItemContainerStyle", StyleTargetType:=GetType(ContentControl))>
<StyleTypedProperty(Property:="ScrollBarStyle", StyleTargetType:=GetType(ScrollBar))>
<StyleTypedProperty(Property:="ValidationDecoratorStyle", StyleTargetType:=GetType(C1ValidationDecorator))>
<StyleTypedProperty(Property:="PopupStyle", StyleTargetType:=GetType(C1PopupBorder))>
<TemplatePart(Name:="Header", Type:=GetType(C1Button))>
<TemplatePart(Name:="TextBox", Type:=GetType(C1AutoCompleteTextBox))>
<TemplatePart(Name:="ListView", Type:=GetType(C1ListView))>
<TemplatePart(Name:="DropDown", Type:=GetType(C1DropDown))>
<TemplatePart(Name:="ValidationDecorator", Type:=GetType(C1ValidationDecorator))>
Public Class C1ComboBox
    Inherits C1ItemsControl
    Implements INotifyPropertyChanged

Constructors

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

Fields

Name	Description
AutoCompleteProperty	Identifies the AutoComplete dependency property.
CaretBrushProperty	Identifies the CaretBrush dependency property.
ConditionProperty	Identifies the Condition dependency property.
CursorBorderBrushProperty	Identifies the CursorBorderBrush dependency property.
DropDownButtonStyleProperty	Identifies the DropDownButtonStyle dependency property.
DropDownDirectionProperty	Identifies the DropDownDirection dependency property.
DropDownHeightProperty	Identifies the DropDownHeight dependency property.
DropDownIconStyleProperty	Identifies the DropDownIconStyle dependency property.
DropDownIconTemplateProperty	Identifies the DropDownIconTemplate dependency property.
DropDownWidthProperty	Identifies the DropDownWidth dependency property.
FocusBrushProperty	Identifies the FocusBrush dependency property.
IsDropDownOpenProperty	Identifies the IsDropDownOpen dependency property.
IsEditableProperty	Identifies the IsEditable dependency property.
ItemContainerStyleProperty	Identifies the ItemContainerStyle dependency property.
ItemConverterProperty	Identifies the ItemConverter dependency property.
MaxDropDownHeightProperty	Identifies the MaxDropDownHeight dependency property.
MaxDropDownWidthProperty	Identifies the MaxDropDownWidth dependency property.
MouseOverBorderBrushProperty	Identifies the MouseOverBorderBrush dependency property.
MouseOverBrushProperty	Identifies the MouseOverBrush dependency property.
MultipleSelectionSeparatorProperty	Identifies the MultipleSelectionSeparator dependency property.
PlaceholderProperty	Identifies the Placeholder dependency property.
PopupStyleProperty	Identifies the PopupStyle 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.
SelectedItemsProperty	Identifies the SelectedItems dependency property.
SelectedValuePathProperty	Identifies the SelectedValuePath dependency property.
SelectedValueProperty	Identifies the SelectedValue dependency property.
SelectionModeProperty	Identifies the SelectionMode dependency property.
ShowCheckBoxesProperty	Identifies the ShowCheckBoxes dependency property.
TextAlignmentProperty	Identifies the TextAlignment dependency property.
TextProperty	Identifies the Text dependency property.
ValidationDecoratorStyleProperty	Identifies the ValidationDecoratorStyle 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.
CaretBrush	Gets or sets the Brush of the blinking cursor of an input control.
Condition	Gets or sets the filter condition of item source.
CursorBorderBrush	Gets or sets the Brush used to highlight the item when it has focus.
DataCollection	Gets the underlying collection.
DropDownButtonStyle	Gets or sets the style of the button that opens the drop-down.
DropDownDirection	Specifies the expand direction of the control drop-down box.
DropDownHeight	Gets or sets the height of the drop-down box (set to Double.NaN to size automatically).
DropDownIconStyle	Gets or sets the style of the icon shown in the drop-down button.
DropDownIconTemplate	Gets or sets the template of the icon used in the drop-down button.
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.
IsDropDownOpen	Open or close the C1ComboBox popup.
IsEditable	Gets or sets whether the user can select a value not contained in the C1ComboBox' Items collection.
IsInEditMode	Gets whether the control is in edit mode.
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.
Items	Gets the collection of ComboBox items.
ItemsContent	Gets the list of the content of the items.
MaxDropDownHeight	Gets or sets maximum height constraint of the drop-down box.
MaxDropDownWidth	Gets or sets maximum width constraint of the drop-down box.
MouseOverBorderBrush	Gets or sets the Brush used to highlight the border of the control when it has the mouse over.
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.
Placeholder	Gets or sets the placeholder text.
PopupStyle	Gets or sets the style for the popup.
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.
SelectedItemsContent	Gets the list of the content of the selected items.
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.
Selection	Gets the current selected items.
SelectionMode	Gets or sets the selection mode.
ShowCheckBoxes	Gets or sets whether checkboxes are shown in each item.
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.

Methods

Name	Description
BeginEdit(string)	Begins the edit.
Dispose(bool)
EndInit()
OnApplyTemplate()
OnDisplayMemberPathChanged(string, string)
OnEditCompleted()	Fires the EditCompleted event.
OnGotFocus(RoutedEventArgs)
OnIsKeyboardFocusWithinChanged(DependencyPropertyChangedEventArgs)
OnItemTemplateChanged(DataTemplate, DataTemplate)
OnItemTemplateSelectorChanged(DataTemplateSelector, DataTemplateSelector)
OnItemsSourceChangedProtected(IEnumerable, IEnumerable)
OnKeyDown(KeyEventArgs)
OnPreviewKeyDown(KeyEventArgs)
OnPropertyChanged(DependencyPropertyChangedEventArgs)
OnSelectionCommitted(object, object)	Fires the SelectionCommitted event.
Select(C1OrderedSet)	Selects the specified indexes.
Select(IOrderedSet<int>)	Selects the specified indexes.
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	Called when the drop-down is opened or closed.
PropertyChanged	Called when a property changes.
SelectedIndexChanged	Called when the selected index changes.
SelectedItemChanged	Called when the selected item changes.
SelectedValueChanged	Called when the selected value changes.
SelectionChanged	Event fired when the SelectedItems is changed.
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.