Class RadComboBox
Represents a selection control with a drop-down list that can be shown or hidden by clicking the arrow on the control.
Inherited Members
Namespace: Telerik.Windows.Controls
Assembly: Telerik.Windows.Controls.Input.dll
Syntax
[TelerikToolboxCategory("Input")]
public class RadComboBox : Selector, IThemable, IPopupWrapperOwner
Constructors
RadComboBox()
Fields
AutoCompleteSelectionModeProperty
Identifies the AutoCompleteSelectionModeProperty dependency property.
Declaration
public static readonly DependencyProperty AutoCompleteSelectionModeProperty
Field Value
System.Windows.DependencyProperty
|
CanAutocompleteSelectItemsProperty
Identifies the CanAutocompleteSelectItems dependency property.
Declaration
public static readonly DependencyProperty CanAutocompleteSelectItemsProperty
Field Value
System.Windows.DependencyProperty
|
CanKeyboardNavigationSelectItemsProperty
ClearSelectionButtonContentProperty
Identifies the ClearSelectionButtonContent dependency property.
Declaration
public static readonly DependencyProperty ClearSelectionButtonContentProperty
Field Value
System.Windows.DependencyProperty
|
ClearSelectionButtonVisibilityProperty
Identifies the learSelectionButtonVisibility dependency property.
Declaration
public static readonly DependencyProperty ClearSelectionButtonVisibilityProperty
Field Value
System.Windows.DependencyProperty
|
CommandParameterProperty
Identifies the CommandParameter dependency property.
Declaration
public static readonly DependencyProperty CommandParameterProperty
Field Value
System.Windows.DependencyProperty
|
CommandProperty
Identifies the Command dependency property.
Declaration
public static readonly DependencyProperty CommandProperty
Field Value
System.Windows.DependencyProperty
|
CommandTargetProperty
Identifies the CommandParameter dependency property.
Declaration
public static readonly DependencyProperty CommandTargetProperty
Field Value
System.Windows.DependencyProperty
|
DropDownButtonIconContentProperty
Identifies the DropDownButtonIconContent dependency property.
Declaration
public static readonly DependencyProperty DropDownButtonIconContentProperty
Field Value
System.Windows.DependencyProperty
|
DropDownButtonIconTemplateProperty
Identifies the DropDownButtonIconTemplate dependency property.
Declaration
public static readonly DependencyProperty DropDownButtonIconTemplateProperty
Field Value
System.Windows.DependencyProperty
|
DropDownWidthProperty
Identifies the DropDownWidth dependency property.
Declaration
public static readonly DependencyProperty DropDownWidthProperty
Field Value
System.Windows.DependencyProperty
|
EditableTemplateProperty
Identifies the EditableTemplate dependency property.
Declaration
public static readonly DependencyProperty EditableTemplateProperty
Field Value
System.Windows.DependencyProperty
|
EmptySelectionBoxTemplateProperty
Identifies the EmptySelectionBoxTemplate dependency property.
Declaration
public static readonly DependencyProperty EmptySelectionBoxTemplateProperty
Field Value
System.Windows.DependencyProperty
|
EmptyTextProperty
Identifies the EmptyText dependency property.
Declaration
public static readonly DependencyProperty EmptyTextProperty
Field Value
System.Windows.DependencyProperty
|
FilteringModeProperty
Identifies the FilteringMode dependency property.
Declaration
public static readonly DependencyProperty FilteringModeProperty
Field Value
System.Windows.DependencyProperty
|
IsDropDownOpenProperty
Identifies the IsDropDownOpen dependency property.
Declaration
public static readonly DependencyProperty IsDropDownOpenProperty
Field Value
System.Windows.DependencyProperty
|
IsDropDownTabNavigationEnabledProperty
IsEditableProperty
Identifies the IsEditable dependency property.
Declaration
public static readonly DependencyProperty IsEditableProperty
Field Value
System.Windows.DependencyProperty
|
IsFilteringEnabledProperty
Identifies the FilteringMode dependency property.
Declaration
public static readonly DependencyProperty IsFilteringEnabledProperty
Field Value
System.Windows.DependencyProperty
|
IsHighlightedProperty
Identifies the IsHighlighted dependency property.
Declaration
public static readonly DependencyProperty IsHighlightedProperty
Field Value
System.Windows.DependencyProperty
|
IsMouseWheelEnabledProperty
Identifies the IsMouseWheelEnabledProperty dependency property.
Declaration
public static readonly DependencyProperty IsMouseWheelEnabledProperty
Field Value
System.Windows.DependencyProperty
|
IsReadOnlyProperty
Identifies the IsReadOnly dependency property.
Declaration
public static readonly DependencyProperty IsReadOnlyProperty
Field Value
System.Windows.DependencyProperty
|
IsWatermarkVisibleProperty
Identifies the IsWatermarkVisible dependency property.
Declaration
public static readonly DependencyProperty IsWatermarkVisibleProperty
Field Value
System.Windows.DependencyProperty
|
MaxDropDownHeightProperty
Identifies the MaxDropDownHeight dependency property.
Declaration
public static readonly DependencyProperty MaxDropDownHeightProperty
Field Value
System.Windows.DependencyProperty
|
MinDropDownWidthProperty
Identifies the MinDropDownWidth readonly dependency property.
Declaration
public static readonly DependencyProperty MinDropDownWidthProperty
Field Value
System.Windows.DependencyProperty
|
NonEditableTemplateProperty
Identifies the NonEditableTemplate dependency property.
Declaration
public static readonly DependencyProperty NonEditableTemplateProperty
Field Value
System.Windows.DependencyProperty
|
OpenDropDownOnFocusProperty
Identifies the OpenDropDownOnFocus dependency property.
Declaration
public static readonly DependencyProperty OpenDropDownOnFocusProperty
Field Value
System.Windows.DependencyProperty
|
SelectAllTextEventProperty
Identifies the SelectAllTextEvents dependency property.
Declaration
public static readonly DependencyProperty SelectAllTextEventProperty
Field Value
System.Windows.DependencyProperty
|
SelectionBoxItemProperty
Identifies the SelectionBoxItem dependency property.
Declaration
public static readonly DependencyProperty SelectionBoxItemProperty
Field Value
System.Windows.DependencyProperty
|
SelectionBoxItemTemplateProperty
Identifies the SelectionBoxItemTemplate dependency property.
Declaration
public static readonly DependencyProperty SelectionBoxItemTemplateProperty
Field Value
System.Windows.DependencyProperty
|
SelectionBoxTemplateProperty
Identifies the SelectionBoxTemplate dependency property.
Declaration
public static readonly DependencyProperty SelectionBoxTemplateProperty
Field Value
System.Windows.DependencyProperty
|
StaysOpenOnEditProperty
Identifies the StaysOpenOnEdit dependency property.
Declaration
public static readonly DependencyProperty StaysOpenOnEditProperty
Field Value
System.Windows.DependencyProperty
|
TextBoxStyleProperty
Identifies the TextBoxStyle dependency property.
Declaration
public static readonly DependencyProperty TextBoxStyleProperty
Field Value
System.Windows.DependencyProperty
|
TextProperty
Identifies the Text dependency property.
Declaration
public static readonly DependencyProperty TextProperty
Field Value
System.Windows.DependencyProperty
|
TextSearchModeProperty
Identifies the FilteringMode dependency property.
Declaration
public static readonly DependencyProperty TextSearchModeProperty
Field Value
System.Windows.DependencyProperty
|
UpdateSelectionOnLostFocusProperty
Identifies the UpdateSelectionOnLostFocus dependency property.
Declaration
public static readonly DependencyProperty UpdateSelectionOnLostFocusProperty
Field Value
System.Windows.DependencyProperty
|
Properties
AutoCompleteSelectionMode
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
ComboBoxAutoCompleteSelectionMode
|
CanAutocompleteSelectItems
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 Nullable<bool> CanAutocompleteSelectItems { get; set; }
Property Value
System.Nullable<System.Boolean>
True if the control should change its selection when the user types text. False when the selection should not be changed. Null when the default behavior should be used. |
CanKeyboardNavigationSelectItems
ClearSelectionButtonContent
Gets or sets the content of the button clearing the selection. This is a dependency property.
Declaration
public object ClearSelectionButtonContent { get; set; }
Property Value
System.Object
|
ClearSelectionButtonVisibility
Gets or sets the visibility of the button clearing the selection. This is a dependency property.
Declaration
public Visibility ClearSelectionButtonVisibility { get; set; }
Property Value
System.Windows.Visibility
|
Command
Gets or sets the command that will be executed when the command source is invoked.
Declaration
public ICommand Command { get; set; }
Property Value
System.Windows.Input.ICommand
|
CommandParameter
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
System.Object
|
CommandTarget
The object that the command is being executed on.
Declaration
public UIElement CommandTarget { get; set; }
Property Value
System.Windows.UIElement
|
DropDownButtonIconContent
Gets or sets the content of the show dialog button.
Declaration
public object DropDownButtonIconContent { get; set; }
Property Value
System.Object
|
DropDownButtonIconTemplate
Gets or sets the content template of the show dialog button.
Declaration
public DataTemplate DropDownButtonIconTemplate { get; set; }
Property Value
System.Windows.DataTemplate
|
DropDownWidth
Gets or sets the width of the DropDown of the RadComboBox.
Declaration
public GridLength DropDownWidth { get; set; }
Property Value
System.Windows.GridLength
|
EditableTemplate
Gets or sets the ControlTemplate for RadCombBox when IsEditable is true.
Declaration
public ControlTemplate EditableTemplate { get; set; }
Property Value
System.Windows.Controls.ControlTemplate
|
EmptySelectionBoxTemplate
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
System.Windows.DataTemplate
|
EmptyText
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
System.String
|
FilteringBehavior
Gets or sets the behavior which is used when filtering logic applies.
Declaration
public ComboBoxFilteringBehavior FilteringBehavior { get; set; }
Property Value
ComboBoxFilteringBehavior
|
IsDropDownOpen
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
System.Boolean
|
IsDropDownTabNavigationEnabled
IsEditable
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
System.Boolean
|
IsFilteringEnabled
Gets or sets the value indicating whether the filtering is enabled. This is a dependency property.
Declaration
public bool IsFilteringEnabled { get; set; }
Property Value
System.Boolean
|
IsHighlighted
Gets or sets a value indicating whether this instance is highlighted.
Declaration
public bool IsHighlighted { get; set; }
Property Value
System.Boolean
|
IsKeyboardFocusWithin
Gets a value indicating whether keyboard focus is anywhere within the element or its visual tree child elements.
Declaration
public bool IsKeyboardFocusWithin { get; }
Property Value
System.Boolean
|
IsMouseWheelEnabled
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
System.Boolean
|
IsReadOnly
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
System.Boolean
|
IsWatermarkVisible
Gets a value indicating whether the watermark of this instance should be visible, or not.
Declaration
public bool IsWatermarkVisible { get; }
Property Value
System.Boolean
|
MaxDropDownHeight
Gets or sets the maximum height for a RadComboBox drop-down. This is a dependency property.
Declaration
public double MaxDropDownHeight { get; set; }
Property Value
System.Double
|
MinDropDownWidth
Gets the minimum width of a RadComboBox drop-down. This is a readonly dependency property.
Declaration
public double MinDropDownWidth { get; }
Property Value
System.Double
|
NonEditableTemplate
Gets or sets the ControlTemplate for RadCombBox when IsEditable is false.
Declaration
public ControlTemplate NonEditableTemplate { get; set; }
Property Value
System.Windows.Controls.ControlTemplate
|
OpenDropDownOnFocus
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
System.Boolean
|
OverrideStyles
Gets whether Style should be applied on container even if Style property is already set.
Declaration
protected override bool OverrideStyles { get; }
Property Value
System.Boolean
|
Overrides
SelectAllTextEvent
Gets or sets the value that specifies the name of the event that will select the text of the TextBox when IsEditable=true.
Declaration
public SelectAllTextEvents SelectAllTextEvent { get; set; }
Property Value
SelectAllTextEvents
|
SelectionBoxItem
Gets the item that is currently visible in the selection box ContentPresenter. This is a dependency property.
Declaration
public object SelectionBoxItem { get; }
Property Value
System.Object
|
SelectionBoxItemTemplate
Gets the DataTemplate that will be applied on the selection box ContentPresenter. This is a dependency property.
Declaration
public DataTemplate SelectionBoxItemTemplate { get; }
Property Value
System.Windows.DataTemplate
|
SelectionBoxTemplate
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
System.Windows.DataTemplate
|
StaysOpenOnEdit
Gets or sets whether a ComboBox that is open and displays a drop-down control will remain open when a user clicks the TextBox. This is a dependency property.
Declaration
public bool StaysOpenOnEdit { get; set; }
Property Value
System.Boolean
|
Text
Gets or sets the text of the currently selected item. This is a dependency property.
Declaration
public string Text { get; set; }
Property Value
System.String
|
TextBoxStyle
Gets or sets the style of the TextBox into the RadComboBox. This is a dependency property.
Declaration
public Style TextBoxStyle { get; set; }
Property Value
System.Windows.Style
|
TextInputString
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
System.String
|
TextSearchMode
Specifies the filtering mode for the RadComboBox. This is a dependency property.
Declaration
public TextSearchMode TextSearchMode { get; set; }
Property Value
TextSearchMode
|
UpdateSelectionOnLostFocus
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 affects only editable and single selection RadComboBox. This is a dependency property.
Declaration
public bool UpdateSelectionOnLostFocus { get; set; }
Property Value
System.Boolean
|
UpdateTextOnLostFocus
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
System.Boolean
|
Methods
ChangeVisualState(Boolean)
Updates the visual state of the control.
Declaration
protected override void ChangeVisualState(bool useTransitions)
Parameters
System.Boolean
useTransitions
Indicates whether transitions should be used. |
Overrides
ClearContainerForItemOverride(DependencyObject, Object)
When overridden in a derived class, undoes the effects of the System.Windows.Controls.ItemsControl.PrepareContainerForItemOverride(System.Windows.DependencyObject,System.Object) method.
Declaration
protected override void ClearContainerForItemOverride(DependencyObject element, object item)
Parameters
System.Windows.DependencyObject
element
The container element. |
System.Object
item
The Item. |
GetContainerForItemOverride()
Creates or identifies the element that is used to display the given item.
Declaration
protected override DependencyObject GetContainerForItemOverride()
Returns
System.Windows.DependencyObject
|
HandleKeyDown(Key, Int32)
Contains the keyboard navigation logic of RadComboBox.
Declaration
protected virtual bool HandleKeyDown(Key systemKey, int platformKeyCode)
Parameters
System.Windows.Input.Key
systemKey
The key that has been pressed. |
System.Int32
platformKeyCode
The platform key code of the pressed key. |
Returns
System.Boolean
True if the KeyDown event should be handled, otherwise false. |
HandleTextInput(String)
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
System.String
text
The text from the corresponding TextCompositionEventArgs. |
Returns
System.Boolean
True if the TextInput event should be handled, otherwise false. |
IsItemItsOwnContainerOverride(Object)
Determines if the specified item is (or is eligible to be) its own container.
Declaration
protected override bool IsItemItsOwnContainerOverride(object item)
Parameters
System.Object
item
The item to check. |
Returns
System.Boolean
True if the item is (or is eligible to be) its own container; otherwise, false. |
OnApplyTemplate()
When overridden in a derived class, is invoked whenever application code or internal processes (such as a rebuilding layout pass) call System.Windows.Controls.Control.ApplyTemplate.
Declaration
public override void OnApplyTemplate()
Overrides
OnCreateAutomationPeer()
Returns class-specific System.Windows.Automation.Peers.AutomationPeer implementations for the Windows Presentation Foundation (WPF) infrastructure.
Declaration
protected override AutomationPeer OnCreateAutomationPeer()
Returns
System.Windows.Automation.Peers.AutomationPeer
The type-specific System.Windows.Automation.Peers.AutomationPeer implementation. |
OnDropDownClosed(EventArgs)
Raises the DropDownClosed event.
Declaration
protected virtual void OnDropDownClosed(EventArgs e)
Parameters
System.EventArgs
e
The System.EventArgs instance containing the event data. |
OnDropDownOpened(EventArgs)
Raises the DropDownOpened event.
Declaration
protected virtual void OnDropDownOpened(EventArgs e)
Parameters
System.EventArgs
e
The System.EventArgs instance containing the event data. |
OnIsDropDownOpenChanged(Boolean, Boolean)
Called when the IsDropDownOpen property is changed.
Declaration
protected virtual void OnIsDropDownOpenChanged(bool oldValue, bool newValue)
Parameters
System.Boolean
oldValue
The old value of the IsDropDownOpen property. |
System.Boolean
newValue
The new value of the IsDropDownOpen property. |
OnIsEditableChanged(Boolean, Boolean)
Called when the IsEditable property is changed.
Declaration
protected virtual void OnIsEditableChanged(bool oldValue, bool isEditable)
Parameters
System.Boolean
oldValue
The old value of the IsEditable property. |
System.Boolean
isEditable
The new value of the IsEditable property. |
OnIsMouseWheelEnabledChanged(Boolean, Boolean)
Called when the IsMouseWheelEnabled property is changed.
Declaration
protected virtual void OnIsMouseWheelEnabledChanged(bool oldValue, bool isEnabled)
Parameters
System.Boolean
oldValue
The old value of the IsMouseWheelEnabled property. |
System.Boolean
isEnabled
The new value of the IsMouseWheelEnabled property. |
OnItemsChanged(NotifyCollectionChangedEventArgs)
Raises the ItemsChanged event.
Declaration
protected override void OnItemsChanged(NotifyCollectionChangedEventArgs e)
Parameters
System.Collections.Specialized.NotifyCollectionChangedEventArgs
e
The System.Collections.Specialized.NotifyCollectionChangedEventArgs instance containing the event data. |
Overrides
OnMouseWheel(MouseWheelEventArgs)
Called before the System.Windows.UIElement.MouseWheel event occurs to provide handling for the event in a derived class without attaching a delegate.
Declaration
protected override void OnMouseWheel(MouseWheelEventArgs e)
Parameters
System.Windows.Input.MouseWheelEventArgs
e
A System.Windows.Input.MouseWheelEventArgs that contains the event data. |
OnScrollIntoView(Int32)
Occurs when item at specific index is requested to be visible in the viewport.
Declaration
protected virtual void OnScrollIntoView(int itemIndex)
Parameters
System.Int32
itemIndex
The index of the item to scroll to. |
OnSelectionChanged(SelectionChangedEventArgs)
Called when the selection changes.
Declaration
protected override void OnSelectionChanged(SelectionChangedEventArgs e)
Parameters
System.Windows.Controls.SelectionChangedEventArgs
e
The event data. |
Overrides
OnTextBoxStyleChanged()
Called when the TextBoxStyle property is changed.
Declaration
protected virtual void OnTextBoxStyleChanged()
OnTextChanged(String, String)
Called when the Text property is changed.
Declaration
protected virtual void OnTextChanged(string oldValue, string newValue)
Parameters
System.String
oldValue
The old value of the Text property. |
System.String
newValue
The new value of the Text property. |
OnTextInput(TextCompositionEventArgs)
Invoked when the System.Windows.UIElement.TextInput event is received.
Declaration
protected override void OnTextInput(TextCompositionEventArgs e)
Parameters
System.Windows.Input.TextCompositionEventArgs
e
Information about the event. |
PrepareContainerForItemOverride(DependencyObject, Object)
Prepares the specified element to display the specified item.
Declaration
protected override void PrepareContainerForItemOverride(DependencyObject element, object item)
Parameters
System.Windows.DependencyObject
element
Element used to display the specified item. |
System.Object
item
Specified item. |
Overrides
Events
DropDownClosed
Occurs when the drop-down list of the combo box closes.
Declaration
public event EventHandler DropDownClosed
Event Type
System.EventHandler
|
DropDownOpened
Occurs when the drop-down list of the combo box opens.
Declaration
public event EventHandler DropDownOpened
Event Type
System.EventHandler
|