Class RadListViewElement

Represents the main element of RadListView.

Inheritance
System.Object
DisposableObject
RadObject
RadElement
VisualElement
RadComponentElement
RadItem
UIItemBase
LightVisualElement
RadListViewElement
RadCardViewElement
StyleListViewElement
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Telerik.WinControls.UI
Assembly: Telerik.WinControls.UI.dll

Syntax

public class RadListViewElement : LightVisualElement, INotifyPropertyChanged, ICustomTypeDescriptor, ISupportSystemSkin, IComponent, IDisposable, IBindableComponent, ISupportDrag, ISupportDrop, IShortcutProvider, IStylableElement, IStylableNode, IPrimitiveElement, IShapedElement, IFillElement, IBorderElement, IBoxStyle, IBoxElement, IDrawFillElement, IImageElement, ITextPrimitive, ITextProvider, IDataItemSource

Constructors

RadListViewElement()

Declaration
public RadListViewElement()

Fields

cachedOldValue

Declaration
protected object cachedOldValue
Field Value
System.Object

Properties

ActiveEditor

Gets the currently active editor when an edit operation is in progress.

Declaration
public IInputEditor ActiveEditor { get; }
Property Value
IInputEditor

Remarks

Returns null when no editing is taking place. The active editor provides access to the current edit value and allows for programmatic control over the editing process.

AllowArbitraryItemHeight

Gets or sets a value indicating whether items can have different heights from each other.

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

Remarks

When enabled, each item can be sized independently based on its content. When disabled, all items share the same height for consistent layout and improved performance.

AllowArbitraryItemWidth

Gets or sets a value indicating whether items can have different widths from each other.

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

Remarks

When enabled, each item can be sized independently based on its content width. When disabled, all items share the same width for consistent layout and improved performance.

AllowColumnReorder

Gets or sets a value indicating whether users can reorder columns by dragging and dropping them in Details View.

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

Remarks

When enabled, users can click and drag column headers to reposition them within the column layout. This provides a flexible way to customize the data presentation without requiring code changes.

AllowColumnResize

Gets or sets a value indicating whether users can resize columns by dragging the column borders in Details View.

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

Remarks

When enabled, users can position the mouse cursor over column borders and drag to adjust column widths. This provides interactive control over the data presentation layout.

AllowDragDrop

Gets or sets a value indicating whether users can reorder items by dragging and dropping them within the list.

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

Remarks

Item drag-and-drop is automatically disabled when using data sources, grouping, filtering, sorting, kinetic scrolling, or lasso selection, as these features conflict with manual item reordering.

AllowEdit

Gets or sets a value indicating whether users can edit item values by activating edit mode.

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

Remarks

When enabled, users can edit items by pressing F2, clicking on selected items, or programmatically calling edit methods. Editing behavior depends on the view type and current column in Details View.

AllowRemove

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

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

Remarks

When enabled, pressing the Delete key will remove the selected items from the collection. The removal can be cancelled by handling the ItemRemoving event.

AutoSizeColumnsMode

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

Declaration
public ListViewAutoSizeColumnsMode AutoSizeColumnsMode { get; set; }
Property Value
ListViewAutoSizeColumnsMode

Remarks

Different modes provide various automatic sizing behaviors such as fitting all columns within the available width, sizing based on content, or maintaining fixed widths. The sizing behavior is handled by the appropriate ColumnResizingBehavior implementation.

BindingContext

Gets or sets the BindingContext.

Declaration
public override BindingContext BindingContext { get; set; }
Property Value
System.Windows.Forms.BindingContext

Overrides
Implements
Remarks

The binding context provides currency management and change tracking for data binding operations. When set, it triggers the BindingContextChanged event to notify of the change.

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

Remarks

When set to true, columns with names like "Name" and "name" will be treated as different columns. This affects data binding operations, sorting, filtering, and grouping behavior.

CheckBoxesAlignment

Gets or sets the vertical alignment of checkboxes within list view items.

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

Remarks

This property determines how checkboxes are aligned vertically within the bounds of each item, such as center, top, or bottom alignment.

CheckBoxesPosition

Gets or sets the position of checkboxes relative to list view items.

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

CheckedItems

Gets a collection containing all currently checked items when ShowCheckBoxes is enabled.

Declaration
public ListViewCheckedItemCollection CheckedItems { get; }
Property Value
ListViewCheckedItemCollection

Remarks

Checked items are independent of selected items and allow for bulk operations on multiple items. The collection is read-only and automatically maintained as check states change.

CheckedMember

Gets or sets the checked member.

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

Remarks

When data binding is used and ShowCheckBoxes is enabled, this property specifies which field or property from the data source should be used to determine whether each item's checkbox is checked. The field should contain boolean values.

CheckOnClickMode

Gets or sets the mode that determines when an item's check state changes in response to user clicks.

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

Remarks

This property controls the relationship between item selection and checkbox state changes, allowing for different interaction patterns such as immediate toggling or requiring multiple clicks.

ColumnResizingBehavior

Gets or sets the ColumnResizingBehavior that is responsible for resizing the columns.

Declaration
public BaseColumnResizingBehavior ColumnResizingBehavior { get; set; }
Property Value
BaseColumnResizingBehavior

Remarks

The column resizing behavior determines how columns respond to user resize operations and automatic sizing scenarios. Different behaviors can provide various resizing modes such as proportional resizing or fixed-width constraints.

Columns

Gets the collection of columns that define the structure and appearance of Details View.

Declaration
public ListViewColumnCollection Columns { get; }
Property Value
ListViewColumnCollection

Remarks

Each column represents a data field and defines how that field is displayed, including width, header text, and formatting. Columns are only used in Details View; other view types ignore this collection.

CurrentColumn

Gets or sets the currently active column in Details View for editing and navigation purposes.

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

Remarks

The current column determines which column will be edited when edit operations begin. Setting this property automatically ensures the column is visible and updates the column's current state.

CurrentItem

Gets or sets the item that currently has focus and represents the navigation position within the list.

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

Remarks

The current item is different from the selected item and represents the focused item for keyboard navigation. Setting this property updates the underlying data view's current position and ensures the item is visible.

DataMember

Gets or sets the DataMember within the data source that the RadListViewElement should bind to.

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

Remarks

