Class

RadComboBox

Initializes a new instance of the RadComboBox class.

Declaration

public RadComboBox()

Identifies the AdditionalContentPositionProperty dependency property.

Declaration

public static readonly DependencyProperty AdditionalContentPositionProperty

Field Value

Identifies the AdditionalContentProperty dependency property.

Declaration

public static readonly DependencyProperty AdditionalContentProperty

Field Value

Identifies the AdditionalContentTemplateProperty dependency property.

Declaration

public static readonly DependencyProperty AdditionalContentTemplateProperty

Field Value

Identifies the AllowMultipleSelection dependency property.

Declaration

public static readonly DependencyProperty AllowMultipleSelectionProperty

Field Value

Identifies the AutoCompleteSelectionModeProperty dependency property.

Declaration

public static readonly DependencyProperty AutoCompleteSelectionModeProperty

Field Value

Identifies the CanAutocompleteSelectItems dependency property.

Declaration

public static readonly DependencyProperty CanAutocompleteSelectItemsProperty

Field Value

Identifies the CanKeyboardNavigationSelectItems dependency property.

Declaration

public static readonly DependencyProperty CanKeyboardNavigationSelectItemsProperty

Field Value

Identifies the ClearSelectionButtonContent dependency property.

Declaration

public static readonly DependencyProperty ClearSelectionButtonContentProperty

Field Value

Identifies the learSelectionButtonVisibility dependency property.

Declaration

public static readonly DependencyProperty ClearSelectionButtonVisibilityProperty

Field Value

Identifies the CommandParameter dependency property.

Declaration

public static readonly DependencyProperty CommandParameterProperty

Field Value

Identifies the Command dependency property.

Declaration

public static readonly DependencyProperty CommandProperty

Field Value

Identifies the CommandParameter dependency property.

Declaration

public static readonly DependencyProperty CommandTargetProperty

Field Value

Identifies the DropDownButtonIconContent dependency property.

Declaration

public static readonly DependencyProperty DropDownButtonIconContentProperty

Field Value

Identifies the DropDownButtonIconTemplate dependency property.

Declaration

public static readonly DependencyProperty DropDownButtonIconTemplateProperty

Field Value

Identifies the DropDownWidth dependency property.

Declaration

public static readonly DependencyProperty DropDownWidthProperty

Field Value

Identifies the EditableTemplate dependency property.

Declaration

public static readonly DependencyProperty EditableTemplateProperty

Field Value

Identifies the EmptySelectionBoxTemplate dependency property.

Declaration

public static readonly DependencyProperty EmptySelectionBoxTemplateProperty

Field Value

Identifies the EmptyText dependency property.

Declaration

public static readonly DependencyProperty EmptyTextProperty

Field Value

Identifies the FilteringMode dependency property.

Declaration

public static readonly DependencyProperty FilteringModeProperty

Field Value

Identifies the IsDropDownOpen dependency property.

Declaration

public static readonly DependencyProperty IsDropDownOpenProperty

Field Value

Identifies the IsDropDownTabNavigationEnabled dependency property.

Declaration

public static readonly DependencyProperty IsDropDownTabNavigationEnabledProperty

Field Value

Identifies the IsEditable dependency property.

Declaration

public static readonly DependencyProperty IsEditableProperty

Field Value

Identifies the FilteringMode dependency property.

Declaration

public static readonly DependencyProperty IsFilteringEnabledProperty

Field Value

Identifies the IsHighlighted dependency property.

Declaration

public static readonly DependencyProperty IsHighlightedProperty

Field Value

Identifies the IsMouseWheelEnabledProperty dependency property.

Declaration

public static readonly DependencyProperty IsMouseWheelEnabledProperty

Field Value

Identifies the IsReadOnly dependency property.

Declaration

public static readonly DependencyProperty IsReadOnlyProperty

Field Value

Identifies the IsWatermarkVisible dependency property.

Declaration

public static readonly DependencyProperty IsWatermarkVisibleProperty

Field Value

Identifies the MaxDropDownHeight dependency property.

Declaration

public static readonly DependencyProperty MaxDropDownHeightProperty

Field Value

Identifies the MinDropDownWidth readonly dependency property.

Declaration

public static readonly DependencyProperty MinDropDownWidthProperty

Field Value

Identifies the MultipleSelectionBoxTemplate dependency property.

Declaration

public static readonly DependencyProperty MultipleSelectionBoxTemplateProperty

