Class

RadComboBox

Initializes a new instance of the RadComboBox class.

Declaration

public RadComboBox()

Identifies the ActualClearButtonStyle property.

Declaration

public static readonly BindableProperty ActualClearButtonStyleProperty

Field Value

Identifies the ActualDropDownButtonStyle property.

Declaration

public static readonly BindableProperty ActualDropDownButtonStyleProperty

Field Value

Identifies the ActualTextInputStyle property.

Declaration

public static readonly BindableProperty ActualTextInputStyleProperty

Field Value

Identifies the BackgroundColor property.

Declaration

public static readonly BindableProperty BackgroundColorProperty

Field Value

Identifies the BorderBrush property.

Declaration

public static readonly BindableProperty BorderBrushProperty

Field Value

Identifies the ClearButtonStyle property.

Declaration

public static readonly BindableProperty ClearButtonStyleProperty

Field Value

Identifies the ClearSelectionCommand property.

Declaration

public static readonly BindableProperty ClearSelectionCommandProperty

Field Value

Identifies the ControlTemplate bindable property.

Declaration

public static readonly BindableProperty ControlTemplateProperty

Field Value

Identifies the DisplayMemberPath property.

Declaration

public static readonly BindableProperty DisplayMemberPathProperty

Field Value

Identifies the DropDownBackgroundColor property.

Declaration

public static readonly BindableProperty DropDownBackgroundColorProperty

Field Value

Identifies the DropDownBorderColor property.

Declaration

public static readonly BindableProperty DropDownBorderColorProperty

Field Value

Identifies the DropDownBorderThickness property.

Declaration

public static readonly BindableProperty DropDownBorderThicknessProperty

Field Value

Identifies the DropDownButtonStyle property.

Declaration

public static readonly BindableProperty DropDownButtonStyleProperty

Field Value

Identifies the DropDownCornerRadius property.

Declaration

public static readonly BindableProperty DropDownCornerRadiusProperty

Field Value

Identifies the DropDownHeight bindable property.

Declaration

public static readonly BindableProperty DropDownHeightProperty

Field Value

Identifies the DropDownMaxHeight bindable property.

Declaration

public static readonly BindableProperty DropDownMaxHeightProperty

Field Value

Identifies the DropDownVerticalOffset property.

Declaration

public static readonly BindableProperty DropDownVerticalOffsetProperty

Field Value

Identifies the DropDownWidth bindable property.

Declaration

public static readonly BindableProperty DropDownWidthProperty

Field Value

Identifies the FilteredItems property.

Declaration

public static readonly BindableProperty FilteredItemsProperty

Field Value

Identifies the FilteringBehavior bindable property.

Declaration

public static readonly BindableProperty FilteringBehaviorProperty

Field Value

Identifies the FontAttributes property.

Declaration

public static readonly BindableProperty FontAttributesProperty

Field Value

Identifies the FontFamily property.

Declaration

public static readonly BindableProperty FontFamilyProperty

Field Value

Identifies the FontSize property.

Declaration

public static readonly BindableProperty FontSizeProperty

Field Value

Identifies the FooterTemplate bindable property.

Declaration

public static readonly BindableProperty FooterTemplateProperty

Field Value

Identifies the HeaderTemplate bindable property.

Declaration

public static readonly BindableProperty HeaderTemplateProperty

Field Value

Identifies the HighlightTextColor property.

Declaration

public static readonly BindableProperty HighlightTextColorProperty

Field Value

Identifies the IsClearButtonVisible property.

Declaration

public static readonly BindableProperty IsClearButtonVisibleProperty

Field Value

Identifies the IsDropDownClosedOnSelection bindable property.

Declaration

public static readonly BindableProperty IsDropDownClosedOnSelectionProperty

Field Value

Identifies the IsDropDownOpen property.

Declaration

public static readonly BindableProperty IsDropDownOpenProperty

Field Value

Identifies the IsEditable bindable property.

Declaration

public static readonly BindableProperty IsEditableProperty

Field Value

Identifies the IsFilteringEnabled bindable property.

Declaration

public static readonly BindableProperty IsFilteringEnabledProperty

Field Value

Identifies the IsSpellCheckEnabled property.

Declaration

public static readonly BindableProperty IsSpellCheckEnabledProperty

Field Value

Identifies the ItemTemplate bindable property.

Declaration

public static readonly BindableProperty ItemTemplateProperty

Field Value

Identifies the ItemsSource bindable property.

Declaration

public static readonly BindableProperty ItemsSourceProperty

Field Value

Identifies the KeyDownCommand property.

Declaration

public static readonly BindableProperty KeyDownCommandProperty

Field Value

