Click or drag to resize
RadListControl Class
This class represents data in a list layout similar to the ListBox control provided by Microsoft.
Inheritance Hierarchy
SystemObject
  SystemMarshalByRefObject
    System.ComponentModelComponent
      System.Windows.FormsControl
        System.Windows.FormsScrollableControl
          Telerik.WinControlsRadControl
            Telerik.WinControls.UIRadListControl

Namespace: Telerik.WinControls.UI
Assembly: Telerik.WinControls.UI (in Telerik.WinControls.UI.dll) Version: 2018.3.911.40 (2018.3.911.40)
Syntax
[ComVisibleAttribute(true)]
[DefaultEventAttribute("SelectedIndexChanged")]
[LookupBindingPropertiesAttribute("DataSource", "DisplayMember", "ValueMember", "SelectedValue")]
[ClassInterfaceAttribute(ClassInterfaceType.AutoDispatch)]
[ComplexBindingPropertiesAttribute("DataSource", "ValueMember")]
[TelerikToolboxCategoryAttribute("Data Controls")]
public class RadListControl : RadControl

The RadListControl type exposes the following members.

Constructors
  NameDescription
Public methodRadListControl
Initializes a new instance of the RadListControl class
Top
Properties
  NameDescription
Public propertyAccessibilityRequested
Gets or sets a value indicating whether the CodedUI Tests functionality is requested from external program such a Narrator.
(Inherited from RadControl.)
Public propertyActiveItem
Gets or sets the active item. The Active item is relevant only in MultiSimple SelectionMode or MultiExtended in combination with the control keyboard key.
Public propertyAllowDragDrop
Gets or sets value indicating if the user can reorder items via drag and drop.
Public propertyAllowShowFocusCues
Indicates focus cues display, when available, based on the corresponding control type and the current UI state.
(Inherited from RadControl.)
Public propertyAnalyticsName
Gets or sets the Analytics Name associated with this control. By default the Control Name property is logged. If you want to customize the information which will be logged for this control set this property to a preferred value.
(Inherited from RadControl.)
Public propertyAutoSize

Gets or sets a value indicating whether the control is automatically resized to display its entire contents.