Field Value

Identifies the MultipleSelectionSeparator dependency property.

Declaration

public static readonly DependencyProperty MultipleSelectionSeparatorProperty

Field Value

Identifies the MultipleSelectionSeparatorStringFormat dependency property.

Declaration

public static readonly DependencyProperty MultipleSelectionSeparatorStringFormatProperty

Field Value

Identifies the NonEditableTemplate dependency property.

Declaration

public static readonly DependencyProperty NonEditableTemplateProperty

Field Value

Identifies the OpenDropDownOnFocus dependency property.

Declaration

public static readonly DependencyProperty OpenDropDownOnFocusProperty

Field Value

Identifies the SelectAllTextEvents dependency property.

Declaration

public static readonly DependencyProperty SelectAllTextEventProperty

Field Value

Identifies the SelectionBoxItem dependency property.

Declaration

public static readonly DependencyProperty SelectionBoxItemProperty

Field Value

Identifies the SelectionBoxItemTemplate dependency property.

Declaration

public static readonly DependencyProperty SelectionBoxItemTemplateProperty

Field Value

Identifies the SelectionBoxTemplate dependency property.

Declaration

public static readonly DependencyProperty SelectionBoxTemplateProperty

Field Value

Identifies the StaysOpenOnEdit dependency property.

Declaration

public static readonly DependencyProperty StaysOpenOnEditProperty

Field Value

Identifies the TextBoxStyle dependency property.

Declaration

public static readonly DependencyProperty TextBoxStyleProperty

Field Value

Identifies the Text dependency property.

Declaration

public static readonly DependencyProperty TextProperty

Field Value

Identifies the FilteringMode dependency property.

Declaration

public static readonly DependencyProperty TextSearchModeProperty

Field Value

Identifies the UpdateSelectionOnLostFocus dependency property.

Declaration

public static readonly DependencyProperty UpdateSelectionOnLostFocusProperty

Field Value

Gets or sets the content for the additional content area.

Declaration

public object AdditionalContent { get; set; }

Property Value

Gets or sets the position of the additional content area in the drop-down.

Declaration

public AdditionalContentPosition AdditionalContentPosition { get; set; }

Property Value

Gets or sets the content template for the additional content area.

Declaration

public DataTemplate AdditionalContentTemplate { get; set; }

Property Value

Gets or sets the value that indicates whether multiple item can be selected at the same time. This is a dependency property.

Declaration

public bool AllowMultipleSelection { get; set; }

Property Value

Gets or sets the value indicating whether selection via autocomplete is performed when a partial or a full match is found.

Declaration

public ComboBoxAutoCompleteSelectionMode AutoCompleteSelectionMode { get; set; }

Property Value

Remarks

Gets or sets the value specifying whether typing a text in a RadComboBox should change the selection or not. This property is applicable only when the DropDown of the control is opened.

Declaration

public bool? CanAutocompleteSelectItems { get; set; }

Property Value

Gets or sets the value specifying whether the keyboard navigation in a RadComboBox should change the selection.

Declaration

public bool? CanKeyboardNavigationSelectItems { get; set; }

Property Value

Gets or sets the content of the button clearing the selection. This is a dependency property.

Declaration

public object ClearSelectionButtonContent { get; set; }

Property Value

Gets or sets the visibility of the button clearing the selection. This is a dependency property.

Declaration

public Visibility ClearSelectionButtonVisibility { get; set; }

Property Value

Gets or sets the command that will be executed when the command source is invoked.

Declaration

[TypeConverter(typeof(CommandConverter))]
public ICommand Command { get; set; }

Property Value

Represents a user defined data value that can be passed to the command when it is executed.

Declaration

public object CommandParameter { get; set; }

Property Value

The object that the command is being executed on.

Declaration

public IInputElement CommandTarget { get; set; }

Property Value

Gets or sets the content displayed as the icon for the drop-down button.

Declaration

public object DropDownButtonIconContent { get; set; }

Property Value

Gets or sets the content template for the drop-down button icon.

Declaration

public DataTemplate DropDownButtonIconTemplate { get; set; }

Property Value

Gets or sets the width of the DropDown of the RadComboBox.

Declaration

public GridLength DropDownWidth { get; set; }

Property Value

Gets or sets the ControlTemplate for RadCombBox when its IsEditable property is true.

Declaration

public ControlTemplate EditableTemplate { get; set; }

Property Value