This property is used when the data source contains multiple tables or lists, such as a DataSet with multiple DataTables. It specifies which specific table or list should be used for data binding.

DataSource

Gets or sets the data source of a RadListViewElement.

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

Remarks

The data source can be any object that implements IList, IListSource, or IEnumerable. When a data source is assigned, the list view automatically creates items and columns based on the data structure. Setting the data source to null clears the data binding and resets the DisplayMember, ValueMember, and CheckedMember properties.

DataView

Gets the DataView collection.

Declaration
public RadCollectionView<ListViewDataItem> DataView { get; }
Property Value
RadCollectionView<ListViewDataItem>

Remarks

The data view wraps the underlying data source and provides a layer for data operations without modifying the original data. It supports complex filtering expressions, multi-level sorting, and hierarchical grouping.

DisplayMember

Gets or sets the display member.

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

Remarks

When data binding is used, this property specifies which field or property from the data source should be displayed as the text content of each list item. If not specified, the ToString() method of the data objects is used.

DragDropService

Gets or sets the drag and drop service that handles item reordering and drag-drop operations.

Declaration
public ListViewDragDropService DragDropService { get; set; }
Property Value
ListViewDragDropService

Remarks

The drag drop service provides functionality for dragging items within the list view and dropping them at different positions or to external targets.

EnableColumnSort

Gets or sets a value indicating whether items should be automatically sorted when users click on column headers in Details View.

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

Remarks

When enabled, clicking on column headers will cycle through ascending sort, descending sort, and no sort states. This provides an intuitive way for users to sort data without requiring custom code.

EnableCustomGrouping

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

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

Remarks

When enabled, grouping operations are handled through custom code rather than automatic grouping descriptors. This allows for complex grouping scenarios that cannot be expressed through simple property-based grouping.

EnableFiltering

Gets or sets a value indicating whether filtering is enabled.

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

Remarks

When enabled, items can be filtered programmatically using FilterDescriptors. Filtering allows hiding items that don't match specified criteria without removing them from the data source.

EnableGrouping

Gets or sets a value indicating whether grouping is enabled.

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

Remarks

When enabled, items can be grouped programmatically using GroupDescriptors. Grouping organizes items with similar values into collapsible categories for better data organization.

EnableKineticScrolling

Gets or sets a value indicating whether kinetic scrolling is enabled, allowing smooth momentum-based scrolling with touch or mouse gestures.

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

Remarks

Kinetic scrolling provides a natural scrolling experience with momentum and deceleration effects. This property always returns false when EnableLassoSelection is enabled, as the two features are incompatible.

EnableLassoSelection

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

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

Remarks

When enabled, users can click and drag to create a selection rectangle that selects all items within its bounds. Lasso selection automatically disables kinetic scrolling and is not compatible with certain other features.

EnableSorting

Gets or sets a value indicating whether sorting is enabled.

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

Remarks

When enabled, items can be sorted programmatically using SortDescriptors. In design mode, this property maintains the design-time setting until runtime initialization.

FilterDescriptors

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

Declaration
public ListViewFilterDescriptorCollection FilterDescriptors { get; }
Property Value
ListViewFilterDescriptorCollection

Remarks

Filter descriptors allow creating complex filtering expressions that determine which items are visible in the list view. Filtering is only available when EnableFiltering is true.

FullRowSelect

Gets or sets a value indicating whether the entire row should be highlighted when an item is selected.

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

Remarks

When enabled, selection highlighting extends across the full width of the item area. When disabled, only the item content area is highlighted, which can provide a more compact appearance.

GroupDescriptors

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

Declaration
public GroupDescriptorCollection GroupDescriptors { get; }
Property Value
GroupDescriptorCollection

Remarks

Group descriptors specify the properties used for grouping items with similar values together. Multiple group descriptors create hierarchical grouping with nested group levels.

GroupIndent

Gets or sets the indentation distance for items displayed within groups.

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

Remarks

When grouping is enabled, regular items are indented by this amount relative to group headers to provide visual hierarchy and distinction between groups and their contents.

GroupItemSize

Gets or sets the default group item size.

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

Remarks

This size applies to the visual elements that represent group headers when ShowGroups is enabled. A size of (0,0) indicates automatic sizing based on group header content.

Groups

Gets a collection containing the groups of the RadListViewElement.

Declaration
public ListViewDataItemGroupCollection Groups { get; }
Property Value
ListViewDataItemGroupCollection

Remarks

Groups are created automatically based on GroupDescriptors or can be manually managed when EnableCustomGrouping is enabled. Groups are only visible when ShowGroups is true.

HeaderHeight

Gets or sets the height of column headers in Details View.

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

Remarks

This property controls the vertical space allocated for column headers when ShowColumnHeaders is enabled. The value is automatically scaled based on the current DPI settings for high-DPI scenarios.

HorizontalScrollState

Gets or sets the display state of the horizontal scrollbar.

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

Remarks

Controls when the horizontal scrollbar appears: always visible, always hidden, or automatically shown only when the content width exceeds the available display area.

HotTracking

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

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

Remarks

When enabled, items will change their appearance (typically highlighting) when the mouse pointer moves over them, providing immediate visual feedback to users about which item they can interact with.

IsDataBound

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

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

Remarks

Returns true when a data source has been assigned to the DataSource property. Data binding automatically creates items and columns based on the structure of the bound data.

IsEditing

Gets a value indicating whether an edit operation is currently active on an item.

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

Remarks

Returns true when an editor is active and the user is currently editing an item's value. This property is read-only and reflects the editing state managed by the ActiveEditor property.

Items

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

Declaration
public ListViewDataItemCollection Items { get; }
Property Value
ListViewDataItemCollection

Remarks

When data binding is used, this collection is automatically populated from the data source. When not data bound, items can be added and removed directly from this collection.

ItemSize

Gets or sets the default item size.

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

Remarks

This size is used as a starting point for item layout. Individual items may be sized differently if AllowArbitraryItemHeight or AllowArbitraryItemWidth are enabled. A size of (0,0) indicates automatic sizing based on content.

ItemSpacing

Gets or sets the spacing distance between adjacent items in the layout.

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

Remarks

This property controls the gap between items, providing visual separation and improving readability. The spacing applies to both horizontal and vertical gaps depending on the current view type and layout direction.

KeyboardSearchEnabled