(Inherited from RadControl.)
Public propertyAutoSizeItems
Gets or sets a value that indicates whether items will be sized according to their content. If this property is true the user can set the Height property of each individual RadListDataItem in the Items collection in order to override the automatic sizing.
Public propertyBackColor
RadListControl consists of multiple visual elements and separate settings are provided to customize their appearance. Current BackColor property might be ignored.
(Overrides RadControlBackColor.)
Public propertyBehavior
Gets the input behavior for the control.
(Inherited from RadControl.)
Public propertyCaseSensitiveSort
Gets or sets a value that indicates whether text case will be taken into account when sorting.
Public propertyCausesValidation
Gets or sets a value indicating whether the control causes validation to be performed on any controls that require validation when it receives focus.
(Inherited from RadControl.)
Public propertyCommandBindings (Inherited from RadControl.)
Public propertyDataMember
Public propertyDataSource
Gets or sets an object which will provide the data to be visualized as a list.
Protected propertyDefaultSize (Overrides ControlDefaultSize.)
Public propertyDescriptionTextMember
Gets or sets a property name which will be used to extract a text for description text from the data items. The value of the property with this name will be available via the Value property of every RadListDataItem in the Items collection.
Public propertyDisplayMember
Gets or sets a property name which will be used to extract a string value from the data items in order to provide a meaningful display value.
Public propertyElementTree (Inherited from RadControl.)
Public propertyEnableAlternatingItemColor
Gets or sets a value indicating whether alternating item color is enabled.
Public propertyEnableAnalytics
Gets or sets a value indicating whether the Analytics functionality is enabled or disabled for this control.
(Inherited from RadControl.)
Public propertyEnableCodedUITests
Gets or sets a value indicating whether the CodedUI Tests functionality is enabled.
(Inherited from RadControl.)
Public propertyEnableGestures
Gets or sets a value indicating whether the Gestures functionality is enabled.
(Inherited from RadControl.)
Public propertyEnableKeyMap
Gets or sets whether Key Map (Office 2007 like accelerator keys map) is used for this specific control. Currently this option is implemented for the RadRibbonBar control only.
(Inherited from RadControl.)
Public propertyEnableKineticScrolling
Gets or sets a value indicating whether the kinetic scrolling function is enabled.
Public propertyEnableRadAccessibilityObjects
Gets or sets a value indicating whether the RadControls Accessible custom object is enabled.
(Inherited from RadControl.)
Public propertyEnableTheming
Gets or sets value indicating whether the control is styled through theme
(Inherited from RadControl.)
Public propertyFilter
Gets or sets a predicate which filters which items can be visible.
Public propertyFilterExpression
Gets or sets a filter expression which determines which items will be visible.
Public propertyFindStringComparer
Gets or sets an object that implements IFindStringComparer. The value of this property is used in the FindString() method when searching for an item.
Public propertyFitItemsToSize
Public propertyFocusable (Inherited from RadControl.)
Public propertyFocusedElement (Inherited from RadControl.)
Public propertyFont
Gets or sets the Font of the control. This is actually the Font property of the root element.
(Inherited from RadControl.)
Public propertyForeColor
RadListControl consists of multiple visual elements and separate settings are provided to customize their appearance. Current ForeColor property might be ignored.
(Overrides RadControlForeColor.)
Public propertyFormatString
Gets or sets a format string which will be used for visual formatting of the items text.
Public propertyFormattingEnabled
Gets or sets a value that indicates whether the FormatString and FormatInfo properties will be used to format the items text. Setting this property to false may improve performance.
Public propertyImageList
Gets or sets the ImageList that contains the images displayed by this control.
(Inherited from RadControl.)
Public propertyImageScalingSize
Gets or sets the image scaling size.
(Inherited from RadControl.)
Public propertyIsDesignMode (Inherited from RadControl.)
Public propertyIsDisplayed
Determines whether the control is currently displayed on the screen.
(Inherited from RadControl.)
Public propertyIsFilterActive
Gets a value indicating whether there is a Filter or FilterExpression set.
Public propertyIsInitializing (Inherited from RadControl.)
Public propertyIsLoaded
Determines whether the control is properly loaded.
(Inherited from RadControl.)
Public propertyItemHeight
Public propertyItems
Gets the Items collection. Items can not be modified in data bound mode, and a DataSource can not be assigned while there are items in this collection.
Public propertyItemTextComparisonMode
Gets or sets a value that determines whether the FindString() method searches via the text property set by the user or by the text provided by the data binding logic, that is, by DisplayMember.
Public propertyKeyboardSearchEnabled
Gets or sets a value that determines whether the user can search for an item by typing characters when RadListControl is focused.
Public propertyKeyboardSearchResetInterval
Gets or sets a value that specifies how long the user must wait before searching with the keyboard is reset.
Public propertyLayoutManager (Inherited from RadControl.)
Public propertyListElement
The ListElement responsible for the majority of the control logic. The RadListControl is a wrapper of the RadListElement.
Public propertyMaximumSize
Gets or sets the size that is the upper limit that GetPreferredSize can specify.
(Inherited from RadControl.)
Public propertyMinimumSize
Gets or sets the size that is the lower limit that GetPreferredSize can specify
(Inherited from RadControl.)
Public propertyPadding
Gets or sets padding within the control.
(Inherited from RadControl.)
Public propertyRootElement
Gets the RootElement of the control.
(Inherited from RadControl.)
Public propertyScrollMode
Gets or set the scroll mode.
Public propertySelectedIndex
Gets or sets the currently selected index.
Public propertySelectedItem
Gets or sets the currently selected item.
Public propertySelectedItems
Provides a read only interface to the selected items. In order to select an item, use its Selected property.
Public propertySelectedValue
Gets or sets the SelectedValue. A linear search is performed to find a data item that has the same value in its Value property and SelectedItem and SelectedIndex are updated to it and its index respectively.
Public propertySelectionMode
Gets or sets the SelectionMode of RadListControl. This property has a similar effect to the SelectionMode of the standard Microsoft ListBox control.
Public propertyShowItemToolTips
Gets or sets a value indicating whether ToolTips are shown for the RadItem objects contained in the RadControl.
(Inherited from RadControl.)
Public propertySite (Inherited from RadControl.)
Public propertySmallImageList
Gets or sets the SmallImageList that contains the small images which are displayed when there's not enough space.
(Inherited from RadControl.)
Public propertySmallImageScalingSize
Gets or sets the small image scaling size.
(Inherited from RadControl.)
Public propertySortStyle
Gets or sets the sort style.
Public propertySuspendItemsChangeEvents
Gets or sets a value that indicates if this RadListControl will stop firing the ItemsChanging and ItemsChanged events.
Public propertySuspendSelectionEvents
Gets or sets a value that determines whether to stop the selection events from firing. These are SelectedIndexChanged, SelectedIndexChanging and SelectedValueChanged.
Public propertyText
This property is not relevant for this class.
(Overrides RadControlText.)
Public propertyThemeClassName
Gets or sets the class name string that ThemeResolutionService will use to find the themes registered for the control.
(Inherited from RadControl.)
Public propertyThemeName
Gets or sets control's preferred theme name. Themes are stored and retrieved using APIs of ThemeResolutionService.
(Inherited from RadControl.)
Public propertyUseCompatibleTextRendering
Determines whether to use compatible text rendering engine (GDI+) or not (GDI).
(Inherited from RadControl.)
Protected propertyValidationCancel (Inherited from RadControl.)
Public propertyValueMember
Gets or sets a property name which will be used to extract a value from the data items. The value of the property with this name will be available via the Value property of every RadListDataItem in the Items collection.
Top
Methods
  NameDescription
