Class RadListView

Displays a flat collection of labeled items, each represented by a ListViewDataItem.

Inheritance
System.Object
RadControl
RadListView
FileBrowserListView
RadCardView
RadCheckedListBox
RadDiagramToolbox
StyleListView
SymbolsTable
Inherited Members
Namespace: Telerik.WinControls.UI
Assembly: Telerik.WinControls.UI.dll

Syntax

[TelerikToolboxCategory("Data Controls")]
public class RadListView : RadControl, INotifyPropertyChanged, ISupportInitializeNotification, ISupportInitialize, IComponentTreeHandler, ILayoutHandler, IPCHost, IAnalyticsProvider

Constructors

RadListView()

Creates an instance of RadListView.

Declaration
public RadListView()

Properties

ActiveEditor

Gets the currently active editor.

Declaration
public IInputEditor ActiveEditor { get; }
Property Value
IInputEditor

AllowArbitraryItemHeight

Gets or sets a value indicating whether the items can have different height.

Declaration
public virtual bool AllowArbitraryItemHeight { get; set; }
Property Value
System.Boolean

AllowArbitraryItemWidth

Gets or sets a value indicating whether the items can have different width.

Declaration
public bool AllowArbitraryItemWidth { get; set; }
Property Value
System.Boolean

AllowColumnReorder

Gets or sets value indicating if the user can reorder columns via drag and drop.

Declaration
public virtual bool AllowColumnReorder { get; set; }
Property Value
System.Boolean

AllowColumnResize

Gets or sets value indicating if the user can resize the columns.

Declaration
public virtual bool AllowColumnResize { get; set; }
Property Value
System.Boolean

AllowDragDrop

Gets or sets value indicating if the user can reorder items via drag and drop.

Declaration
public bool AllowDragDrop { get; set; }
Property Value
System.Boolean

AllowEdit

Gets or sets value indicating whether editing is enabled.

Declaration
public virtual bool AllowEdit { get; set; }
Property Value
System.Boolean

AllowRemove

Gets or sets value indicating whether the user can remove items with the Delete key.

Declaration
public bool AllowRemove { get; set; }
Property Value
System.Boolean

AutoSize

Gets or sets whether the edit control is auto-sized

Declaration
public override bool AutoSize { get; set; }
Property Value
System.Boolean

Overrides

BackColor

RadListView consists of multiple visual elements and separate settings are provided to customize their appearance. Current BackColor property might be ignored.

Declaration
public override Color BackColor { get; set; }
Property Value
System.Drawing.Color

Overrides

CaseSensitiveColumnNames

Gets or sets a value indicating whether column names which differ only in the casing are allowed.

Declaration
public bool CaseSensitiveColumnNames { get; set; }
Property Value
System.Boolean

CheckBoxesAlignment

Gets or sets the alignment of the checkboxes within the item when ShowCheckBoxes is true.

Declaration
public CheckBoxesAlignment CheckBoxesAlignment { get; set; }
Property Value
CheckBoxesAlignment

CheckBoxesPosition

Gets or sets the position of the checkboxes when ShowCheckBoxes is true.

Declaration
public CheckBoxesPosition CheckBoxesPosition { get; set; }
Property Value
CheckBoxesPosition

CheckedItems

Gets a collection containing the checked items.

Declaration
public ListViewCheckedItemCollection CheckedItems { get; }
Property Value
ListViewCheckedItemCollection

CheckedMember

Gets or sets the checked member.

Declaration
public string CheckedMember { get; set; }
Property Value
System.String

CheckOnClickMode

Gets or sets a value indicating whether the item's check state changes whenever the item is clicked.

Declaration
public virtual CheckOnClickMode CheckOnClickMode { get; set; }
Property Value
CheckOnClickMode

Columns

Gets or sets a collection of ListViewDetailColumn object which represent the columns in DetailsView.

Declaration
public ListViewColumnCollection Columns { get; }
Property Value
ListViewColumnCollection

CurrentColumn

Gets or sets the current column in Details View.

Declaration
public ListViewDetailColumn CurrentColumn { get; set; }
Property Value
ListViewDetailColumn

CurrentItem

Gets or sets the current item.

