Class

RadListView

Initializes a new instance of the RadListView control with default settings and empty item collection.

Declaration

public RadListView()

Gets the currently active editor.

Declaration

[Browsable(false)]
public IInputEditor ActiveEditor { get; }

Property Value

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

Declaration

[Browsable(true)]
public virtual bool AllowArbitraryItemHeight { get; set; }

Property Value

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

Declaration

[Browsable(true)]
public bool AllowArbitraryItemWidth { get; set; }

Property Value

Gets or sets a value indicating whether users can reorder columns by dragging column headers in DetailsView mode.

Declaration

[Browsable(true)]
public virtual bool AllowColumnReorder { get; set; }

Property Value

Gets or sets a value indicating whether users can resize column widths by dragging column borders in DetailsView mode.

Declaration

[Browsable(true)]
public virtual bool AllowColumnResize { get; set; }

Property Value

Gets or sets a value indicating whether users can reorder items by dragging them to different positions.

Declaration

[Browsable(true)]
public virtual bool AllowDragDrop { get; set; }

Property Value

Gets or sets value indicating whether editing is enabled.

Declaration

[Browsable(true)]
public virtual bool AllowEdit { get; set; }

Property Value

Gets or sets a value indicating whether users can remove selected items by pressing the Delete key.

Declaration

[Browsable(true)]
public bool AllowRemove { get; set; }

Property Value

Gets or sets a value indicating how column widths in DetailsView mode are determined.

Declaration

[Browsable(true)]
public ListViewAutoSizeColumnsMode AutoSizeColumnsMode { get; set; }

Property Value

Gets or sets a value indicating whether column names which differ only in casing are treated as different columns.

Declaration

[Browsable(true)]
public bool CaseSensitiveColumnNames { get; set; }

Property Value

Gets or sets the vertical alignment of checkboxes within each item when ShowCheckBoxes is enabled.

Declaration

[Browsable(true)]
public CheckBoxesAlignment CheckBoxesAlignment { get; set; }

Property Value

Gets or sets the position of checkboxes relative to the item content when ShowCheckBoxes is enabled.

Declaration

[Browsable(true)]
public CheckBoxesPosition CheckBoxesPosition { get; set; }

Property Value

Gets or sets a value indicating the conditions under which an item's check state automatically changes when the item is clicked.

Declaration

[Browsable(true)]
public virtual CheckOnClickMode CheckOnClickMode { get; set; }

Property Value

Gets a collection containing the checked items.

Declaration

[Browsable(false)]
public ListViewCheckedItemCollection CheckedItems { get; }

Property Value

Gets or sets the checked member.

Declaration

[Browsable(true)]
public string CheckedMember { get; set; }

Property Value

Gets a collection of ListViewDetailColumn objects that define the columns displayed in DetailsView mode.

Declaration

[Browsable(true)]
public ListViewColumnCollection Columns { get; }

Property Value

Gets or sets the current column in Details View.

Declaration

[Browsable(false)]
public ListViewDetailColumn CurrentColumn { get; set; }

Property Value

Gets or sets the current item.

Declaration

[Browsable(false)]
public ListViewDataItem CurrentItem { get; set; }

Property Value

Gets or sets the specific list or table within the data source that the RadListView should bind to when the data source contains multiple lists.

Declaration

[Browsable(true)]
public string DataMember { get; set; }

Property Value

Gets or sets the data source of a RadListView.

Declaration

[Browsable(true)]
public virtual object DataSource { get; set; }

Property Value

Gets the default size for the RadListView.

Declaration

protected override Size DefaultSize { get; }

Property Value

Overrides Control.DefaultSize

Gets or sets the name of the data source property that provides the display text for each item when data binding is used.

Declaration

[Browsable(true)]
[TypeConverter("System.Windows.Forms.Design.DataMemberFieldConverter, System.Design, Version=2.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a")]
public string DisplayMember { get; set; }

Property Value

Gets or sets a value indicating whether clicking on column headers in DetailsView mode will sort the items by that column.

Declaration

[Browsable(true)]
public bool EnableColumnSort { get; set; }

Property Value

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

Declaration

[Browsable(true)]
public virtual bool EnableCustomGrouping { get; set; }

Property Value

Gets or sets a value indicating whether filtering is enabled.

Declaration

[Browsable(true)]
public bool EnableFiltering { get; set; }

Property Value

Gets or sets a value indicating whether grouping is enabled.

Declaration

[Browsable(true)]
public bool EnableGrouping { get; set; }

Property Value

Gets or sets a value indicating whether kinetic scrolling is enabled for smooth touch-based scrolling. This is automatically disabled when lasso selection is enabled.