Public methodBeginInit
Suspends layout during initialization.
(Inherited from RadControl.)
Public methodBeginUpdate
Suspends internal notifications and processing in order to improve performance. This method is cumulative, that is, if BeginUpdate is called N times, EndUpdate must also be called N times. Calling BeginUpdate will cause the ItemsChanged event to stop firing until EndUpdate is called.
Public methodCallAccessibilityNotifyClients
This method is used internally!
(Inherited from RadControl.)
Public methodCallBaseOnGotFocus
This method is used internally!
(Inherited from RadControl.)
Public methodCallBaseOnKeyDown
This method is used internally!
(Inherited from RadControl.)
Public methodCallBaseOnKeyPress
This method is used internally!
(Inherited from RadControl.)
Public methodCallBaseOnKeyUp
This method is used internally!
(Inherited from RadControl.)
Public methodCallBaseOnLostFocus
This method is used internally!
(Inherited from RadControl.)
Public methodCallOnClick
This method is used internally!
(Inherited from RadControl.)
Public methodCallOnDoubleClick
This method is used internally!
(Inherited from RadControl.)
Public methodCallOnKeyDown
This method is used internally!
(Inherited from RadControl.)
Public methodCallOnKeyPress
This method is used internally!
(Inherited from RadControl.)
Public methodCallOnKeyUp
This method is used internally!
(Inherited from RadControl.)
Public methodCallOnMouseCaptureChanged
This method is used internally!
(Inherited from RadControl.)
Public methodCallOnMouseDown
This method is used internally!
(Inherited from RadControl.)
Public methodCallOnMouseEnter
This method is used internally!
(Inherited from RadControl.)
Public methodCallOnMouseHover
This method is used internally!
(Inherited from RadControl.)
Public methodCallOnMouseLeave
This method is used internally!
(Inherited from RadControl.)
Public methodCallOnMouseMove
This method is used internally!
(Inherited from RadControl.)
Public methodCallOnMouseUp
This method is used internally!
(Inherited from RadControl.)
Public methodCallOnMouseWheel
This method is used internally!
(Inherited from RadControl.)
Public methodCallOnPreviewKeyDown
This method is used internally!
(Inherited from RadControl.)
Public methodCallOnScreenTipNeeded
This method is used internally!
(Inherited from RadControl.)
Public methodCallOnThemeNameChanged
This method is used internally!
(Inherited from RadControl.)
Public methodCallOnToolTipTextNeeded
This method is used internally!
(Inherited from RadControl.)
Public methodCallOnVisibleChanged
This method is used internally!
(Inherited from RadControl.)
Protected methodCanEditElementAtDesignTime (Overrides RadControlCanEditElementAtDesignTime(RadElement).)
Public methodCanEditUIElement
Determines whether an element from this element tree may be displayed in the EditUIElements dialog.
(Inherited from RadControl.)
Protected methodClearMeasuredSize
Protected methodConstruct (Inherited from RadControl.)
Public methodControlDefinesThemeForElement
Checks whether the element's theme is defined by the control.
(Inherited from RadControl.)
Protected methodCreateAccessibilityInstance (Overrides ControlCreateAccessibilityInstance.)
Protected methodCreateBehavior
Creates the input behavior instance. Allows inheritors to provide custom input implementations.
(Inherited from RadControl.)
Protected methodCreateChildItems (Overrides RadControlCreateChildItems(RadElement).)
Protected methodCreateListElement
Protected methodCreateRootElement (Inherited from RadControl.)
Public methodDeferRefresh
Defers the refresh.
Public methodDisableGesture
Disable firing gesture events of the specified type.
(Inherited from RadControl.)
Protected methodDispose
Releases the unmanaged resources used by the RadListControl and optionally releases the managed resources
(Overrides RadControlDispose(Boolean).)
Public methodEnableGesture
Enable firing gesture events of the specified type.
(Inherited from RadControl.)
Public methodEndInit (Overrides RadControlEndInit.)
Public methodEndUpdate
Resumes the internal notifications and processing previously suspended by BeginUpdate.
Public methodFindItemExact
Protected methodFindPropertyInChildren (Inherited from RadControl.)
Public methodFindString(String)
Searches for an item related to the specified string. The relation is described by the object assigned to FindStringComparer property. By default this relation is the System.String.StartsWith(). This method starts searching from the beginning of the items.
Public methodFindString(String, Int32)
Searches for an item related to the specified string. The relation is described by the object assigned to FindStringComparer property. By default this relation is the System.String.StartsWith(). This method starts searching from the specified index. If the algorithm reaches the end of the Items collection it wraps to the beginning and continues until one before the provided index.
Public methodFindStringExact(String)
Searches for an item in the same manner as FindString() but matches an item only if its text is exactly equal to the provided string.
Public methodFindStringExact(String, Int32)
Searches for an item in the same manner as FindString() but matches an item only if its text is exactly equal to the provided string.
Public methodFindStringNonWrapping(String)
Searches for an item in the same manner as FindString() but does not start from the beginning when the end of the Items collection is reached.
Public methodFindStringNonWrapping(String, Int32)
Searches for an item in the same manner as FindString() but does not start from the beginning when the end of the Items collection is reached.
Public methodGetChildAt
Method used by control Code Dom serializer to access element in the collection of RootElement.
(Inherited from RadControl.)
Public methodGetControlDefaultSize
This method is used internally!
(Inherited from RadControl.)
Protected methodGetInputElement (Inherited from RadControl.)
Public methodGetPlainText
Strips all html tags of the text set to the control and returns only the plain text.
(Inherited from RadControl.)
Public methodGetPreferredSize (Inherited from RadControl.)
Protected methodGetRootElementDesiredSize (Inherited from RadControl.)
Protected methodHandleEndKey
Protected methodHandleHomeKey
Protected methodHandlePageDownKey
Protected methodHandlePageUpKey
Protected methodInitializeRootElement (Inherited from RadControl.)
Public methodInvokeLayoutCallback (Inherited from RadControl.)
Protected methodIsInputChar (Overrides ControlIsInputChar(Char).)
Protected methodIsInputKey (Overrides RadControlIsInputKey(Keys).)
Public methodLoadElementTree
Loads the element tree. While not loaded, no layout operations are allowed upon the tree. By default, the tree will be loaded when the control is displayed for the first time.
(Inherited from RadControl.)
Public methodLoadElementTree(Size)
Loads the element tree using the specified desired size.
(Inherited from RadControl.)
Protected methodOnAutoSizeChanged (Inherited from RadControl.)
Protected methodOnBackColorChanged (Inherited from RadControl.)
Protected methodOnBindingContextChanged (Inherited from RadControl.)
Protected methodOnCaptureLosing (Inherited from RadControl.)
Protected methodOnClick (Inherited from RadControl.)
Protected methodOnCreateControl (Inherited from RadControl.)
Protected methodOnCreatingVisualItem
Protected methodOnDataBindingComplete
Raises the DataBindingComplete event.
Protected methodOnDoubleClick (Inherited from RadControl.)
Protected methodOnEnabledChanged (Inherited from RadControl.)
Protected methodOnFontChanged (Inherited from RadControl.)
Protected methodOnForeColorChanged (Inherited from RadControl.)
Protected methodOnGesture (Inherited from RadControl.)
Protected methodOnGotFocus (Overrides RadControlOnGotFocus(EventArgs).)
Protected methodOnHandleDestroyed (Inherited from RadControl.)
Protected methodOnInvalidated (Inherited from RadControl.)
Protected methodOnItemDataBinding
Protected methodOnItemDataBound
Protected methodOnKeyDown (Overrides RadControlOnKeyDown(KeyEventArgs).)
Protected methodOnKeyPress (Inherited from RadControl.)
Protected methodOnKeyUp (Inherited from RadControl.)
Protected methodOnLayout (Inherited from RadControl.)
Protected methodOnLoad (Overrides RadControlOnLoad(Size).)
Protected methodOnLocationChanged (Inherited from RadControl.)
Protected methodOnLostFocus (Inherited from RadControl.)
Protected methodOnMouseCaptureChanged (Inherited from RadControl.)
Protected methodOnMouseDown (Overrides RadControlOnMouseDown(MouseEventArgs).)
Protected methodOnMouseEnter (Inherited from RadControl.)
Protected methodOnMouseHover (Inherited from RadControl.)
Protected methodOnMouseLeave (Inherited from RadControl.)
Protected methodOnMouseMove (Overrides RadControlOnMouseMove(MouseEventArgs).)
Protected methodOnMouseUp (Overrides RadControlOnMouseUp(MouseEventArgs).)
Protected methodOnMouseWheel (Overrides RadControlOnMouseWheel(MouseEventArgs).)
Protected methodOnNotifyPropertyChanged(PropertyChangedEventArgs) (Inherited from RadControl.)
Protected methodOnNotifyPropertyChanged(String)
Raises the PropertyChanged event
(Inherited from RadControl.)
Protected methodOnPaddingChanged (Inherited from RadControl.)
Protected methodOnPaint (Inherited from RadControl.)
Protected methodOnPanGesture
Fires the PanGesture event.
(Inherited from RadControl.)
Protected methodOnParentChanged (Inherited from RadControl.)
Protected methodOnPressAndTapGesture
Fires the PressAndTapGesture event.
(Inherited from RadControl.)
Protected methodOnPreviewKeyDown (Inherited from RadControl.)
Protected methodOnRightToLeftChanged (Inherited from RadControl.)
Protected methodOnRotateGesture
Fires the RotateGesture event.
(Inherited from RadControl.)
Protected methodOnScreenTipNeeded (Inherited from RadControl.)
Protected methodOnSelectedIndexChanged
Protected methodOnSelectedIndexChanging
Protected methodOnSelectedValueChanged
Protected methodOnSortStyleChanged
Protected methodOnThemeChanged (Inherited from RadControl.)
Protected methodOnThemeNameChanged (Inherited from RadControl.)
Protected methodOnToolTipTextNeeded (Inherited from RadControl.)
Protected methodOnTwoFingerTapGesture
Fires the TwoFingerTapGesture event.
(Inherited from RadControl.)
Protected methodOnVisualItemFormatting
Protected methodOnZoomGesture
Fires the ZoomGesture event.
(Inherited from RadControl.)
Protected methodProcessAutoSizeChanged (Inherited from RadControl.)
Protected methodProcessCaptureChangeRequested
Processes a capture request from the specified element.
(Inherited from RadControl.)
Protected methodProcessCodedUIMessage (Overrides RadControlProcessCodedUIMessage(IPCMessage).)
Protected methodProcessFocusRequested
Processes a focus request from the specified element.
(Inherited from RadControl.)
Protected methodProcessGesture (Inherited from RadControl.)
Protected methodProcessMnemonic (Inherited from RadControl.)
Public methodRebind
Forces re-evaluation of the current data source (if any).
Public methodRefresh (Inherited from RadControl.)
Public methodRegisterHostedControl (Inherited from RadControl.)
Protected methodResetBackColorThemeOverrides (Inherited from RadControl.)
Protected methodResetForeColorThemeOverrides (Inherited from RadControl.)
Public methodResolveStyleGroupForElement
Replaces the default style group for specific element.
(Inherited from RadControl.)
Public methodResumeUpdate (Inherited from RadControl.)
Public methodResumeUpdate(Boolean) (Inherited from RadControl.)
Protected methodScaleControl (Inherited from RadControl.)
Public methodScrollByPage
Public methodScrollToItem
Scrolls to the provided item so that the item will appear at the top of the view if it is before the currently visible items and at the bottom of the view if it is after the currently visible items.
Public methodSelectAll
Selects all items if the SelectionMode allows it. This method throws an InvalidOperationException if SelectionMode is One or None.
Public methodSelectRange
Clears the currently selected items and selects all items in the closed range [startIndex, endIndex].
Protected methodSetBackColorThemeOverrides (Inherited from RadControl.)
Protected methodSetBoundsCore (Inherited from RadControl.)
Protected methodSetForeColorThemeOverrides (Inherited from RadControl.)
Public methodSetIsInitializing
This method is used internally!
(Inherited from RadControl.)
Public methodShouldSerializeBackColor
Determines whether the BackColor property should be serialized.
(Inherited from RadControl.)
Public methodShouldSerializeFont
Determines whether the ForeColor property should be serialized.
(Inherited from RadControl.)
Public methodShouldSerializeForeColor
Determines whether the ForeColor property should be serialized.
(Inherited from RadControl.)
Protected methodShouldSerializeProperty
Determines whether the specified RadProperty should be serialized.
(Inherited from RadControl.)
Public methodSuspendUpdate (Inherited from RadControl.)
Public methodUnregisterHostedControl (Inherited from RadControl.)
Protected methodUnwireEvents
Unsubscribes from the relevant events of the underlaying RadListElement.
Protected methodWireEvents
Subscribes to the relevant events of the underlaying RadListElement.
Protected methodWndProc (Inherited from RadControl.)
Top
Events
  NameDescription