Gets or sets a value indicating whether users can navigate to items by typing their first characters when the list view has focus.

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

Remarks

When enabled, typing characters will search for and select the first item that starts with those characters. This provides quick keyboard navigation for large lists. The default value is false.

KeyboardSearchResetInterval

Gets or sets the time interval in milliseconds that must elapse before the keyboard search resets to start a new search.

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

Remarks

After this interval without typing, the next keystroke will start a new search from the beginning rather than continuing the current search. The default value is 300 milliseconds.

ListSource

Gets the list source that manages data binding operations and provides access to the underlying data.

Declaration
public RadListSource<ListViewDataItem> ListSource { get; }
Property Value
RadListSource<ListViewDataItem>

Remarks

The list source acts as an intermediary between the list view and the data source, handling data binding, change notifications, and data transformation operations.

MultiSelect

Gets or sets a value indicating whether multiple items can be selected simultaneously.

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

Remarks

When enabled, users can select multiple items using Ctrl+Click, Shift+Click, or lasso selection. When disabled, selecting a new item automatically deselects any previously selected items.

SelectedIndex

Gets or sets the zero-based index of the currently selected item.

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

Remarks

Returns -1 when no item is selected. Setting this property to a valid index selects the corresponding item, while setting it to an invalid index (negative or beyond the collection size) clears the selection.

SelectedItem

Gets or sets the currently selected item in the list view.

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

Remarks

Only one item can be selected at a time unless MultiSelect is enabled. Setting this property triggers selection change events and updates the visual appearance of items.

SelectedItems

Gets a collection containing all currently selected items.

Declaration
public ListViewSelectedItemCollection SelectedItems { get; }
Property Value
ListViewSelectedItemCollection

Remarks

When MultiSelect is disabled, this collection contains at most one item. The collection is read-only and automatically maintained as selection changes occur.

SelectionRectangleBorderColor

Gets or sets the border color of the lasso selection rectangle.

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

Remarks

This color defines the outline of the selection rectangle when EnableLassoSelection is enabled. The border provides clear visual feedback about the selection area boundaries.

SelectionRectangleColor

Gets or sets the fill color of the lasso selection rectangle drawn during drag selection operations.

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

Remarks

This color is used to fill the selection rectangle when EnableLassoSelection is enabled and users drag to select multiple items. The fill is typically semi-transparent to allow underlying content to show through.

SelectLastAddedItem

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

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

Remarks

When set to true, adding new items to the data source will automatically select the most recently added item. This is useful for scenarios where immediate user attention should be drawn to newly created items.

ShowCheckBoxes

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

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

Remarks

When enabled, each item displays a checkbox that can be checked independently of item selection. This allows for bulk operations on checked items and multi-state selection scenarios.

ShowColumnHeaders

Gets or sets a value indicating whether column headers should be visible in Details View.

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

Remarks

Column headers display column names and provide click targets for sorting operations. Hiding headers can save vertical space but removes sorting functionality and column identification.

ShowGridLines

Gets or sets a value indicating whether grid lines should be displayed in Details View to separate rows and columns.

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

Remarks

Grid lines provide visual separation between items and columns in Details View, making it easier to read tabular data. This property only affects Details View; other view types do not display grid lines.

ShowGroups

Gets or sets a value indicating whether items should be organized and displayed in collapsible groups.

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

Remarks

When enabled, items with the same group value are visually grouped together under expandable/collapsible group headers. Grouping works in conjunction with GroupDescriptors to define grouping criteria.

SortDescriptors

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

Declaration
public SortDescriptorCollection SortDescriptors { get; }
Property Value
SortDescriptorCollection

Remarks

Sort descriptors specify the properties and directions used for sorting items. Multiple sort descriptors create multi-level sorting where items are sorted by the first descriptor, then by the second descriptor within equal groups, and so on.

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

Remarks

When data binding is used, this property specifies which field or property from the data source should be used as the value for each list item. This is important for scenarios where the displayed text differs from the underlying value.

VerticalScrollState

Gets or sets the display state of the vertical scrollbar.

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

Remarks

Controls when the vertical scrollbar appears: always visible, always hidden, or automatically shown only when the content height exceeds the available display area.

ViewElement

Gets the element that represents the active view.

Declaration
public BaseListViewElement ViewElement { get; }
Property Value
BaseListViewElement

Remarks

The view element is automatically created based on the view type and manages item layout, scrolling, virtualization, and user interaction for the specific view mode.

ViewType

Gets or sets the visual layout mode that determines how items are presented and organized.

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

Remarks

Changing the view type recreates the view element and can significantly alter the appearance and behavior of the list view. Available types include ListView (simple list), IconsView (icon grid), and DetailsView (table format).

Methods

BeginEdit()

Initiates an edit operation on the currently selected item.

Declaration
public virtual bool BeginEdit()
Returns
System.Boolean

True if the edit operation was successfully started; otherwise, false.
Remarks

The edit operation will fail if editing is disabled, an editor is already active, multiple items are selected, no item is selected, or in Details View when no current column is set. The method ensures the item is visible and properly initializes the appropriate editor for the current view type.

BeginUpdate()

Suspends item change notifications until EndUpdate() is called to improve performance.

Declaration
public void BeginUpdate()
Remarks

This method is useful when adding, removing, or modifying multiple items at once. It prevents individual change notifications from being fired for each operation, which can significantly improve performance during bulk operations.

BestFitColumns(ListViewBestFitColumnMode)

Automatically adjusts column widths based on their content according to the specified fitting mode.

Declaration
public void BestFitColumns(ListViewBestFitColumnMode mode)
Parameters
ListViewBestFitColumnMode mode

The ListViewBestFitColumnMode that determines how columns should be sized.
Remarks

This method only has an effect in Details View. It analyzes the content of columns and adjusts their widths to optimally display the data according to the specified mode, such as fitting headers, content, or both.

BindingComplete()

Completes the data binding process and raises the BindingCompleted event.

Declaration
public void BindingComplete()
Implements
Remarks

This method is called when the data binding initialization process has finished successfully. It allows subscribers to perform any post-binding operations or UI updates.

CancelEdit()

Cancels the current edit operation, discarding any changes made to the item.

Declaration
public bool CancelEdit()
Returns
System.Boolean

True if the edit operation was successfully cancelled; otherwise, false.
Remarks