Declaration

[Browsable(true)]
public bool EnableKineticScrolling { get; set; }

Property Value

Gets or sets a value indicating whether users can select multiple items by dragging a selection rectangle around them.

Declaration

[Browsable(true)]
public bool EnableLassoSelection { get; set; }

Property Value

Gets or sets a value indicating whether sorting is enabled.

Declaration

[Browsable(true)]
public bool EnableSorting { get; set; }

Property Value

Gets a collection of filter descriptors that define the filtering criteria applied to the ListView items.

Declaration

[Browsable(true)]
public ListViewFilterDescriptorCollection FilterDescriptors { get; }

Property Value

Gets or sets a custom predicate function used to filter items in the ListView based on complex criteria.

Declaration

[Browsable(false)]
public Predicate<ListViewDataItem> FilterPredicate { get; set; }

Property Value

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

Declaration

[Browsable(true)]
public IFindStringComparer FindStringComparer { get; set; }

Property Value

Gets or sets a value indicating whether the entire row is highlighted when an item is selected in DetailsView mode, rather than just the first column.

Declaration

[Browsable(true)]
public virtual bool FullRowSelect { get; set; }

Property Value

Gets a collection of group descriptors that define the grouping criteria applied to organize ListView items into groups.

Declaration

[Browsable(true)]
public GroupDescriptorCollection GroupDescriptors { get; }

Property Value

Gets or sets the horizontal indentation applied to items when they are displayed within a group.

Declaration

[Browsable(true)]
public virtual int GroupIndent { get; set; }

Property Value

Gets or sets the default size for group header items when grouping is enabled.

Declaration

[Browsable(true)]
public virtual Size GroupItemSize { get; set; }

Property Value

Gets a collection containing all the groups that organize items in the RadListView when grouping is enabled.

Declaration

[Browsable(true)]
public virtual ListViewDataItemGroupCollection Groups { get; }

Property Value

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

Declaration

[Browsable(true)]
public virtual float HeaderHeight { get; set; }

Property Value

Gets or sets the display behavior of the horizontal scrollbar, controlling when it appears and how it behaves.

Declaration

[Browsable(true)]
public ScrollState HorizontalScrollState { get; set; }

Property Value

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

Declaration

[Browsable(true)]
public bool HotTracking { get; set; }

Property Value

Gets a value indicating whether the RadListView is currently bound to a data source.

Declaration

[Browsable(false)]
public bool IsDataBound { get; }

Property Value

Indicates whether there is an active editor.

Declaration

[Browsable(false)]
public bool IsEditing { get; }

Property Value

Gets or sets the default size for items when they are displayed in the ListView.

Declaration

[Browsable(true)]
public virtual Size ItemSize { get; set; }

Property Value

Gets or sets the amount of spacing in pixels between adjacent items in the ListView.

Declaration

[Browsable(true)]
public virtual int ItemSpacing { get; set; }

Property Value

Gets a collection of ListViewDataItem objects that represent all items displayed in the RadListView.

Declaration

[Browsable(true)]
public ListViewDataItemCollection Items { get; }

Property Value

Gets or sets a value indicating whether users can search for items by typing characters when the RadListView has focus.

Declaration

[Browsable(true)]
public bool KeyboardSearchEnabled { get; set; }

Property Value

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

Declaration

[Browsable(true)]
public int KeyboardSearchResetInterval { get; set; }

Property Value

Gets the underlying RadListViewElement that provides the core functionality and visual representation of the ListView.

Declaration

[Browsable(false)]
public RadListViewElement ListViewElement { get; }

Property Value

Gets or sets value indicating whether multi selection is enabled.

Declaration

[Browsable(true)]
public bool MultiSelect { get; set; }

Property Value

Gets or sets a value indicating whether the most recently added item to the data source should be automatically selected.

Declaration

[Browsable(true)]
public bool SelectLastAddedItem { get; set; }

Property Value

Gets or sets the index of the selected item.

Declaration

[Browsable(false)]
[Bindable(true)]
public int SelectedIndex { get; set; }

Property Value

Gets or sets the selected item.

Declaration

[Browsable(false)]
[Bindable(true)]
public ListViewDataItem SelectedItem { get; set; }

Property Value

Gets a collection containing the selected items.

Declaration

[Browsable(false)]
public ListViewSelectedItemCollection SelectedItems { get; }

Property Value

Gets or sets a value indicating whether checkboxes are displayed next to each item for selection purposes.

Declaration

[Browsable(true)]
public virtual bool ShowCheckBoxes { get; set; }

Property Value

Gets or sets a value indicating whether column headers are visible in DetailsView mode.

