Back to all docs
API Reference / Telerik.Windows.Controls / RadListBox
New to Telerik UI for WPF? Start a free 30-day trial

RadListBox

Class

Represents a control that displays a list of items with interactive features, allowing users to select, manipulate, and reorder items through touch and keyboard input. The RadListBox supports drag-and-drop functionality, customizable visual elements, and seamless scrolling experiences, making it suitable for advanced user interfaces. It includes various dependency properties such as DropVisualProvider and DragDropBehavior that enhance its interactivity, as well as powerful selection and navigation capabilities.

Definition

Namespace:Telerik.Windows.Controls

Assembly:Telerik.Windows.Controls.dll

Syntax:
C#
[TelerikToolboxCategory("Data")]
public class RadListBox : ListControl, IMultiSelector, ISelector, ISelectorInteraction, IAutocomplete, IListControl, ICommandSource, IScrollingServiceCore, IScrollingInfo

Inheritance: objectItemsControlSelectorListControlRadListBox

Derived Classes: DockingNavigatorListBoxFileBrowserListBoxOfficeNavigationBarDialogListBoxRadClockRadColorPaletteViewRadGallery...

Implements: IAutocompleteICommandSourceIListControlIMultiSelectorIScrollingInfoIScrollingServiceCoreISelectorISelectorInteraction...

Inherited Members ListControl.CanAutocompleteSelectItemsPropertyListControl.TextSearchModePropertyListControl.CanAutocompleteSelectPartialMatchesPropertyListControl.TypedTextPropertyListControl.CommandPropertyListControl.CommandParameterPropertyListControl.CommandTargetPropertyListControl.CanKeyboardNavigationSelectItemsPropertyListControl.IsScrollIntoViewEnabledPropertyListControl.PrepareContainerForItemOverride(DependencyObject, object)ListControl.ClearContainerForItemOverride(DependencyObject, object)ListControl.OnItemsPanelChanged(ItemsPanelTemplate, ItemsPanelTemplate)ListControl.OnPropertyChanged(DependencyPropertyChangedEventArgs)ListControl.ClearContainerStates(FrameworkElement)ListControl.HighlightedIndexChanged(int, Key)ListControl.OnMatchingItemChanged()ListControl.OnAutocompleteBehaviorTypedTextChanged()ListControl.IsItemItsOwnContainerOverride(object)ListControl.IsIndexSelectable(int)ListControl.OnSelectionModeChanged()ListControl.CanPerformSelection()ListControl.GetScrollViewerPart()ListControl.ScrollIntoView(object)ListControl.ScrollIntoView(int)ListControl.SelectAllCommandListControl.CanAutocompleteSelectItemsListControl.CanAutocompleteSelectPartialMatchesListControl.TextSearchModeListControl.CanKeyboardNavigationSelectItemsListControl.IsScrollIntoViewEnabledListControl.TypedTextListControl.CommandListControl.CommandParameterListControl.CommandTargetListControl.IsItemsHostVisibleListControl.HighlightedItemListControl.KeyboardNavigationListControl.AutocompleteBehaviorListControl.HighlightedIndexItemsControlSelector.SelectionModePropertyItemsControlSelector.IsSynchronizedWithCurrentItemPropertyItemsControlSelector.SelectedIndexPropertyItemsControlSelector.SelectedItemPropertyItemsControlSelector.SelectedValuePropertyItemsControlSelector.SelectedValuePathPropertyItemsControlSelector.TextPropertyItemsControlSelector.TextPathPropertyItemsControlSelector.EnableSelectionCachingPropertyItemsControlSelector.SelectionChangedEventItemsControlSelector.OnItemsSourceChanged(IEnumerable, IEnumerable)ItemsControlSelector.ChangeVisualState(bool)ItemsControlSelector.OnIsEnabledChanged(DependencyPropertyChangedEventArgs)ItemsControlSelector.InitializeValueRetriever()ItemsControlSelector.InitializeSelectionBehavior()ItemsControlSelector.GetSelectionBehavior()ItemsControlSelector.EndInit()ItemsControlSelector.SelectionModeItemsControlSelector.IsSynchronizedWithCurrentItemItemsControlSelector.SelectedItemsItemsControlSelector.SelectionHelperItemsControlSelector.SelectedIndexItemsControlSelector.SelectedItemItemsControlSelector.SelectedValueItemsControlSelector.SelectedValuePathItemsControlSelector.SelectedValueBindingItemsControlSelector.TextBindingItemsControlSelector.TextItemsControlSelector.TextPathItemsControlSelector.EnableSelectionCachingItemsControlSelector.ItemSearchItemsControlSelector.ValueRetrieverItemsControlSelector.TextRetrieverItemsControlSelector.SelectionChanged...

Constructors

RadListBox()

Initializes a new instance of the RadListBox class.

C#
public RadListBox()

Fields

DataConverterProperty

DependencyProperty

Identifies the DataConverter dependency property.

C#
public static readonly DependencyProperty DataConverterProperty

DragDropBehaviorProperty

DependencyProperty

Identifies the DragDropBehavior property.

C#
public static readonly DependencyProperty DragDropBehaviorProperty