Public eventCreatingVisualListItem
This event allows the user to create custom visual items. It is fired initially for all the visible items and when the control is resized afterwards.
Public eventDataBindingComplete
Fires after data binding operation has finished.
Public eventElementInvalidated (Inherited from RadControl.)
Public eventInitialized
Fires when the control is initialized.
(Inherited from RadControl.)
Public eventItemDataBinding
This event fires before a RadListDataItem is data bound. This happens when the DataSource property is assigned and the event fires for every item provided by the data source. This event allows a custom RadListDataItem to be provided by the user.
Public eventItemDataBound
This event fires after a RadListDataItem is data bound. This happens when the DataSource property is assigned and the event is fired for every item provided by the data source.
Public eventPanGesture
Occurs when a pan gesture was sent by a touch input device.
(Inherited from RadControl.)
Public eventPressAndTapGesture
Occurs when a press-and-tap gesture was sent by a touch input device.
(Inherited from RadControl.)
Public eventPropertyChanged
Occurs when a property of an object changes change. Calling the event is developer's responsibility.
(Inherited from RadControl.)
Public eventRotateGesture
Occurs when a rotate gesture was sent by a touch input device.
(Inherited from RadControl.)
Public eventScreenTipNeeded
Occurs prior the ScreenTip of a RadItem instance inside the RadControl is displayed.
(Inherited from RadControl.)
Public eventSelectedIndexChanged
This event fires when the selected index property changes.
Public eventSelectedIndexChanging
This event fires before SelectedIndex changes. This event allows the operation to be cancelled.
Public eventSelectedItemsChanged
This event fires when the SelectedItems collection changes.
Public eventSelectedItemsChanging
This event fires before the SelectedItems collection changes.
Public eventSelectedValueChanged
This event fires only if the SelectedValue has really changed. For example it will not fire if the previously selected item has the same value as the newly selected item.
Public eventSortStyleChanged
This event fires when the SortStyle property changes.
Public eventThemeNameChanged
Fires when the theme name is changed.
(Inherited from RadControl.)
Public eventToolTipTextNeeded
Occurs when a RadItem instance inside the RadControl requires ToolTip text.
(Inherited from RadControl.)
Public eventTwoFingerTapGesture
Occurs when a two-finger-tap gesture was sent by a touch input device.
(Inherited from RadControl.)
Public eventVisualItemFormatting
The VisualItemFormatting event fires whenever a property of a visible data item changes and whenever a visual item is associated with a new data item. During scrolling for example.
Public eventZoomGesture
Occurs when a zoom gesture was sent by a touch input device.
(Inherited from RadControl.)
Top
Fields
See Also