This method abandons any changes made during the edit operation and restores the item to its previous state. The editor is properly cleaned up and removed from the visual tree.

CheckAllItems()

Checks all of the items.

Declaration
public void CheckAllItems()
Remarks

This method is only effective when ShowCheckBoxes is enabled. It provides a convenient way to check all items in the list view regardless of their selection state.

CheckSelectedItems()

Checks all of the selected items.

Declaration
public void CheckSelectedItems()
Remarks

This method is only effective when ShowCheckBoxes is enabled. It provides a convenient way to check all selected items in a single operation.

CollapseAll()

Collapses all group headers.

Declaration
public void CollapseAll()
Remarks

This method sets the Expanded property to false for all groups in the Groups collection. It only has an effect when ShowGroups is enabled and groups are present.

CreateBindingContext()

Creates a new binding context instance for managing data binding operations.

Declaration
protected virtual BindingContext CreateBindingContext()
Returns
System.Windows.Forms.BindingContext

A new BindingContext instance.

CreateChildElements()

Creates and initializes all child elements and sets up the basic structure of the list view.

Declaration
protected override void CreateChildElements()
Overrides
Remarks

This method creates the binding context, list source, data collections, view element, and other essential components. It also establishes event handlers and creates the initial view element based on the default view type.

CreateViewElement()

Creates and returns the appropriate view element based on the current ViewType.

Declaration
protected virtual BaseListViewElement CreateViewElement()
Returns
BaseListViewElement

A new BaseListViewElement instance configured for the current view type.
Remarks

This method acts as a factory for creating view-specific elements. It creates different element types for ListView, IconsView, and DetailsView, with ListView as the default fallback option.

DisposeManagedResources()

Disposes of managed resources including cached editors and the list source.

Declaration
protected override void DisposeManagedResources()
Overrides
Remarks

This method performs cleanup of managed resources, including unwiring events, disposing cached editors and their elements, clearing the editor cache, and disposing the list source. It ensures proper resource cleanup to prevent memory leaks.

EndEdit()

Ends the current edit operation, saving any changes made to the item.

Declaration
public bool EndEdit()
Returns
System.Boolean

True if the edit operation was successfully completed; otherwise, false.
Remarks

This method commits any changes made during the edit operation and properly cleans up the editor. If validation fails or other issues occur, the edit operation may not complete successfully.

EndEditCore(Boolean)

Implements the core logic for ending or cancelling an edit operation.

Declaration
protected virtual bool EndEditCore(bool commitChanges)
Parameters
System.Boolean commitChanges

True to save changes; false to discard them.
Returns
System.Boolean

True if the operation completed successfully; otherwise, false.
Remarks

This method handles the complete lifecycle of ending an edit operation, including validation, value saving, editor cleanup, and event notification. It includes protection against re-entrant calls and ensures proper state management.

EndUpdate()

Resumes item change notifications that were suspended by BeginUpdate().

Declaration
public void EndUpdate()
Remarks

This method restores normal change notification behavior and triggers any pending notifications that were accumulated during the update suspension period.

EnsureColumnVisible(ListViewDetailColumn)

Scrolls the view to ensure that the specified column is visible in Details View.

Declaration
public virtual void EnsureColumnVisible(ListViewDetailColumn listViewDetailColumn)
Parameters
ListViewDetailColumn listViewDetailColumn

The ListViewDetailColumn to make visible.
Remarks

This method only has an effect when the current view type is Details View. It scrolls horizontally to bring the specified column into the visible area of the control.

EnsureItemVisible(ListViewDataItem)

Scrolls the view to ensure that the specified item is visible within the client area.

Declaration
public virtual void EnsureItemVisible(ListViewDataItem item)
Parameters
ListViewDataItem item

The ListViewDataItem to make visible.
Remarks

This method scrolls the list view vertically to bring the specified item into view. If the item is already visible, no scrolling occurs.

EnsureItemVisible(ListViewDataItem, Boolean)

Scrolls the view to ensure that the specified item is visible, with optional horizontal scrolling.

Declaration
public virtual void EnsureItemVisible(ListViewDataItem item, bool ensureHorizontally)
Parameters
ListViewDataItem item

The ListViewDataItem to make visible.
System.Boolean ensureHorizontally

If true, also scrolls horizontally to ensure the item is fully visible.
Remarks

This method provides more control over the scrolling behavior by allowing horizontal scrolling in addition to vertical scrolling. This is particularly useful in scenarios where items may extend beyond the horizontal bounds of the view.

ExpandAll()

Expands all group headers.

Declaration
public void ExpandAll()
Remarks

This method sets the Expanded property to true for all groups in the Groups collection. It only has an effect when ShowGroups is enabled and groups are present.

FindItemByKey(Object)

Searches for and returns the first item that has the specified key value.

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

The key value to search for.
Returns
ListViewDataItem

The first ListViewDataItem with the specified key, or null if no match is found.
Remarks

This method searches through all items in the collection, including items that may not currently be visible. The search uses object equality comparison to match the key values.

FindItemByKey(Object, Boolean)

Searches for and returns the first item that has the specified key value, with an option to search only visible items.

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

The key value to search for.
System.Boolean searchVisibleItems

If true, searches only currently visible items; if false, searches all items.
Returns
ListViewDataItem

The first ListViewDataItem with the specified key, or null if no match is found.
Remarks

When searchVisibleItems is true, only items that are currently virtualized and visible in the view will be searched. This can be more efficient for large datasets but may not find items that are scrolled out of view.

GetEditor(Type)

Retrieves or creates an editor instance of the specified type from the editor cache.

Declaration
protected virtual IInputEditor GetEditor(Type editorType)
Parameters
System.Type editorType

The type of editor to retrieve or create.
Returns
IInputEditor

An instance of the specified editor type, or null if creation fails.
Remarks

This method maintains a cache of editor instances to improve performance by reusing editors across multiple edit operations. If an editor of the requested type doesn't exist in the cache, a new instance is created and added to the cache.

Initialize()

Initializes the RadListViewElement.

Declaration
public void Initialize()
Implements
Remarks

This method performs a complete reset of the list view's data-related state, including clearing visual items, resetting selections, and rebuilding bound columns if data binding is active. The operation is performed with layout suspension for optimal performance.

InitializeEditor(BaseListViewVisualItem, ISupportInitialize, IInputEditor)