DragVisualProviderProperty

DependencyProperty

Identifies the DragVisualProvider dependency property.

C#
public static readonly DependencyProperty DragVisualProviderProperty

DropVisualProviderProperty

DependencyProperty

Identifies the IsReadOnly property.

C#
public static readonly DependencyProperty DropVisualProviderProperty

Properties

DataConverter

Gets or sets the DataConverter. This is a dependency property.

C#
public DataConverter DataConverter { get; set; }

DragDropBehavior

Gets or sets the DragDropBehavior. This is a dependency property.

C#
public ListBoxDragDropBehavior DragDropBehavior { get; set; }

DragVisualProvider

Gets or sets the DragVisualProvider. This is a dependency property.

C#
public IDragVisualProvider DragVisualProvider { get; set; }

DropVisualProvider

Gets or sets the DropVisualProvider. This is a dependency property.

C#
public IDropVisualProvider DropVisualProvider { get; set; }

Methods

GetContainerForItemOverride()

DependencyObject

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

C#
protected override DependencyObject GetContainerForItemOverride()
Returns:

DependencyObject

The element that is used to display the given item.

Overrides: ListControl.GetContainerForItemOverride()

GetDataItem(UIElement)

Gets the data item according to its container.

C#
public override object GetDataItem(UIElement container)
Parameters:containerUIElement

The container.

Returns:

object

Overrides: ItemsControlSelector.GetDataItem(UIElement)

HandleKeyboardInput(Key)

When overridden in a derived class, is invoked whenever application code or internal processes call HandleKeyboardInput(Key). Override this method if a custom keyboard navigation is required.

C#
protected override bool HandleKeyboardInput(Key key)
Parameters:keyKey

The key.

Returns:

bool

Overrides: ListControl.HandleKeyboardInput(Key)

InitializeTextRetriever()

Initializes the text Retriever.

C#
protected override void InitializeTextRetriever()

Overrides: ItemsControlSelector.InitializeTextRetriever()

IsItemSelectable(object)

Determines whether an item is selectable or not.

C#
protected override bool IsItemSelectable(object item)
Parameters:itemobject

The item.

Returns:

bool

Overrides: ItemsControlSelector.IsItemSelectable(object)

OnApplyTemplate()

When overridden in a derived class, is invoked whenever application code or internal processes call .

C#
public override void OnApplyTemplate()

Overrides: ListControl.OnApplyTemplate()

OnCreateAutomationPeer()

AutomationPeer

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

C#
protected override AutomationPeer OnCreateAutomationPeer()
Returns:

AutomationPeer

OnInitialized(EventArgs)

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

C#
protected override void OnInitialized(EventArgs e)
Parameters:eEventArgs

The RoutedEventArgs that contains the event data.

OnItemsChanged(NotifyCollectionChangedEventArgs)

Raises the event.

C#
protected override void OnItemsChanged(NotifyCollectionChangedEventArgs e)
Parameters:eNotifyCollectionChangedEventArgs

The NotifyCollectionChangedEventArgs instance containing the event data.

Overrides: ItemsControlSelector.OnItemsChanged(NotifyCollectionChangedEventArgs)

OnKeyDown(KeyEventArgs)

Invoked when the event is received.

C#
protected override void OnKeyDown(KeyEventArgs e)
Parameters:eKeyEventArgs

Information about the event.

OnSelectionChanged(SelectionChangedEventArgs)

Called when the selection changes.

C#
protected override void OnSelectionChanged(SelectionChangedEventArgs e)
Parameters:eSelectionChangedEventArgs

The event data.

Overrides: ListControl.OnSelectionChanged(SelectionChangedEventArgs)

OnTextInput(TextCompositionEventArgs)

Invoked when the event is received.

C#
protected override void OnTextInput(TextCompositionEventArgs e)
Parameters:eTextCompositionEventArgs

Information about the event.

UpdateItems(NotifyCollectionChangedAction, IList, IList)

Updates the items when ItemsChanged occurs.

C#
protected override void UpdateItems(NotifyCollectionChangedAction action, IList newItems, IList oldItems)
Parameters:actionNotifyCollectionChangedAction

The action.

newItemsIList

The new items.

oldItemsIList

The old items.

Overrides: ItemsControlSelector.UpdateItems(NotifyCollectionChangedAction, IList, IList)

In this article
DefinitionConstructorsRadListBox()FieldsDataConverterPropertyDragDropBehaviorPropertyDragVisualProviderPropertyDropVisualProviderPropertyPropertiesDataConverterDragDropBehaviorDragVisualProviderDropVisualProviderMethodsGetContainerForItemOverride()GetDataItem(UIElement)HandleKeyboardInput(Key)InitializeTextRetriever()IsItemSelectable(object)OnApplyTemplate()OnCreateAutomationPeer()OnInitialized(EventArgs)OnItemsChanged(NotifyCollectionChangedEventArgs)OnKeyDown(KeyEventArgs)OnSelectionChanged(SelectionChangedEventArgs)OnTextInput(TextCompositionEventArgs)UpdateItems(NotifyCollectionChangedAction, IList, IList)
Not finding the help you need?
Contact Support