Identifies the Keyboard property.

Declaration

public static readonly BindableProperty KeyboardProperty

Field Value

Identifies the NoResultsMessage property.

Declaration

public static readonly BindableProperty NoResultsMessageProperty

Field Value

Identifies the NoResultsTemplate property.

Declaration

public static readonly BindableProperty NoResultsTemplateProperty

Field Value

Identifies the OpenOnFocus bindable property.

Declaration

public static readonly BindableProperty OpenOnFocusProperty

Field Value

Identifies the PlaceholderColor property.

Declaration

public static readonly BindableProperty PlaceholderColorProperty

Field Value

Identifies the Placeholder property.

Declaration

public static readonly BindableProperty PlaceholderProperty

Field Value

Identifies the RemoveTokenCommand property.

Declaration

public static readonly BindableProperty RemoveTokenCommandProperty

Field Value

Identifies the SearchMode property.

Declaration

public static readonly BindableProperty SearchModeProperty

Field Value

Identifies the SearchTextPath property.

Declaration

public static readonly BindableProperty SearchTextPathProperty

Field Value

Identifies the SelectedIndex property.

Declaration

public static readonly BindableProperty SelectedIndexProperty

Field Value

Identifies the SelectedItem property.

Declaration

public static readonly BindableProperty SelectedItemProperty

Field Value

Identifies the SelectedItemTemplate bindable property.

Declaration

public static readonly BindableProperty SelectedItemTemplateProperty

Field Value

Identifies the SelectedItems property.

Declaration

public static readonly BindableProperty SelectedItemsProperty

Field Value

Identifies the SelectionBoxTemplate bindable property.

Declaration

public static readonly BindableProperty SelectionBoxTemplateProperty

Field Value

Identifies the SelectionMode property.

Declaration

public static readonly BindableProperty SelectionModeProperty

Field Value

Identifies the ShowMoreTemplate property.

Declaration

public static readonly BindableProperty ShowMoreTemplateProperty

Field Value

Identifies the Style bindable property.

Declaration

public static readonly BindableProperty StyleProperty

Field Value

Identifies the TextColor property.

Declaration

public static readonly BindableProperty TextColorProperty

Field Value

Identifies the TextInputStyle property.

Declaration

public static readonly BindableProperty TextInputStyleProperty

Field Value

Identifies the Text property.

Declaration

public static readonly BindableProperty TextProperty

Field Value

Identifies the TokenTemplate property.

Declaration

public static readonly BindableProperty TokenTemplateProperty

Field Value

Gets the actual style that is used to style the clear button.

Declaration

public Style ActualClearButtonStyle { get; }

Property Value

Gets the actual style that is used to style the dropdown button.

Declaration

public Style ActualDropDownButtonStyle { get; }

Property Value

Gets the actual style that is used to style the inner RadTextInput.

Declaration

public Style ActualTextInputStyle { get; }

Property Value

Declaration

public Color BackgroundColor { get; set; }

Property Value

Gets or sets the BorderBrush of the component.

Declaration

[TypeConverter(typeof(BrushTypeConverter))]
public Brush BorderBrush { get; set; }

Property Value

Gets or sets the Style of the clear button.

Declaration

public Style ClearButtonStyle { get; set; }

Property Value

Gets or sets the command that clears the current selection, setting SelectedItem to null and clearing SelectedItems. This command is typically bound to a clear button or used programmatically to reset the selection state.

Declaration

public ICommand ClearSelectionCommand { get; set; }

Property Value

Gets or sets the control template of this view.

Declaration

public ControlTemplate ControlTemplate { get; set; }

Property Value

Gets or sets the property path used to determine which property of the data object should be displayed in the dropdown items. Use "." to display the object itself, or specify a property name like "Name" or "Title" to display a specific property.

Declaration

public string DisplayMemberPath { get; set; }

Property Value

Gets or sets the background color of the drop down part of the control.

Declaration

public Color DropDownBackgroundColor { get; set; }

Property Value

Gets or sets the color of the border around the drop down part of the control.

Declaration

public Color DropDownBorderColor { get; set; }

Property Value

Gets or sets the thickness of the border that is around the drop down part of the control.

Declaration

public Thickness DropDownBorderThickness { get; set; }

Property Value

Gets or sets the Style of the drop down button.

Declaration

public Style DropDownButtonStyle { get; set; }

Property Value

Gets or sets the corner radius of the border that is around the drop down part of the control.

Declaration

public Thickness DropDownCornerRadius { get; set; }

Property Value

Gets or sets the fixed height of the dropdown area in device-independent units. If not set or set to a negative value, the dropdown will size itself based on its content up to DropDownMaxHeight.