Initializes the editor for the specified visual item with the appropriate initial value.

Declaration
protected virtual void InitializeEditor(BaseListViewVisualItem visualItem, ISupportInitialize initializable, IInputEditor editor)
Parameters
BaseListViewVisualItem visualItem

The visual item being edited.
System.ComponentModel.ISupportInitialize initializable

The initializable interface of the editor, if supported.
IInputEditor editor

The editor instance to initialize.
Remarks

This method sets up the editor with the correct initial value based on the current view type. In Details View, the value comes from the current column; otherwise, it uses the item's main value. The method also handles Material theme adjustments for proper editor display.

MeasureOverride(SizeF)

Measures the desired size of the element within the constraints of the available size.

Declaration
protected override SizeF MeasureOverride(SizeF availableSize)
Parameters
System.Drawing.SizeF availableSize

The available space that can be given to the element.
Returns
System.Drawing.SizeF

The desired size of the element.
Overrides
Remarks

This method ensures that infinite sizes are converted to the measured size to prevent layout issues. It provides a consistent measurement result that works within the layout system constraints.

NewItem()

Creates a new item for the data source.

Declaration
public IDataItem NewItem()
Returns
IDataItem

A new ListViewDataItem instance configured for this list view element.
Implements
Remarks

This method creates a new item and allows for customization through the ItemCreating event. The created item is automatically assigned ownership to this list view element.

OnBindingContextChanged(EventArgs)

Raises the BindingContextChanged event when the binding context changes.

Declaration
protected virtual void OnBindingContextChanged(EventArgs e)
Parameters
System.EventArgs e

The event data.

OnCellCreating(ListViewCellElementCreatingEventArgs)

Raises the CellCreating event when a cell element needs to be created.

Declaration
protected virtual void OnCellCreating(ListViewCellElementCreatingEventArgs args)
Parameters
ListViewCellElementCreatingEventArgs args

The event data containing the cell creation information.

OnCellFormatting(ListViewCellFormattingEventArgs)

Raises the CellFormatting event when a cell in Details View needs formatting.

Declaration
protected virtual void OnCellFormatting(ListViewCellFormattingEventArgs args)
Parameters
ListViewCellFormattingEventArgs args

The event data containing the cell formatting information.

OnColumnCreating(ListViewColumnCreatingEventArgs)

Raises the ColumnCreating event when a column needs to be created.

Declaration
protected virtual void OnColumnCreating(ListViewColumnCreatingEventArgs args)
Parameters
ListViewColumnCreatingEventArgs args

The event data containing the column creation information.

OnCurrecntItemChanged(ListViewItemEventArgs)

Obsolete. The name of the method has a typo. Use the OnCurrentItemChanged(ListViewItemEventArgs args) method instead.

Declaration
[Obsolete("Obsolete. The name of the method has a typo. Use the OnCurrentItemChanged(ListViewItemEventArgs args) method instead.")]
protected virtual void OnCurrecntItemChanged(ListViewItemEventArgs args)
Parameters
ListViewItemEventArgs args

OnCurrentItemChanged(ListViewItemEventArgs)

Raises the CurrentItemChanged event when the current item has changed.

Declaration
protected virtual void OnCurrentItemChanged(ListViewItemEventArgs args)
Parameters
ListViewItemEventArgs args

The event data containing the current item information.

OnCurrentItemChanging(ListViewItemChangingEventArgs)

Raises the CurrentItemChanging event and allows cancellation of the current item change.

Declaration
protected virtual bool OnCurrentItemChanging(ListViewItemChangingEventArgs args)
Parameters
ListViewItemChangingEventArgs args

The event data containing the current item change information.
Returns
System.Boolean

Returns true if the operation was cancelled; otherwise, false.

OnDataItemCreating(ListViewItemCreatingEventArgs)

Raises the ItemCreating event when a data item needs to be created.

Declaration
protected virtual void OnDataItemCreating(ListViewItemCreatingEventArgs args)
Parameters
ListViewItemCreatingEventArgs args

The event data containing the item creation information.

OnEdited(ListViewItemEditedEventArgs)

Raises the ItemEdited event when an item has been edited.

Declaration
protected virtual void OnEdited(ListViewItemEditedEventArgs args)
Parameters
ListViewItemEditedEventArgs args

The event data containing the editing information.

OnEditing(ListViewItemEditingEventArgs)

Raises the ItemEditing event when an edit operation is about to begin.

Declaration
protected virtual void OnEditing(ListViewItemEditingEventArgs e)
Parameters
ListViewItemEditingEventArgs e

The event data containing the editing information.

OnEditorInitialized(ListViewItemEditorInitializedEventArgs)

Raises the EditorInitialized event when an editor has been successfully initialized.

Declaration
protected virtual void OnEditorInitialized(ListViewItemEditorInitializedEventArgs e)
Parameters
ListViewItemEditorInitializedEventArgs e

The event data containing the editor initialization information.

OnEditorRequired(ListViewItemEditorRequiredEventArgs)

Raises the EditorRequired event when an editor is needed for item editing.

Declaration
protected virtual void OnEditorRequired(ListViewItemEditorRequiredEventArgs e)
Parameters
ListViewItemEditorRequiredEventArgs e

The event data containing the editor requirements.

OnItemCheckedChanged(ListViewItemEventArgs)

Raises the ItemCheckedChanged event when an item's check state has changed.

Declaration
protected virtual void OnItemCheckedChanged(ListViewItemEventArgs args)
Parameters
ListViewItemEventArgs args

The event data containing the item information.

OnItemCheckedChanging(ListViewItemCancelEventArgs)

Raises the ItemCheckedChanging event and allows cancellation of the item check state change.

Declaration
protected virtual bool OnItemCheckedChanging(ListViewItemCancelEventArgs args)
Parameters
ListViewItemCancelEventArgs args

The event data containing the item check state change information.
Returns
System.Boolean

Returns true if the operation was cancelled; otherwise, false.

OnItemDataBound(ListViewDataItem)

Raises the ItemDataBound event when an item is bound to data.

Declaration
protected virtual void OnItemDataBound(ListViewDataItem item)
Parameters
ListViewDataItem item

The ListViewDataItem that was bound to data.

OnItemMouseClick(ListViewItemEventArgs)

Raises the ItemMouseClick event when an item is clicked.