Declaration

[Browsable(true)]
public virtual bool ShowColumnHeaders { get; set; }

Property Value

Gets or sets a value indicating whether grid lines are displayed between items and columns in DetailsView mode.

Declaration

[Browsable(true)]
public virtual bool ShowGridLines { get; set; }

Property Value

Gets or sets a value indicating whether items are organized and displayed within their respective groups.

Declaration

[Browsable(true)]
public virtual bool ShowGroups { get; set; }

Property Value

Gets a collection of sort descriptors that define the sorting criteria and order applied to the ListView items.

Declaration

[Browsable(true)]
public SortDescriptorCollection SortDescriptors { get; }

Property Value

Gets or sets a value indicating whether checkboxes support three states: checked, unchecked, and indeterminate.

Declaration

[Browsable(true)]
public bool ThreeStateMode { get; set; }

Property Value

Gets or sets the name of the data source property that provides the value for each item when data binding is used.

Declaration

[Browsable(true)]
public string ValueMember { get; set; }

Property Value

Gets or sets the display behavior of the vertical scrollbar, controlling when it appears and how it behaves.

Declaration

[Browsable(true)]
public ScrollState VerticalScrollState { get; set; }

Property Value

Gets or sets the view mode that determines how items are displayed, such as ListView, DetailsView, IconView.

Declaration

[Browsable(true)]
public virtual ListViewType ViewType { get; set; }

Property Value

Begins an edit operation over the currently selected item.

Declaration

public bool BeginEdit()

Returns

Suspend any item change notifications until RadListView.EndUpdate is called.

Declaration

public void BeginUpdate()

Determines whether the specified RadElement can be edited at design time in the Visual Studio designer.

Declaration

protected override bool CanEditElementAtDesignTime(RadElement element)

Parameters

Returns

Overrides RadControl.CanEditElementAtDesignTime(RadElement)

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

Declaration

public bool CancelEdit()

Returns

Checks all of the items.

Declaration

public void CheckAllItems()

Checks the selected items.

Declaration

public void CheckSelectedItems()

Collapses all the groups in the control.

Declaration

public void CollapseAll()

Creates and returns the accessibility object that provides information to assistive technology applications.

Declaration

protected override AccessibleObject CreateAccessibilityInstance()

Returns

Overrides Control.CreateAccessibilityInstance()

Creates the child elements of the RadListView control, including the main list view element.

Declaration

protected override void CreateChildItems(RadElement parent)

Parameters

Overrides RadControl.CreateChildItems(RadElement)

Creates and returns a new instance of the RadListViewElement that provides the core functionality for the control.

Declaration

protected virtual RadListViewElement CreateListViewElement()

Returns

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

Declaration

public bool EndEdit()

Returns

Resumes the item change notifications.

Declaration

public void EndUpdate()

Expands all the groups in the control.

Declaration

public void ExpandAll()

Finds an item with the specified key.

Declaration

public ListViewDataItem FindItemByKey(object key)

Parameters

Returns

Finds an item with the specified key.

Declaration

public ListViewDataItem FindItemByKey(object key, bool searchVisibleItems)

Parameters

Returns

Determines whether the specified key should be treated as an input key for navigation and selection.

Declaration

protected override bool IsInputKey(Keys keyData)

Parameters

Returns

Overrides RadControl.IsInputKey(Keys)

Handles the GotFocus event and performs initialization operations when the control receives input focus.

Declaration

protected override void OnGotFocus(EventArgs e)

Parameters

Overrides RadControl.OnGotFocus(EventArgs)

Handles key press events and delegates processing to the list view element for navigation and selection.

Declaration

protected override void OnKeyDown(KeyEventArgs e)

Parameters

Overrides RadControl.OnKeyDown(KeyEventArgs)

Handles character input events and delegates processing to the list view element for keyboard search functionality.

Declaration

protected override void OnKeyPress(KeyPressEventArgs e)

Parameters

Overrides RadControl.OnKeyPress(KeyPressEventArgs)

Called when the control is loaded.

Declaration

protected override void OnLoad(Size desiredSize)

Parameters

Overrides RadControl.OnLoad(Size)

Handles the LostFocus event and performs cleanup operations when the control loses input focus.

Declaration

protected override void OnLostFocus(EventArgs e)

Parameters

Overrides RadControl.OnLostFocus(EventArgs)

Handles mouse button press events and delegates processing to the list view element.

Declaration

protected override void OnMouseDown(MouseEventArgs e)

Parameters

Overrides RadControl.OnMouseDown(MouseEventArgs)

Handles mouse movement events and delegates processing to the list view element for hit testing and hover effects.