Declaration
public ListViewDataItem CurrentItem { get; set; }
Property Value
ListViewDataItem

DataMember

Gets or sets the name of the list or table in the data source for which the RadListView is displaying data.

Declaration
public string DataMember { get; set; }
Property Value
System.String

DataSource

Gets or sets the data source of a RadListView.

Declaration
public virtual object DataSource { get; set; }
Property Value
System.Object

DefaultSize

Declaration
protected override Size DefaultSize { get; }
Property Value
System.Drawing.Size

DisplayMember

Gets or sets the display member.

Declaration
public string DisplayMember { get; set; }
Property Value
System.String

EnableColumnSort

Gets or sets a value indicating whether the items should be sorted when clicking on header cells.

Declaration
public bool EnableColumnSort { get; set; }
Property Value
System.Boolean

EnableCustomGrouping

Gets or sets a value indicating whether custom grouping is enabled.

Declaration
public bool EnableCustomGrouping { get; set; }
Property Value
System.Boolean

EnableFiltering

Gets or sets a value indicating whether filtering is enabled.

Declaration
public bool EnableFiltering { get; set; }
Property Value
System.Boolean

EnableGrouping

Gets or sets a value indicating whether grouping is enabled.

Declaration
public bool EnableGrouping { get; set; }
Property Value
System.Boolean

EnableKineticScrolling

Gets or sets a value indicating whether the kinetic scrolling function is enabled. Always false when lasso selection is enabled.

Declaration
public bool EnableKineticScrolling { get; set; }
Property Value
System.Boolean

EnableLassoSelection

Gets or sets a value indicating whether items can be selected with mouse dragging.

Declaration
public bool EnableLassoSelection { get; set; }
Property Value
System.Boolean

EnableSorting

Gets or sets a value indicating whether sorting is enabled.

Declaration
public bool EnableSorting { get; set; }
Property Value
System.Boolean

FilterDescriptors

Gets a collection of FilterDescriptor by which you can apply filter rules to the items.

Declaration
public ListViewFilterDescriptorCollection FilterDescriptors { get; }
Property Value
ListViewFilterDescriptorCollection

FilterPredicate

Gets or sets the filter predicate used for filtering operation.

Declaration
public Predicate<ListViewDataItem> FilterPredicate { get; set; }
Property Value
System.Predicate<ListViewDataItem>

The filter.

FindStringComparer

Gets or sets the string comparer used by the keyboard navigation functionality.

Declaration
public IFindStringComparer FindStringComparer { get; set; }
Property Value
IFindStringComparer

ForeColor

RadListView consists of multiple visual elements and separate settings are provided to customize their appearance. Current ForeColor property might be ignored.

Declaration
public override Color ForeColor { get; set; }
Property Value
System.Drawing.Color

Overrides

FullRowSelect

Gets or sets a value indicating whether the full row should be selected.

Declaration
public virtual bool FullRowSelect { get; set; }
Property Value
System.Boolean

GroupDescriptors

Gets a collection of GroupDescriptor which are used to define grouping rules over the ListViewDataItemCollection.

Declaration
public GroupDescriptorCollection GroupDescriptors { get; }
Property Value
GroupDescriptorCollection

GroupIndent

Gets or sets the indent of the items when they are displayed in a group.

Declaration
public int GroupIndent { get; set; }
Property Value
System.Int32

GroupItemSize

Gets or sets the default item size.

Declaration
public Size GroupItemSize { get; set; }
Property Value
System.Drawing.Size

Groups

Gets a collection containing the groups of the RadListView.

Declaration
public virtual ListViewDataItemGroupCollection Groups { get; }
Property Value
ListViewDataItemGroupCollection

HeaderHeight

Gets or sets the height of the header in Details View.

Declaration
public virtual float HeaderHeight { get; set; }
Property Value
System.Single

HorizontalScrollState

Gets or sets the display state of the horizontal scrollbar.

Declaration
public ScrollState HorizontalScrollState { get; set; }
Property Value
ScrollState

HotTracking

Gets or sets a value indicating whether items should react on mouse hover.

Declaration
public bool HotTracking { get; set; }
Property Value
System.Boolean

IsDataBound