Declaration
protected virtual void OnItemMouseClick(ListViewItemEventArgs args)
Parameters
ListViewItemEventArgs args

The event data containing the item information.

OnItemMouseDoubleClick(ListViewItemEventArgs)

Raises the ItemMouseDoubleClick event when an item is double-clicked.

Declaration
protected virtual void OnItemMouseDoubleClick(ListViewItemEventArgs args)
Parameters
ListViewItemEventArgs args

The event data containing the item information.

OnItemMouseDown(ListViewItemMouseEventArgs)

Raises the ItemMouseDown event when a mouse button is pressed over an item.

Declaration
protected virtual void OnItemMouseDown(ListViewItemMouseEventArgs args)
Parameters
ListViewItemMouseEventArgs args

The event data containing the item and mouse information.

OnItemMouseEnter(ListViewItemEventArgs)

Raises the ItemMouseEnter event when the mouse pointer enters an item.

Declaration
protected virtual void OnItemMouseEnter(ListViewItemEventArgs args)
Parameters
ListViewItemEventArgs args

The event data containing the item information.

OnItemMouseHover(ListViewItemEventArgs)

Raises the ItemMouseHover event when the mouse pointer hovers over an item.

Declaration
protected virtual void OnItemMouseHover(ListViewItemEventArgs args)
Parameters
ListViewItemEventArgs args

The event data containing the item information.

OnItemMouseLeave(ListViewItemEventArgs)

Raises the ItemMouseLeave event when the mouse pointer leaves an item.

Declaration
protected virtual void OnItemMouseLeave(ListViewItemEventArgs args)
Parameters
ListViewItemEventArgs args

The event data containing the item information.

OnItemMouseMove(ListViewItemMouseEventArgs)

Raises the ItemMouseMove event when the mouse pointer moves over an item.

Declaration
protected virtual void OnItemMouseMove(ListViewItemMouseEventArgs args)
Parameters
ListViewItemMouseEventArgs args

The event data containing the item and mouse information.

OnItemMouseUp(ListViewItemMouseEventArgs)

Raises the ItemMouseUp event when a mouse button is released over an item.

Declaration
protected virtual void OnItemMouseUp(ListViewItemMouseEventArgs args)
Parameters
ListViewItemMouseEventArgs args

The event data containing the item and mouse information.

OnItemRemoved(ListViewItemEventArgs)

Raises the ItemRemoved event when an item has been removed.

Declaration
protected virtual void OnItemRemoved(ListViewItemEventArgs args)
Parameters
ListViewItemEventArgs args

The event data containing the removed item information.

OnItemRemoving(ListViewItemCancelEventArgs)

Raises the ItemRemoving event and allows cancellation of the item removal.

Declaration
protected virtual bool OnItemRemoving(ListViewItemCancelEventArgs args)
Parameters
ListViewItemCancelEventArgs args

The event data containing the item removal information.
Returns
System.Boolean

Returns true if the operation was cancelled; otherwise, false.

OnSelectedIndexChanged()

Raises the SelectedIndexChanged event when the selected item index changes.

Declaration
protected virtual void OnSelectedIndexChanged()

OnSelectedItemChanged(ListViewDataItem)

Raises the SelectedItemChanged event when the selected item changes.

Declaration
protected virtual void OnSelectedItemChanged(ListViewDataItem item)
Parameters
ListViewDataItem item

The newly selected ListViewDataItem.

OnSelectedItemChanging(ListViewItemCancelEventArgs)

Raises the SelectedItemChanging event and allows cancellation of the item selection.

Declaration
protected virtual bool OnSelectedItemChanging(ListViewItemCancelEventArgs args)
Parameters
ListViewItemCancelEventArgs args

The event data containing the item selection information.
Returns
System.Boolean

Returns true if the operation was cancelled; otherwise, false.

OnSelectedItemsChanged()

Raises the SelectedItemsChanged event when the selected items collection changes.

Declaration
protected virtual void OnSelectedItemsChanged()

OnStyleChanged(RadPropertyChangedEventArgs)

Declaration
protected override void OnStyleChanged(RadPropertyChangedEventArgs e)
Parameters
RadPropertyChangedEventArgs e

Overrides

OnValidationError(EventArgs)

Raises the ValidationError event when a validation error occurs.

Declaration
protected virtual void OnValidationError(EventArgs args)
Parameters
System.EventArgs args

The event data for the validation error.

OnValueChanged(ListViewItemValueChangedEventArgs)

Raises the ItemValueChanged event when an item's value has changed.

Declaration
protected virtual void OnValueChanged(ListViewItemValueChangedEventArgs args)
Parameters
ListViewItemValueChangedEventArgs args

The event data containing the value change information.

OnValueChanging(ListViewItemValueChangingEventArgs)

Raises the ItemValueChanging event and allows cancellation of the value change.

Declaration
protected virtual bool OnValueChanging(ListViewItemValueChangingEventArgs args)
Parameters
ListViewItemValueChangingEventArgs args

The event data containing the value change information.
Returns
System.Boolean

Returns true if the operation was cancelled; otherwise, false.

OnValueValidating(ListViewItemValidatingEventArgs)

Raises the ItemValidating event when an item value needs to be validated.

Declaration
protected virtual void OnValueValidating(ListViewItemValidatingEventArgs args)
Parameters
ListViewItemValidatingEventArgs args

The event data containing the validation information.

OnViewTypeChanged()

Raises the ViewTypeChanged event when the view type has changed.

Declaration
protected virtual void OnViewTypeChanged()

OnViewTypeChanging(ViewTypeChangingEventArgs)

Raises the ViewTypeChanging event and allows cancellation of the view type change.

Declaration
protected virtual bool OnViewTypeChanging(ViewTypeChangingEventArgs args)
Parameters
ViewTypeChangingEventArgs args

The event data containing the view type change information.
Returns
System.Boolean

Returns true if the operation was cancelled; otherwise, false.

OnVisualItemCreating(ListViewVisualItemCreatingEventArgs)

Raises the VisualItemCreating event when a visual item needs to be created.

Declaration
protected virtual void OnVisualItemCreating(ListViewVisualItemCreatingEventArgs args)
Parameters
ListViewVisualItemCreatingEventArgs args

The event data containing the visual item creation information.

OnVisualItemFormatting(BaseListViewVisualItem)

