Edit this page

Properties

Property Description
EnableAlternatingItemColor Gets or sets a value indicating whether alternating item color is enabled.
EnableKineticScrolling Gets or sets a value indicating whether the kinetic scrolling function is enabled.
FitItemsToSize Gets or sets whether the RadListDataItem will fit to the available size.
CaseSensitiveSort Gets or sets a value that indicates whether text case will be taken into account when sorting.
ItemHeight Gets or sets the item height for the items. This property is disregarded when AutoSizeItems is set to true.
KeyboardSearchResetInterval Gets or sets a value that specifies how long the user must wait before searching with the keyboard is reset.
KeyboardSearchEnabled Gets or sets a value that determines whether the user can search for an item by typing characters when RadListControl is focused.
Items Gets a collection representing the items contained in this RadListControl.
SelectedItems Provides a read only interface to the selected items. In order to select an item, use its Selected property.
SelectionMode Gets or sets the SelectionMode of RadListControl. This property has a similar effect to the SelectionMode of the standard Microsoft ListBox control.
SelectedValue 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.
ActiveItem Gets or sets the active item. The Active item is relevant only in MultiSimple SelectionMode or MultiExtended in combination with the control keyboard key.
SelectedItem Gets or sets the currently selected item.
SelectedIndex Gets or sets the currently selected index.
DataSource Gets or sets the object that is responsible for providing data objects for the RadListElement. Setting this property throws an InvalidOperationException if Items is not empty and the data source is null.
DataMember Gets or sets the name of the list or table in the data source for which the RadListControl is displaying data.
DisplayMember Gets or sets a string which will be used to get a text string for each visual item. This property can not be set to null. Setting it to null will cause it to contain an empty string.
ValueMember Gets or sets the string through which the SelectedValue property will be determined. This property can not be set to null. Setting it to null will cause it to contain an empty string.
DescriptionTextMember Gets or sets the string through which the SelectedValue property will be determined. This property can not be set to null. Setting it to null will cause it to contain an empty string.
SortStyle Gets or sets the sort style.
ScrollMode Gets or set the scroll mode.
FormatString Gets or sets a format string which will be used for visual formatting of the items text.
FormattingEnabled 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.
AutoSizeItems 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.
Filter Gets or sets a predicate which filters which items can be visible.
FilterExpression Gets or sets a filter expression which determines which items will be visible.
IsFilterActive Gets a value indicating whether there is a Filter or FilterExpression set.
FindStringComparer Gets or sets an object that implements IFindStringComparer. The value of this property is used in the FindString() method when searching for an item.
ItemTextComparisonMode 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.
SuspendItemsChangeEvents Gets or sets a value that indicates if this RadListControl will stop firing the ItemsChanging and ItemsChanged events.
SuspendSelectionEvents Gets or sets a value that determines whether to stop the selection events from firing. These are SelectedIndexChanged, SelectedIndexChanging and SelectedValueChanged.

Methods

Method Description
FindItemExact Finds the first item in the RadListControl that matches the specified string.
Rebind Forces re-evaluation of the current data source (if any).
BeginUpdate 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.
SelectAll Selects all items if the SelectionMode allows it. This method throws an InvalidOperationException if SelectionMode is One or None.
SelectRange Clears the currently selected items and selects all items in the closed range [startIndex, endIndex].
ScrollToItem 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.
FindString(string s) 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.
FindString(string s, int startIndex) 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.
FindStringExact(string s) 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.
FindStringExact(string s, int startIndex) 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.
FindStringNonWrapping(string s) 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.
FindStringNonWrapping(string s, int startIndex) Searches for an item from a certain index in the same manner as FindString() but does not start from the beginning when the end of the Items collection is reached.

Events

Event Description
SelectedIndexChanged This event fires when the selected index property changes.
SelectedIndexChanging This event fires before SelectedIndex changes. This event allows the operation to be canceled.
SelectedValueChanged 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.
ItemDataBinding 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.
ItemDataBound 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.
CreatingVisualListItem 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.
SortStyleChanged This event fires when the SortStyle property changes.
VisualItemFormatting 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.
SelectedItemsChanged This event fires when the SelectedItems collection changes.
SelectedItemsChanging This event fires before the SelectedItems collection changes.

See Also