Gets a value indicating whether the control is in bound mode.

Declaration
public bool IsDataBound { get; }
Property Value
System.Boolean

IsEditing

Indicates whether there is an active editor.

Declaration
public bool IsEditing { get; }
Property Value
System.Boolean

Items

Gets or sets a collection of ListViewDataItem object which represent the items in RadListView.

Declaration
public ListViewDataItemCollection Items { get; }
Property Value
ListViewDataItemCollection

ItemSize

Gets or sets the default item size.

Declaration
public virtual Size ItemSize { get; set; }
Property Value
System.Drawing.Size

ItemSpacing

Gets or sets the space between the items.

Declaration
public virtual int ItemSpacing { get; set; }
Property Value
System.Int32

KeyboardSearchEnabled

Gets or sets a value that determines whether the user can search for an item by typing characters when RadListView is focused.

Declaration
public bool KeyboardSearchEnabled { get; set; }
Property Value
System.Boolean

KeyboardSearchResetInterval

Gets or sets a value that specifies how long the user must wait before searching with the keyboard is reset.

Declaration
public int KeyboardSearchResetInterval { get; set; }
Property Value
System.Int32

ListViewElement

Gets the RadListViewElement of the control.

Declaration
public RadListViewElement ListViewElement { get; }
Property Value
RadListViewElement

MultiSelect

Gets or sets value indicating whether multi selection is enabled.

Declaration
public bool MultiSelect { get; set; }
Property Value
System.Boolean

SelectedIndex

Gets or sets the index of the selected item.

Declaration
public int SelectedIndex { get; set; }
Property Value
System.Int32

SelectedItem

Gets or sets the selected item.

Declaration
public ListViewDataItem SelectedItem { get; set; }
Property Value
ListViewDataItem

SelectedItems

Gets a collection containing the selected items.

Declaration
public ListViewSelectedItemCollection SelectedItems { get; }
Property Value
ListViewSelectedItemCollection

SelectLastAddedItem

Gets or sets a value indicating whether the last added item in the RadListView DataSource will be selected by the control.

Declaration
public bool SelectLastAddedItem { get; set; }
Property Value
System.Boolean

ShowCheckBoxes

Gets or sets value indicating whether checkboxes should be shown.

Declaration
public virtual bool ShowCheckBoxes { get; set; }
Property Value
System.Boolean

ShowColumnHeaders

Gets or sets a value indicating whether the column headers should be drawn.

Declaration
public virtual bool ShowColumnHeaders { get; set; }
Property Value
System.Boolean

ShowGridLines

Gets or sets a value indicating whether grid lines should be shown in DetailsView.

Declaration
public virtual bool ShowGridLines { get; set; }
Property Value
System.Boolean

ShowGroups

Gets or sets a value indicating whether the items should be shown in groups.

Declaration
public bool ShowGroups { get; set; }
Property Value
System.Boolean

SortDescriptors

Gets a collection of SortDescriptor which are used to define sorting rules over the ListViewDataItemCollection.

Declaration
public SortDescriptorCollection SortDescriptors { get; }
Property Value
SortDescriptorCollection

Text

This property is not relevant for this class.

Declaration
public override string Text { get; set; }
Property Value
System.String

Overrides

ThreeStateMode

Gets or sets a value indicating whether the checkboxes should be in ThreeState mode.

Declaration
public bool ThreeStateMode { get; set; }
Property Value
System.Boolean

ValueMember

Gets or sets the value member.

Declaration
public string ValueMember { get; set; }
Property Value
System.String

VerticalScrollState

Gets or sets the display state of the vertical scrollbar.

Declaration
public ScrollState VerticalScrollState { get; set; }
Property Value
ScrollState

ViewType

Gets or sets the type of the view.

Declaration
public virtual ListViewType ViewType { get; set; }
Property Value
ListViewType

Methods

BeginEdit()

Begins an edit operation over the currently selected item.

Declaration
public bool BeginEdit()
Returns
System.Boolean

[true] if success, [false] otherwise

BeginUpdate()

Suspend any item change notifications until EndUpdate() is called.

Declaration
public void BeginUpdate()

CancelEdit()

Ends the current edit operations if such. Discards the changes.