Declaration

public double DropDownHeight { get; set; }

Property Value

Gets or sets the maximum height of the dropdown area in device-independent units. This property constrains the dropdown height when it auto-sizes based on content, ensuring it doesn't exceed the specified limit.

Declaration

public double DropDownMaxHeight { get; set; }

Property Value

Gets or sets the vertical offset of the drop down part of the control.

Declaration

public double DropDownVerticalOffset { get; set; }

Property Value

Gets or sets the width of the dropdown area in device-independent units. If not set, the dropdown will match the width of the ComboBox control itself.

Declaration

public double DropDownWidth { get; set; }

Property Value

Gets the collection of items that match the current filter criteria when IsFilteringEnabled is true. This read-only collection is automatically updated as the user types and the filtering logic is applied.

Declaration

public IReadOnlyCollection<object> FilteredItems { get; }

Property Value

Gets or sets the custom filtering behavior used to filter items based on user input. This allows you to implement custom filtering logic beyond the built-in SearchMode options.

Declaration

public ComboBoxFilteringBehavior FilteringBehavior { get; set; }

Property Value

Gets or sets values that describe font styles.

Declaration

public FontAttributes FontAttributes { get; set; }

Property Value

Gets or sets the font family to which the font belongs.

Declaration

public string FontFamily { get; set; }

Property Value

Gets or sets the size of the font.

Declaration

[TypeConverter(typeof(FontSizeConverter))]
public double FontSize { get; set; }

Property Value

Gets or sets the template used to display the footer content at the bottom of the dropdown list. This template is rendered below all dropdown items and can contain any content or controls.

Declaration

public DataTemplate FooterTemplate { get; set; }

Property Value

Gets or sets the template used to display the header content at the top of the dropdown list. This template is rendered above all dropdown items and can contain any content or controls.

Declaration

public DataTemplate HeaderTemplate { get; set; }

Property Value

Gets or sets the color used to highlight the matched text portions when filtering is active. This provides visual feedback to users showing which parts of the item text match their search input.

Declaration

public Color HighlightTextColor { get; set; }

Property Value

Gets or sets a value indicating if the clear button should be visible.

Declaration

public bool IsClearButtonVisible { get; set; }

Property Value

Remarks

Gets or sets a value indicating whether the dropdown should automatically close when an item is selected or deselected. When false, the dropdown remains open after selection, allowing for easier multiple selection.

Declaration

public bool IsDropDownClosedOnSelection { get; set; }

Property Value

Gets or sets a value indicating whether the drop down part of the control is opened.

Declaration

public bool IsDropDownOpen { get; set; }

Property Value

Gets or sets a value indicating whether the ComboBox allows direct text input and editing. When true, users can type text directly into the control to search and filter items. When false, users can only select from the dropdown list.

Declaration

public bool IsEditable { get; set; }

Property Value

Gets or sets a value indicating whether filtering of dropdown items is enabled when the user types in the ComboBox. When true and IsEditable is also true, the dropdown list will be filtered based on user input.

Declaration

public bool IsFilteringEnabled { get; set; }

Property Value

Gets or sets a value that controls whether spell checking is enabled.

Declaration

public bool IsSpellCheckEnabled { get; set; }

Property Value

Gets or sets the template used to display each item in the dropdown list. This template defines how individual data items are rendered when the dropdown is open.

Declaration

public DataTemplate ItemTemplate { get; set; }

Property Value

Gets or sets the collection of data items that populate the ComboBox dropdown list. This can be any object that implements IEnumerable, such as a list, array, or observable collection.

Declaration

public IEnumerable ItemsSource { get; set; }

Property Value

Gets or sets the command that is invoked when a key is pressed. The parameter of this command is of type KeyboardInfo.

Declaration

public ICommand KeyDownCommand { get; set; }

Property Value

Gets or sets the keyboard type of the entry part of the control.

Declaration

public Keyboard Keyboard { get; set; }

Property Value

Gets or sets the message text displayed when no items match the current filter criteria. This provides a simple text alternative to NoResultsTemplate for informing users about empty search results.

Declaration

public string NoResultsMessage { get; set; }

Property Value

Gets or sets the template displayed when no items match the current filter criteria. This provides a customizable way to inform users that their search didn't return any results.

Declaration

public DataTemplate NoResultsTemplate { get; set; }

Property Value

Gets or sets a value indicating whether the dropdown should automatically open when the ComboBox receives focus. This property only applies when IsEditable is set to true.

Declaration

public bool OpenOnFocus { get; set; }

Property Value

Gets or sets the placeholder text displayed when the ComboBox is empty and not focused. This provides guidance to users about what they should enter or select.

