Back to all docs
API Reference / Telerik.Windows.Controls / RadListBox

Class
RadListBox

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:
cs-api-definition
[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.

Declaration

cs-api-definition
public RadListBox()

Fields

DataConverterProperty

Identifies the DataConverter dependency property.

Declaration

cs-api-definition
public static readonly DependencyProperty DataConverterProperty

Field Value

DependencyProperty

DragDropBehaviorProperty

Identifies the DragDropBehavior property.

Declaration

cs-api-definition
public static readonly DependencyProperty DragDropBehaviorProperty

Field Value

DependencyProperty

DragVisualProviderProperty

Identifies the DragVisualProvider dependency property.

Declaration

cs-api-definition
public static readonly DependencyProperty DragVisualProviderProperty

Field Value

DependencyProperty

DropVisualProviderProperty

Identifies the IsReadOnly property.

Declaration

cs-api-definition
public static readonly DependencyProperty DropVisualProviderProperty

Field Value

DependencyProperty

Properties

DataConverter

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

Declaration

cs-api-definition
public DataConverter DataConverter { get; set; }

Property Value

DataConverter

DragDropBehavior

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

Declaration

cs-api-definition
public ListBoxDragDropBehavior DragDropBehavior { get; set; }

Property Value

ListBoxDragDropBehavior

DragVisualProvider

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

Declaration

cs-api-definition
public IDragVisualProvider DragVisualProvider { get; set; }

Property Value

IDragVisualProvider

DropVisualProvider

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

Declaration

cs-api-definition
public IDropVisualProvider DropVisualProvider { get; set; }

Property Value

IDropVisualProvider

Methods

GetContainerForItemOverride()

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

Declaration

cs-api-definition
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.

Declaration

cs-api-definition
public override object GetDataItem(UIElement container)

Parameters

container

UIElement

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.

Declaration

cs-api-definition
protected override bool HandleKeyboardInput(Key key)

Parameters

key

Key

The key.

Returns

bool

Overrides ListControl.HandleKeyboardInput(Key)

InitializeTextRetriever()

Initializes the text Retriever.

Declaration

cs-api-definition
protected override void InitializeTextRetriever()

Overrides ItemsControlSelector.InitializeTextRetriever()

IsItemSelectable(object)

Determines whether an item is selectable or not.

Declaration

cs-api-definition
protected override bool IsItemSelectable(object item)

Parameters

item

object

The item.

Returns

bool

Overrides ItemsControlSelector.IsItemSelectable(object)

OnApplyTemplate()

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

Declaration

cs-api-definition
public override void OnApplyTemplate()

Overrides ListControl.OnApplyTemplate()

OnCreateAutomationPeer()

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

Declaration

cs-api-definition
protected override AutomationPeer OnCreateAutomationPeer()

Returns

AutomationPeer

OnInitialized(EventArgs)

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

Declaration

cs-api-definition
protected override void OnInitialized(EventArgs e)

Parameters

e

EventArgs

The RoutedEventArgs that contains the event data.

OnItemsChanged(NotifyCollectionChangedEventArgs)

Raises the event.

Declaration

cs-api-definition
protected override void OnItemsChanged(NotifyCollectionChangedEventArgs e)

Parameters

e

NotifyCollectionChangedEventArgs

The NotifyCollectionChangedEventArgs instance containing the event data.

Overrides ItemsControlSelector.OnItemsChanged(NotifyCollectionChangedEventArgs)

OnKeyDown(KeyEventArgs)

Invoked when the event is received.

Declaration

cs-api-definition
protected override void OnKeyDown(KeyEventArgs e)

Parameters

e

KeyEventArgs

Information about the event.

OnSelectionChanged(SelectionChangedEventArgs)

Called when the selection changes.

Declaration

cs-api-definition
protected override void OnSelectionChanged(SelectionChangedEventArgs e)

Parameters

e

SelectionChangedEventArgs

The event data.

Overrides ListControl.OnSelectionChanged(SelectionChangedEventArgs)

OnTextInput(TextCompositionEventArgs)

Invoked when the event is received.

Declaration

cs-api-definition
protected override void OnTextInput(TextCompositionEventArgs e)

Parameters

e

TextCompositionEventArgs

Information about the event.

UpdateItems(NotifyCollectionChangedAction, IList, IList)

Updates the items when ItemsChanged occurs.

Declaration

cs-api-definition
protected override void UpdateItems(NotifyCollectionChangedAction action, IList newItems, IList oldItems)

Parameters

action

NotifyCollectionChangedAction

The action.

newItems

IList

The new items.

oldItems

IList

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