Declaration
public bool CancelEdit()
Returns
System.Boolean

[true] if success, [false] otherwise

CanEditElementAtDesignTime(RadElement)

Declaration
protected override bool CanEditElementAtDesignTime(RadElement element)
Parameters
RadElement element

Returns
System.Boolean

Overrides

CheckAllItems()

Checks all of the items.

Declaration
public void CheckAllItems()

CheckSelectedItems()

Checks the selected items.

Declaration
public void CheckSelectedItems()

CollapseAll()

Collapses all the groups in the control.

Declaration
public void CollapseAll()

CreateAccessibilityInstance()

Declaration
protected override AccessibleObject CreateAccessibilityInstance()
Returns
System.Windows.Forms.AccessibleObject

CreateChildItems(RadElement)

Declaration
protected override void CreateChildItems(RadElement parent)
Parameters
RadElement parent

Overrides

CreateListViewElement()

Declaration
protected virtual RadListViewElement CreateListViewElement()
Returns
RadListViewElement

EndEdit()

Ends the current edit operations if such. Saves the changes.

Declaration
public bool EndEdit()
Returns
System.Boolean

[true] if success, [false] otherwise

EndUpdate()

Resumes the item change notifications.

Declaration
public void EndUpdate()

ExpandAll()

Expands all the groups in the control.

Declaration
public void ExpandAll()

FindItemByKey(Object)

Finds an item with the specified key.

Declaration
public ListViewDataItem FindItemByKey(object key)
Parameters
System.Object key

The key of the searched item.
Returns
ListViewDataItem

FindItemByKey(Object, Boolean)

Finds an item with the specified key.

Declaration
public ListViewDataItem FindItemByKey(object key, bool searchVisibleItems)
Parameters
System.Object key

The key of the searched item.
System.Boolean searchVisibleItems

Indicates if the search should check only visible items.
Returns
ListViewDataItem

IsInputKey(Keys)

Declaration
protected override bool IsInputKey(Keys keyData)
Parameters
System.Windows.Forms.Keys keyData

Returns
System.Boolean

Overrides

OnGotFocus(EventArgs)

Declaration
protected override void OnGotFocus(EventArgs e)
Parameters
System.EventArgs e

Overrides

OnKeyDown(KeyEventArgs)

Declaration
protected override void OnKeyDown(KeyEventArgs e)
Parameters
System.Windows.Forms.KeyEventArgs e

Overrides

OnKeyPress(KeyPressEventArgs)

Declaration
protected override void OnKeyPress(KeyPressEventArgs e)
Parameters
System.Windows.Forms.KeyPressEventArgs e

Overrides

OnLoad(Size)

Declaration
protected override void OnLoad(Size desiredSize)
Parameters
System.Drawing.Size desiredSize

Overrides

OnLostFocus(EventArgs)

Declaration
protected override void OnLostFocus(EventArgs e)
Parameters
System.EventArgs e

Overrides

OnMouseDown(MouseEventArgs)

Declaration
protected override void OnMouseDown(MouseEventArgs e)
Parameters
System.Windows.Forms.MouseEventArgs e

Overrides

OnMouseMove(MouseEventArgs)

Declaration
protected override void OnMouseMove(MouseEventArgs e)
Parameters
System.Windows.Forms.MouseEventArgs e

Overrides

OnMouseUp(MouseEventArgs)

Declaration
protected override void OnMouseUp(MouseEventArgs e)
Parameters
System.Windows.Forms.MouseEventArgs e

Overrides

OnMouseWheel(MouseEventArgs)

Declaration
protected override void OnMouseWheel(MouseEventArgs e)
Parameters
System.Windows.Forms.MouseEventArgs e

Overrides

OnNotifyPropertyChanged(PropertyChangedEventArgs)

Declaration
protected override void OnNotifyPropertyChanged(PropertyChangedEventArgs e)
Parameters
System.ComponentModel.PropertyChangedEventArgs e

Overrides

OnThemeNameChanged(ThemeNameChangedEventArgs)

Declaration
protected override void OnThemeNameChanged(ThemeNameChangedEventArgs e)
Parameters
ThemeNameChangedEventArgs e

Overrides