Gets or sets the DataTemplate that should be applied on the selection box ContentPresenter when there is no selection. This is a dependency property.

Declaration

public DataTemplate EmptySelectionBoxTemplate { get; set; }

Property Value

Gets or sets a string that should be displayed in the selection box ContentPresenter when there is no selection. This is a dependency property.

Declaration

public string EmptyText { get; set; }

Property Value

Gets or sets the behavior which is used when filtering logic applies.

Declaration

public ComboBoxFilteringBehavior FilteringBehavior { get; set; }

Property Value

Gets a value that indicates whether a control supports scrolling.

Declaration

protected override bool HandlesScrolling { get; }

Property Value

Gets or sets the value that indicates whether the RadComboBox dropdown is currently open. This is a dependency property.

Declaration

public bool IsDropDownOpen { get; set; }

Property Value

Gets or sets a value indicating whether tab navigation inside the drop down portion of control is enabled. The property takes effect only when the IsEditable property is false. This is a dependency property.

Declaration

public bool IsDropDownTabNavigationEnabled { get; set; }

Property Value

Gets or sets a value that enables or disables editing of the text in text box of the RadComboBox. This is a dependency property.

Declaration

public bool IsEditable { get; set; }

Property Value

Gets or sets the value indicating whether the filtering is enabled. This is a dependency property.

Declaration

public bool IsFilteringEnabled { get; set; }

Property Value

Gets or sets a value indicating whether this instance is highlighted.

Declaration

public bool IsHighlighted { get; set; }

Property Value

Remarks

Gets or sets the value indicating whether the instance will respond to MouseWheel events when the dropdown is not open.

Declaration

public bool IsMouseWheelEnabled { get; set; }

Property Value

Gets or sets a value that enables selection-only mode, in which the contents of the RadComboBox are selectable but not editable. This is a dependency property.

Declaration

public bool IsReadOnly { get; set; }

Property Value

Gets a value indicating whether the watermark of this instance is currently visible.

Declaration

public bool IsWatermarkVisible { get; }

Property Value

Gets or sets the maximum height for a RadComboBox drop-down. This is a dependency property.

Declaration

public double MaxDropDownHeight { get; set; }

Property Value

Gets the minimum width of a RadComboBox drop-down. This is a readonly dependency property.

Declaration

public double MinDropDownWidth { get; }

Property Value

Get or sets the DataTemplate to be used in multiple selection mode when the IsEditable property is false. This is a dependency property.

Declaration

public DataTemplate MultipleSelectionBoxTemplate { get; set; }

Property Value

Get or sets the char separator used for separating the selected items.

Declaration

public char MultipleSelectionSeparator { get; set; }

Property Value

Get or sets the char separator string form used for separating the selected items. This string format is removed while editing the text (when editable and focused).

Declaration

public string MultipleSelectionSeparatorStringFormat { get; set; }

Property Value

Gets or sets the ControlTemplate for RadCombBox when its IsEditable property is false.

Declaration

public ControlTemplate NonEditableTemplate { get; set; }

Property Value

Gets or sets a value that specifies whether the dropdown should be opened when the control gets the focus, or not. This is a dependency property.

Declaration

public bool OpenDropDownOnFocus { get; set; }

Property Value

Gets or sets the value that specifies the name of the event that will select the text of the TextBox when IsEditable is true.

Declaration

public SelectAllTextEvents SelectAllTextEvent { get; set; }

Property Value

Gets the item that is currently visible in the selection box ContentPresenter. This is a dependency property.

Declaration

public object SelectionBoxItem { get; }

Property Value

Gets the DataTemplate that will be applied on the selection box ContentPresenter. This is a dependency property.

Declaration

public DataTemplate SelectionBoxItemTemplate { get; }

Property Value

Gets or sets the DataTemplate that should be applied on the selection box ContentPresenter when there is a selected item. This is a dependency property.

Declaration

public DataTemplate SelectionBoxTemplate { get; set; }

Property Value

Gets or sets whether a ComboBox that is open and displays a drop-down control will remain open when a user clicks the TextBox. Setting this property to true will take effect only if the IsEditable property is also true. This is a dependency property.

Declaration

public bool StaysOpenOnEdit { get; set; }

Property Value

Gets or sets the text of the currently selected item. This is a dependency property.

Declaration

public string Text { get; set; }

Property Value

Gets or sets the style of the TextBox element part of the RadComboBox. This is a dependency property.

Declaration