Declaration

public string Placeholder { get; set; }

Property Value

Gets or sets the color of the placeholder text displayed when the ComboBox is empty. This allows customization of the placeholder text appearance to match your application's theme.

Declaration

public Color PlaceholderColor { get; set; }

Property Value

Gets or sets the command that removes individual selection tokens when SelectionMode is set to Multiple. This command is typically executed when users click the remove button on individual tokens. The parameter of this command is a selected business item, i.e. an item from the SelectedItems.

Declaration

public ICommand RemoveTokenCommand { get; set; }

Property Value

Gets or sets the search criteria mode used when filtering items in the dropdown. This determines how the user's input text is matched against the items (starts with, contains, case-sensitive options).

Declaration

public SearchMode SearchMode { get; set; }

Property Value

Gets the current search text entered by the user when IsEditable is true. This property reflects the text used for filtering and searching within the dropdown items.

Declaration

[Browsable(false)]
public string SearchText { get; }

Property Value

Gets or sets the property path used to determine which property of the data object should be used for searching and filtering. Use "." to search against the object itself, or specify a property name like "Name" to search against a specific property.

Declaration

public string SearchTextPath { get; set; }

Property Value

Gets the command that selects all available items from the ItemsSource when SelectionMode is set to Multiple. This read-only command is automatically created and can be used to provide "select all" functionality.

Declaration

public ICommand SelectAllCommand { get; }

Property Value

Gets or sets the zero-based index of the currently selected item in the ItemsSource. When SelectionMode is Single, this represents the selected item's index. When Multiple, this represents the first selected item's index or -1 if no items are selected.

Declaration

public int SelectedIndex { get; set; }

Property Value

Gets or sets the currently selected item from the ItemsSource. When SelectionMode is Single, this represents the selected item. When Multiple, this represents the first selected item or null if no items are selected.

Declaration

public object SelectedItem { get; set; }

Property Value

Gets or sets the template used to display selected items when they appear in the dropdown list. This template is typically used to provide visual indication that an item is selected, often through different styling or checkmarks.

Declaration

public DataTemplate SelectedItemTemplate { get; set; }

Property Value

Gets the collection of all currently selected items from the ItemsSource. This collection is automatically maintained and reflects the current selection state. It's particularly useful when SelectionMode is set to Multiple.

Declaration

public ObservableCollection<object> SelectedItems { get; }

Property Value

Gets or sets the template used to display the selected item in the selection box when the ComboBox is not editable. This template is only used when IsEditable is set to false and defines how the selected item appears in the collapsed state.

Declaration

public DataTemplate SelectionBoxTemplate { get; set; }

Property Value

Gets or sets the selection mode that determines how users can select items from the dropdown. Use Single for single-item selection or Multiple to allow selection of multiple items with tokens.

Declaration

public ComboBoxSelectionMode SelectionMode { get; set; }

Property Value

Gets or sets the template used to display the "show more" indicator when there are more selected tokens than can be displayed in the available space. This template appears when multiple items are selected and the ComboBox is not focused, providing a way to indicate additional selections.

Declaration

public DataTemplate ShowMoreTemplate { get; set; }

Property Value

Gets or sets the Style of the control.

Declaration

public Style Style { get; set; }

Property Value

Gets or sets the text content displayed in the ComboBox. When IsEditable is true, this represents the user-entered text. When false, this displays the text representation of the selected item.

Declaration

public string Text { get; set; }

Property Value

Gets or sets the TextColor of the component.

Declaration

public Color TextColor { get; set; }

Property Value

Gets or sets the style of the inner RadTextInput.

Declaration

public Style TextInputStyle { get; set; }

Property Value

Gets or sets the template used to display individual selection tokens when SelectionMode is set to Multiple. Each selected item is represented as a token that can be styled and customized through this template.

Declaration

public DataTemplate TokenTemplate { get; set; }

Property Value

Called when the control template is applied.

Declaration

protected override void OnApplyTemplate()

Called when the handler for this view is changed.

Declaration

protected override void OnHandlerChanged()

Overrides RadContentView.OnHandlerChanged()

Called when a property value changes.

Declaration

protected override void OnPropertyChanged(string propertyName = null)

Parameters

Occurs when the user completes text entry by pressing the Enter key or the Done button on the keyboard. This event is typically used to trigger actions when the user finishes input in editable mode.

Declaration

public event EventHandler Completed

Event Value

Occurs when the selection state changes, providing information about items that were added to or removed from the selection. This event is raised for both single and multiple selection scenarios.

Declaration

public event EventHandler<ComboBoxSelectionChangedEventArgs> SelectionChanged

Event Value