Raises the VisualItemFormatting event when a visual item needs formatting.

Declaration
protected virtual void OnVisualItemFormatting(BaseListViewVisualItem item)
Parameters
BaseListViewVisualItem item

The BaseListViewVisualItem that needs formatting.

ProcessKeyDown(KeyEventArgs)

Processes key down events for keyboard navigation and interaction within the list view.

Declaration
public virtual bool ProcessKeyDown(KeyEventArgs e)
Parameters
System.Windows.Forms.KeyEventArgs e

The key event data containing information about the key pressed and modifier keys.
Returns
System.Boolean

True if the event was handled by the list view; otherwise, false.

ProcessKeyPress(KeyPressEventArgs)

Processes key press events for character input and keyboard search functionality.

Declaration
public virtual bool ProcessKeyPress(KeyPressEventArgs e)
Parameters
System.Windows.Forms.KeyPressEventArgs e

The key press event data containing information about the character typed.
Returns
System.Boolean

True if the event was handled by the list view; otherwise, false.

ProcessMouseDown(MouseEventArgs)

Processes mouse down events when a mouse button is pressed over the list view.

Declaration
public virtual bool ProcessMouseDown(MouseEventArgs e)
Parameters
System.Windows.Forms.MouseEventArgs e

The mouse event data containing information about the button pressed and cursor position.
Returns
System.Boolean

True if the event was handled by the list view; otherwise, false.

ProcessMouseMove(MouseEventArgs)

Processes mouse move events when the mouse pointer moves over the list view.

Declaration
public virtual bool ProcessMouseMove(MouseEventArgs e)
Parameters
System.Windows.Forms.MouseEventArgs e

The mouse event data containing information about the cursor position and movement.
Returns
System.Boolean

True if the event was handled by the list view; otherwise, false.

ProcessMouseUp(MouseEventArgs)

Processes mouse up events when the mouse button is released over the list view.

Declaration
public virtual bool ProcessMouseUp(MouseEventArgs e)
Parameters
System.Windows.Forms.MouseEventArgs e

The mouse event data containing information about the button released and cursor position.
Returns
System.Boolean

True if the event was handled by the list view; otherwise, false.

ProcessMouseWheel(MouseEventArgs)

Processes mouse wheel events for scrolling the list view content.

Declaration
public virtual bool ProcessMouseWheel(MouseEventArgs e)
Parameters
System.Windows.Forms.MouseEventArgs e

The mouse event data containing information about the wheel movement and direction.
Returns
System.Boolean

True if the event was handled by the list view; otherwise, false.

ResetCurrentItem()

Resets the current item to null and clears the current state from the previously current item.

Declaration
public void ResetCurrentItem()
Remarks

This method is used internally to clear the current item state without triggering change events. It ensures proper cleanup of the current item's visual state.

SaveEditorValue(BaseListViewVisualItem, Object)

Saves the edited value to the appropriate item property with validation.

Declaration
protected virtual void SaveEditorValue(BaseListViewVisualItem visualItem, object newValue)
Parameters
BaseListViewVisualItem visualItem

The visual item that was edited.
System.Object newValue

The new value from the editor.
Remarks

This method performs validation of the new value and converts empty strings to null. If validation fails, a validation error event is raised and the value is not saved. The method handles the different save paths for Details View and other view types.

ScrollTo(Int32)

Scrolls the view by the specified amount in pixels.

Declaration
public void ScrollTo(int delta)
Parameters
System.Int32 delta

The amount to scroll in pixels. Positive values scroll down, negative values scroll up.

Select(ListViewDataItem[])

Selects the specified array of items in the list view.

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

An array of ListViewDataItem objects to select.
Remarks

If MultiSelect is disabled, only the last item in the array will be selected. If MultiSelect is enabled, all items in the array will be selected. The method automatically handles the selection state management and event notifications.

SetSelectedItemValue(ListViewItemValueChangingEventArgs, Object)

Sets the value on the selected item, handling the differences between view types.

Declaration
protected virtual void SetSelectedItemValue(ListViewItemValueChangingEventArgs valueChangingArgs, object newValue)
Parameters
ListViewItemValueChangingEventArgs valueChangingArgs

The event arguments for the value change operation.
System.Object newValue

The new value to set on the item.
Remarks

In Details View, the value is set on the specific column of the item. In other view types, the value is set on the item's main Value property. The method ensures that appropriate change events are raised during the operation.

SynchronizeVisualItems()

Synchronizes the visual representation of items with their underlying data state.

Declaration
public virtual void SynchronizeVisualItems()
Remarks

This method ensures that all visual items reflect the current state of their corresponding data items. It iterates through all visual children and calls their Synchronize method to update their appearance based on current data, selection state, and other properties.

UncheckAllItems()

Unchecks all of the items.

Declaration
public void UncheckAllItems()
Remarks

This method is only effective when ShowCheckBoxes is enabled. It provides a convenient way to uncheck all items in the list view regardless of their selection state.

UncheckSelectedItems()

Unchecks all of the selected items.

Declaration
public void UncheckSelectedItems()
Remarks

This method is only effective when ShowCheckBoxes is enabled. It provides a convenient way to uncheck all selected items in a single operation.

UnwireEvents()

Unsubscribes from all collection and view events to prevent memory leaks during disposal.

Declaration
protected virtual void UnwireEvents()
Remarks

This method removes all event handlers that were established in WireEvents() to ensure proper cleanup and prevent potential memory leaks when the element is being disposed.

Update(RadListViewElement.UpdateModes)

Triggers various update operations on the list view based on the specified update mode flags.

Declaration
public virtual void Update(RadListViewElement.UpdateModes updateMode)
Parameters
RadListViewElement.UpdateModes updateMode

A combination of RadListViewElement.UpdateModes flags indicating which operations to perform.
Remarks

This method allows fine-grained control over what aspects of the list view should be updated. Multiple update modes can be combined using bitwise OR operations to perform multiple updates in a single call for optimal performance.

UpdateCheckedItems()

Updates the contents of the CheckedItems collection.

Declaration
public void UpdateCheckedItems()
Remarks

This method rebuilds the checked items collection by examining the check state of every item in the list view. It should be called when the check states may have been modified outside of the normal checkbox interaction mechanisms.

WireEvents()