Declaration

protected override void OnMouseMove(MouseEventArgs e)

Parameters

Overrides RadControl.OnMouseMove(MouseEventArgs)

Handles mouse button release events and delegates processing to the list view element.

Declaration

protected override void OnMouseUp(MouseEventArgs e)

Parameters

Overrides RadControl.OnMouseUp(MouseEventArgs)

Handles mouse wheel events and delegates processing to the list view element for scrolling functionality.

Declaration

protected override void OnMouseWheel(MouseEventArgs e)

Parameters

Overrides RadControl.OnMouseWheel(MouseEventArgs)

Handles property change notifications and performs special processing for filter predicate changes in custom grouping scenarios.

Declaration

protected override void OnNotifyPropertyChanged(PropertyChangedEventArgs e)

Parameters

Overrides RadControl.OnNotifyPropertyChanged(PropertyChangedEventArgs)

Handles theme name changes and performs necessary cleanup and reinitialization of visual elements.

Declaration

protected override void OnThemeNameChanged(ThemeNameChangedEventArgs e)

Parameters

Overrides RadControl.OnThemeNameChanged(ThemeNameChangedEventArgs)

Handles the initialization completion event and applies any property values that were set during the initialization phase.

Declaration

protected virtual void RadListView_Initialized(object sender, EventArgs e)

Parameters

Selects a set of items.

Declaration

public void Select(ListViewDataItem[] items)

Parameters

Unchecks all of the items.

Declaration

public void UncheckAllItems()

Unchecks the selected items.

Declaration

public void UncheckSelectedItems()

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

Declaration

public event EventHandler BindingCompleted

Event Value

Occurs when the binding context for the RadListView has changed, typically during data binding operations.

Declaration

public event EventHandler BindingContextChanged

Event Value

Occurs when a new DetailListViewCellElement needs to be created for displaying cell content in DetailsView mode.

Declaration

public virtual event ListViewCellElementCreatingEventHandler CellCreating

Event Value

Occurs when a cell in DetailsView mode needs to be formatted, allowing custom appearance to be applied.

Declaration

public virtual event ListViewCellFormattingEventHandler CellFormatting

Event Value

Occurs when a new ListViewDetailColumn needs to be created for DetailsView mode.

Declaration

public event ListViewColumnCreatingEventHandler ColumnCreating

Event Value

Occurs when the CurrentItem property has been changed to point to a different item.

Declaration

public event ListViewItemEventHandler CurrentItemChanged

Event Value

Occurs when the CurrentItem property is about to change to a different item. This event is cancelable.

Declaration

public event ListViewItemChangingEventHandler CurrentItemChanging

Event Value

Occurs when an editor control has been initialized and is ready for user input.

Declaration

public event ListViewItemEditorInitializedEventHandler EditorInitialized

Event Value

Occurs when an editor control is required for in-place editing of an item's value.

Declaration

public event ListViewItemEditorRequiredEventHandler EditorRequired

Event Value

Occurs when a group has been expanded and is now displaying its child items.

Declaration

public event EventHandler<ListViewGroupEventArgs> GroupExpanded

Event Value

Occurs when a group is about to expand and display its child items. This event is cancelable.

Declaration

public event EventHandler<ListViewGroupCancelEventArgs> GroupExpanding

Event Value

Occurs when a ListViewDataItem has had its checked state changed successfully.

Declaration

public event ListViewItemEventHandler ItemCheckedChanged

Event Value

Occurs when a ListViewDataItem is about to have its checked state changed. This event is cancelable.

Declaration

public event ListViewItemCancelEventHandler ItemCheckedChanging

Event Value

Occurs when a new ListViewDataItem needs to be created, allowing custom item types to be provided.

Declaration

public event ListViewItemCreatingEventHandler ItemCreating

Event Value

Occurs when a data-bound object is being attached to a ListViewDataItem during the data binding process.

Declaration

public event ListViewItemEventHandler ItemDataBound

Event Value

Occurs when a ListViewDataItem has been successfully edited and the changes have been committed.

Declaration

public event ListViewItemEditedEventHandler ItemEdited

Event Value

Occurs when an edit operation is about to begin on an item. This event is cancelable.

Declaration

public event ListViewItemEditingEventHandler ItemEditing

Event Value

Occurs when the user single-clicks on a ListViewDataItem with any mouse button.

Declaration

public event ListViewItemEventHandler ItemMouseClick

Event Value

Occurs when the user double-clicks on a ListViewDataItem with the primary mouse button.

Declaration

public event ListViewItemEventHandler ItemMouseDoubleClick

Event Value