public Style TextBoxStyle { get; set; }

Property Value

Gets or sets the current text input that the user entered when IsEditable=false or IsReadOnly=true.

Declaration

protected string TextInputString { get; set; }

Property Value

Gets or sets the mode used for text search operations.

Declaration

public TextSearchMode TextSearchMode { get; set; }

Property Value

Remarks

Gets or sets value indicating whether to update the selection only when the focus moved out of the control or Enter key is pressed. The property takes effect only when the IsEditable property is true and the AllowMultipleSelection is false. This is a dependency property.

Declaration

public bool UpdateSelectionOnLostFocus { get; set; }

Property Value

Gets or sets a value that indicates if the Text of the control should be updated when the LostFocus event is raised. This is a dependency property.

Declaration

public bool UpdateTextOnLostFocus { get; set; }

Property Value

Updates the visual state of the control.

Declaration

protected void ChangeVisualState(bool useTransitions)

Parameters

When overridden in a derived class, undoes the effects of the method.

Declaration

protected override void ClearContainerForItemOverride(DependencyObject element, object item)

Parameters

Creates or identifies the element that is used to display the given item.

Declaration

protected override DependencyObject GetContainerForItemOverride()

Returns

Contains the keyboard navigation logic of RadComboBox.

Declaration

[SuppressMessage("Microsoft.Usage", "CA1801:ReviewUnusedParameters", MessageId = "platformKeyCode")]
[SuppressMessage("Microsoft.Maintainability", "CA1502:AvoidExcessiveComplexity")]
protected virtual bool HandleKeyDown(Key systemKey, int platformKeyCode)

Parameters

Returns

Contains the text input logic of RadComboBox when the control is not editable. This method is called from a TextInput event handler.

Declaration

protected virtual bool HandleTextInput(string text)

Parameters

Returns

Determines if the specified item is (or is eligible to be) its own container.

Declaration

protected override bool IsItemItsOwnContainerOverride(object item)

Parameters

Returns

When overridden in a derived class, is invoked whenever application code or internal processes (such as a rebuilding layout pass) call .

Declaration

public override void OnApplyTemplate()

Returns class-specific AutomationPeer implementations for the Windows Presentation Foundation (WPF) infrastructure.

Declaration

protected override AutomationPeer OnCreateAutomationPeer()

Returns

Raises the event.

Declaration

protected virtual void OnDropDownClosed(EventArgs e)

Parameters

Raises the event.

Declaration

protected virtual void OnDropDownOpened(EventArgs e)

Parameters

Raises the event. This method is invoked whenever is set to true internally.

Declaration

protected override void OnInitialized(EventArgs e)

Parameters

Called when the IsDropDownOpen property is changed.

Declaration

protected virtual void OnIsDropDownOpenChanged(bool oldValue, bool newValue)

Parameters

Called when the IsEditable property is changed.

Declaration

protected virtual void OnIsEditableChanged(bool oldValue, bool isEditable)

Parameters

Called when the property has changed.

Declaration

protected override void OnIsKeyboardFocusWithinChanged(DependencyPropertyChangedEventArgs e)

Parameters

Called when the IsMouseWheelEnabled property is changed.

Declaration

protected virtual void OnIsMouseWheelEnabledChanged(bool oldValue, bool isEnabled)

Parameters

Called before the event occurs to provide handling for the event in a derived class without attaching a delegate.

Declaration

protected override void OnMouseWheel(MouseWheelEventArgs e)

Parameters

Occurs when item at specific index is requested to be visible in the viewport.

Declaration

protected virtual void OnScrollIntoView(int itemIndex)

Parameters

Called when the selection changes.

Declaration

protected override void OnSelectionChanged(SelectionChangedEventArgs e)

Parameters

Called when the TextBoxStyle property is changed.

Declaration

protected virtual void OnTextBoxStyleChanged()

Called when the Text property is changed.

Declaration

protected virtual void OnTextChanged(string oldValue, string newValue)

Parameters

Invoked when the event is received.

Declaration

protected override void OnTextInput(TextCompositionEventArgs e)

Parameters

Prepares the specified element to display the specified item.

Declaration

protected override void PrepareContainerForItemOverride(DependencyObject element, object item)

Parameters

Occurs when the drop-down list of the combo box closes.

Declaration

public event EventHandler DropDownClosed

Event Value

Occurs when the drop-down list of the combo box opens.

Declaration

public event EventHandler DropDownOpened

Event Value