Subscribes to the necessary collection and view events for proper data synchronization.

Declaration
protected virtual void WireEvents()
Remarks

This method establishes event handlers for groups, columns, filter descriptors, sort descriptors, and collection view changes. These handlers ensure that the UI stays synchronized with data changes.

Events

BindingCompleted

Occurs when the data binding process for the RadListViewElement has completed successfully.

Declaration
public event EventHandler BindingCompleted
Event Type
System.EventHandler

BindingContextChanged

Occurs when the BindingContext property value changes.

Declaration
public event EventHandler BindingContextChanged
Event Type
System.EventHandler

Implements

CellCreating

Occurs when a DetailListViewCellElement needs to be created for Details View.

Declaration
public event ListViewCellElementCreatingEventHandler CellCreating
Event Type
ListViewCellElementCreatingEventHandler

CellFormatting

Occurs when a cell in Details View needs to be formatted.

Declaration
public event ListViewCellFormattingEventHandler CellFormatting
Event Type
ListViewCellFormattingEventHandler

ColumnCreating

Occurs when a ListViewDetailColumn needs to be created during data binding.

Declaration
public event ListViewColumnCreatingEventHandler ColumnCreating
Event Type
ListViewColumnCreatingEventHandler

CurrentItemChanged

Occurs when the CurrentItem property has changed.

Declaration
public event ListViewItemEventHandler CurrentItemChanged
Event Type
ListViewItemEventHandler

CurrentItemChanging

Occurs when the CurrentItem property is about to change and allows cancellation of the operation.

Declaration
public event ListViewItemChangingEventHandler CurrentItemChanging
Event Type
ListViewItemChangingEventHandler

EditorInitialized

Occurs when an editor has been initialized for editing an item.

Declaration
public event ListViewItemEditorInitializedEventHandler EditorInitialized
Event Type
ListViewItemEditorInitializedEventHandler

EditorRequired

Occurs when an editor is required for editing a list view item.

Declaration
public event ListViewItemEditorRequiredEventHandler EditorRequired
Event Type
ListViewItemEditorRequiredEventHandler

GroupExpanded

Occurs when a group has been expanded in the list view.

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

GroupExpanding

Occurs when a group is about to expand and allows cancellation of the operation.

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

ItemCheckedChanged

Occurs when the checked state of a ListViewDataItem has changed.

Declaration
public event ListViewItemEventHandler ItemCheckedChanged
Event Type
ListViewItemEventHandler

ItemCheckedChanging

Occurs when a ListViewDataItem is about to be checked and allows cancellation of the operation.

Declaration
public event ListViewItemCancelEventHandler ItemCheckedChanging
Event Type
ListViewItemCancelEventHandler

ItemCreating

Occurs when a ListViewDataItem needs to be created during data binding or item creation.

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 has been edited and the edit operation is complete.

Declaration
public event ListViewItemEditedEventHandler ItemEdited
Event Type
ListViewItemEditedEventHandler

ItemEditing

Occurs when an edit operation is about to begin and allows cancellation of the operation.

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 the bounds of a ListViewDataItem.

Declaration
public event ListViewItemEventHandler ItemMouseEnter
Event Type
ListViewItemEventHandler

ItemMouseHover

Occurs when the user hovers the mouse pointer over a ListViewDataItem.

Declaration
public event ListViewItemEventHandler ItemMouseHover
Event Type
ListViewItemEventHandler

ItemMouseLeave

Occurs when the mouse pointer leaves the bounds of a ListViewDataItem.

Declaration
public event ListViewItemEventHandler ItemMouseLeave
Event Type
ListViewItemEventHandler

ItemMouseMove

Occurs when the user moves the mouse pointer over a ListViewDataItem.

Declaration
public event ListViewItemMouseEventHandler ItemMouseMove
Event Type
ListViewItemMouseEventHandler

ItemMouseUp

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

Declaration
public event ListViewItemMouseEventHandler ItemMouseUp
Event Type
ListViewItemMouseEventHandler

ItemRemoved

Occurs when an item has been 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 and allows cancellation of the operation.

Declaration
public event ListViewItemCancelEventHandler ItemRemoving
Event Type
ListViewItemCancelEventHandler

ItemValidating

Occurs when an edit operation needs to be validated before the changes are committed.

Declaration
public event ListViewItemValidatingEventHandler ItemValidating
Event Type
ListViewItemValidatingEventHandler

ItemValueChanged

Occurs when the value of a ListViewDataItem has changed.

Declaration
public event ListViewItemValueChangedEventHandler ItemValueChanged
Event Type
ListViewItemValueChangedEventHandler

ItemValueChanging

Occurs when the value of a ListViewDataItem is about to change and allows cancellation of the operation.

Declaration
public event ListViewItemValueChangingEventHandler ItemValueChanging
Event Type
ListViewItemValueChangingEventHandler

SelectedIndexChanged

Occurs when the index of the selected item has changed.

Declaration
public event EventHandler SelectedIndexChanged
Event Type
System.EventHandler

SelectedItemChanged

Occurs when the selected item has changed in the list view.

Declaration
public event EventHandler SelectedItemChanged
Event Type
System.EventHandler

SelectedItemChanging

Occurs when a ListViewDataItem is about to be selected and allows cancellation of the operation.

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

Occurs when a validation error occurs during item editing.

Declaration
public event EventHandler ValidationError
Event Type
System.EventHandler

ViewTypeChanged

Occurs when the ViewType of the RadListView has changed.

Declaration
public event EventHandler ViewTypeChanged
Event Type
System.EventHandler

ViewTypeChanging

Occurs when the ViewType of the RadListView is about to change and allows cancellation of the operation.

Declaration
public event ViewTypeChangingEventHandler ViewTypeChanging
Event Type
ViewTypeChangingEventHandler

VisualItemCreating

Occurs when a BaseListViewVisualItem needs to be created for visual representation.

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

Explicit Interface Implementations

IDataItemSource.MetadataChanged(PropertyDescriptor)

Handles metadata changes for property descriptors in the data source.

Declaration
void IDataItemSource.MetadataChanged(PropertyDescriptor pd)
Parameters
System.ComponentModel.PropertyDescriptor pd

The property descriptor that changed.
Implements
Remarks

This method is part of the IDataItemSource interface implementation and is called when the structure or metadata of the data source changes.

Extension Methods