RadListView_Initialized(Object, EventArgs)

Executed on EndInit() method.

Declaration
protected virtual void RadListView_Initialized(object sender, EventArgs e)
Parameters
System.Object sender

The sender.
System.EventArgs e

The event args.

Select(ListViewDataItem[])

Selects a set of items.

Declaration
public void Select(ListViewDataItem[] items)
Parameters
ListViewDataItem[] items

The items to select.

UncheckAllItems()

Unchecks all of the items.

Declaration
public void UncheckAllItems()

UncheckSelectedItems()

Unchecks the selected items.

Declaration
public void UncheckSelectedItems()

Events

BindingCompleted

Occurs when the process of binding RadListViewElement to a data source has finished

Declaration
public event EventHandler BindingCompleted
Event Type
System.EventHandler

BindingContextChanged

Occurs when the BindingContext has changed.

Declaration
public event EventHandler BindingContextChanged
Event Type
System.EventHandler

CellCreating

Occurs when a DetailListViewCellElement needs to be created.

Declaration
public virtual event ListViewCellElementCreatingEventHandler CellCreating
Event Type
ListViewCellElementCreatingEventHandler

CellFormatting

Occurs when a DetailsView cell needs to be formatted.

Declaration
public virtual event ListViewCellFormattingEventHandler CellFormatting
Event Type
ListViewCellFormattingEventHandler

ColumnCreating

Occurs when a ListViewDetailColumn needs to be created.

Declaration
public event ListViewColumnCreatingEventHandler ColumnCreating
Event Type
ListViewColumnCreatingEventHandler

CurrentItemChanged

Occurs when the CurrentItem property is changed.

Declaration
public event ListViewItemEventHandler CurrentItemChanged
Event Type
ListViewItemEventHandler

CurrentItemChanging

Occurs when the CurrentItem property is about to change. Cancelable.

Declaration
public event ListViewItemChangingEventHandler CurrentItemChanging
Event Type
ListViewItemChangingEventHandler

EditorInitialized

Occurs when an editor is initialized.

Declaration
public event ListViewItemEditorInitializedEventHandler EditorInitialized
Event Type
ListViewItemEditorInitializedEventHandler

EditorRequired

Occurs when an editor is required.

Declaration
public event ListViewItemEditorRequiredEventHandler EditorRequired
Event Type
ListViewItemEditorRequiredEventHandler

GroupExpanded

Fires when a group has been expanded.

Declaration
public event EventHandler<ListViewGroupEventArgs> GroupExpanded
Event Type
System.EventHandler<ListViewGroupEventArgs>

GroupExpanding

Fires when a group is about to expand. Cancelable.

Declaration
public event EventHandler<ListViewGroupCancelEventArgs> GroupExpanding
Event Type
System.EventHandler<ListViewGroupCancelEventArgs>

ItemCheckedChanged

Occurs when a ListViewDataItem is checked.

Declaration
public event ListViewItemEventHandler ItemCheckedChanged
Event Type
ListViewItemEventHandler

ItemCheckedChanging

Occurs when a ListViewDataItem is about to be checked. Cancelable.

Declaration
public event ListViewItemCancelEventHandler ItemCheckedChanging
Event Type
ListViewItemCancelEventHandler

ItemCreating

Occurs when a ListViewDataItem needs to be created.

Declaration
public event ListViewItemCreatingEventHandler ItemCreating
Event Type
ListViewItemCreatingEventHandler

ItemDataBound

Occurs when a data-bound item is being attached to a ListViewDataItem.

Declaration
public event ListViewItemEventHandler ItemDataBound
Event Type
ListViewItemEventHandler

ItemEdited

Occurs when a ListViewDataItem is edited.

Declaration
public event ListViewItemEditedEventHandler ItemEdited
Event Type
ListViewItemEditedEventHandler

ItemEditing

Occurs when an edit operation is about to begin. Cancelable.

Declaration
public event ListViewItemEditingEventHandler ItemEditing
Event Type
ListViewItemEditingEventHandler

ItemMouseClick

Occurs when the user clicks a ListViewDataItem.

Declaration
public event ListViewItemEventHandler ItemMouseClick
Event Type
ListViewItemEventHandler

ItemMouseDoubleClick

Occurs when the user double-clicks a ListViewDataItem.

Declaration
public event ListViewItemEventHandler ItemMouseDoubleClick
Event Type
ListViewItemEventHandler

ItemMouseDown

Occurs when the user presses a mouse button over a ListViewDataItem.

Declaration
public event ListViewItemMouseEventHandler ItemMouseDown
Event Type
ListViewItemMouseEventHandler

ItemMouseEnter

Occurs when the mouse pointer enters a ListViewDataItem.

Declaration
public event ListViewItemEventHandler ItemMouseEnter
Event Type
ListViewItemEventHandler

ItemMouseHover

Occurs when the user hovers a ListViewDataItem.

Declaration
public event ListViewItemEventHandler ItemMouseHover
Event Type
ListViewItemEventHandler

ItemMouseLeave

Occurs when the mouse pointer leaves a ListViewDataItem.

Declaration
public event ListViewItemEventHandler ItemMouseLeave
Event Type
ListViewItemEventHandler

ItemMouseMove

Occurs when the user moves the mouse over a ListViewDataItem.

Declaration
public event ListViewItemMouseEventHandler ItemMouseMove
Event Type
ListViewItemMouseEventHandler

ItemMouseUp

Occurs when the user presses a mouse button over a ListViewDataItem.

Declaration
public event ListViewItemMouseEventHandler ItemMouseUp
Event Type
ListViewItemMouseEventHandler

ItemRemoved

Occurs when an item is removed using the Delete key.

Declaration
public event ListViewItemEventHandler ItemRemoved
Event Type
ListViewItemEventHandler

ItemRemoving

Occurs when an item is about to be removed using the Delete key. Cancelable.

Declaration
public event ListViewItemCancelEventHandler ItemRemoving
Event Type
ListViewItemCancelEventHandler

ItemValidating

Occurs when an edit operation needs to be validated.

Declaration
public event ListViewItemValidatingEventHandler ItemValidating
Event Type
ListViewItemValidatingEventHandler

ItemValueChanged

Occurs when the value of a ListViewDataItem is changed.

Declaration
public event ListViewItemValueChangedEventHandler ItemValueChanged
Event Type
ListViewItemValueChangedEventHandler

ItemValueChanging

Occurs when the value of a ListViewDataItem is about to change. Cancelable.

Declaration
public event ListViewItemValueChangingEventHandler ItemValueChanging
Event Type
ListViewItemValueChangingEventHandler

SelectedIndexChanged

Occurs when the selected item has changed.

Declaration
public event EventHandler SelectedIndexChanged
Event Type
System.EventHandler

SelectedItemChanged

Occurs when the selected item has changed.

Declaration
public event EventHandler SelectedItemChanged
Event Type
System.EventHandler

SelectedItemChanging

Occurs when a ListViewDataItem is about to be selected. Cancelable.

Declaration
public event ListViewItemCancelEventHandler SelectedItemChanging
Event Type
ListViewItemCancelEventHandler

SelectedItemsChanged

Occurs when the content of the SelectedItems collection has changed.

Declaration
public event EventHandler SelectedItemsChanged
Event Type
System.EventHandler

ValidationError

Fires when a validation error occurs.

Declaration
public event EventHandler ValidationError
Event Type
System.EventHandler

ViewTypeChanged

Occurs when the ViewType of RadListView is changed.

Declaration
public virtual event EventHandler ViewTypeChanged
Event Type
System.EventHandler

ViewTypeChanging

Occurs when the ViewType of RadListView is about to change. Cancelable.

Declaration
public virtual event ViewTypeChangingEventHandler ViewTypeChanging
Event Type
ViewTypeChangingEventHandler

VisualItemCreating

Occurs when a BaseListViewVisualItem needs to be created;

Declaration
public event ListViewVisualItemCreatingEventHandler VisualItemCreating
Event Type
ListViewVisualItemCreatingEventHandler

VisualItemFormatting

Occurs when a ListViewDataItem changes its state and needs to be formatted.

Declaration
public event ListViewVisualItemEventHandler VisualItemFormatting
Event Type
ListViewVisualItemEventHandler

Extension Methods