ListView

Namespace: Wisej.Web

Assembly: Wisej.Framework (4.1.0.0)

• Control
  • ListView

Represents a list view control, which displays a collection of items that can be displayed using one of four different views.

C#

public class ListView : Control, IWisejDataStore

VB.NET

Public Class ListView
    Inherits Control
    Implements IWisejDataStore

Constructors

ListView()

Initializes a new instance of the ListView class.

Properties

AllowColumnReorder

Boolean: Returns or sets whether the user can drag column headers to reorder columns in the control. (Default: False)

AllowColumnSorting

Boolean: Returns or sets whether the user can sort columns by clicking on the header. (Default: False)

BorderStyle

BorderStyle: Returns or sets the border style of the control. (Default: Solid)

CheckBoxes

Boolean: Returns or sets whether a check box appears next to each item. (Default: False)

CheckedIndices

CheckedIndexCollection: Returns the indexes of the currently checked items in the control.

CheckedItems

CheckedListViewItemCollection: Returns the currently checked items in the control.

ColumnCount

Int32: Returns the number of columns without creating the columns collection.

Columns

ColumnHeaderCollection: Returns the collection of all column headers that appear in the control.

DataMember

String: Returns or sets the name of the list or table in the data source for which the ListView is displaying data. (Default: "")

DataSource

Object: Returns or sets the data source for this ListView. (Default: null)

Throws:

• ArgumentException The assigned value does not implement the IList or IListSource interfaces.

DefaultItemPadding

Padding: Returns the default value for the ItemPadding property.

DisplayPropertyName

String: Returns or sets the property to display in the Items. (Default: "")

FocusedItem

ListViewItem: Returns or sets the item that currently has the focus.

GridLines

Boolean: Returns or sets whether grid lines appear between the rows and columns containing the items and subitems in the control. (Default: True)

GridLineStyle

GridLineStyle: Returns or sets the cell border style for the ListView control when its View property is set to Details and the GridLines property is set to true. (Default: Vertical)

HeaderStyle

ColumnHeaderStyle: Returns or sets the column header style. (Default: Clickable)

HScroll

Boolean: Returns whether the horizontal scroll bar is visible.

IconPropertyName

String: Returns or sets the property to use as the icon for the Items. (Default: "")

ItemPadding

Padding: Returns or sets the padding inside ListViewItem objects in any View mode.

Items

ListViewItemCollection: Returns a collection containing all items in the control.

ItemSize

Size: Returns or sets the size of the items in the list view. If left empty (0, 0), the control uses the item size set in the current theme.

ItemSorter

IComparer<ListViewItem>: Returns or sets the sorting comparer for the control.

LabelEdit

Boolean: Returns or sets whether the user can edit the labels of items in the control. (Default: False)

LabelWrap

Boolean: Returns or sets whether the text in the ListViewItem item can wrap. (Default: False)

LargeImageList

ImageList: Returns or sets the ImageList to use to display the icon in the ListViewItem elements when the View is set to LargeIcon or Tile. (Default: null)

If LargeImageList is not set, Wisej will use SmallImageList and scale the icons.

LiveResize

Boolean: Returns or sets whether the column and row resizing should be updated as the user resizes the row or the column. (Default: False)

MultiSelect

Boolean: Returns or sets whether multiple items can be selected. (Default: False)

PrefetchItems

Int32: Returns or sets the number of items to prefetch outside of the visible area. The default is 0 (disabled). (Default: 0)

Setting the property PrefetchItems to a value greater than 0 allows the virtual view to prefetch the specified number of items outside of the visible area to enable smoother scrolling.

Scrollable

Boolean: Returns or sets whether a scroll bar is added to the control when there is not enough room to display all items. (Default: True)

SelectedIndex

Int32: Returns or sets the index of the focused ListViewItem.

SelectedIndices

SelectedIndexCollection: Returns the indexes of the selected items in the control.

SelectedItems

SelectedListViewItemCollection: Returns the items that are selected in the control.

SelectionMode

SelectionMode: Returns or sets the current selection mode determining how items are selected in the ListView. (Default: One)

When in Details view, the MultiSimple behaves as the MultiExtended. The DataGridView that renders the details view supports only the MultiSelect property true or false and uses the SelectionMode property to determine how elements of the grid are selected, which is always set to FullRowSelect when use inside the ListView.

ShowItemToolTips

Boolean: Returns or sets whether ToolTips are shown for the ListViewItem objects contained in the ListView. (Default: False)

SmallImageList

ImageList: Returns or sets the ImageList to use to display the icon in the ListViewItem elements when the View is set to SmallIcon or Details. (Default: null)

If SmallImageList is not set, Wisej will use LargeImageList and scale the icons.

SortedColumn

ColumnHeader: Returns the column by which the ListView contents are currently sorted.

Sorting

SortOrder: Returns or sets the sort order for items in the control. (Default: None)

SortOrder

SortOrder: Returns a value indicating whether the items in the ListView control are sorted in ascending or descending order, or are not sorted.

StateImageList

ImageList: Returns or sets the ImageList associated with states set for each ListViewItem. (Default: null)

Tools

ComponentToolCollection: Returns the collection of the ComponentTool items associated with this control.

ToolsPosition

Position: Returns or sets the position of the ComponentTool items associated with this control. (Default: Top)

View

View: Returns or sets how items are displayed in the control. (Default: LargeIcon)

VirtualListSize

Int32: Returns or sets the number of ListViewItem objects contained in the list when in virtual mode. (Default: 0)

Throws:

• ArgumentException VirtualListSize is set to a value less than 0.

VirtualMode

Boolean: Returns or sets whether you have provided your own data-management operations for the ListView control. (Default: False)

VScroll

Boolean: Returns whether the vertical scroll bar is visible.

Methods

Append(data, dataMember)

Populates the DataGridView from the data appending the rows to the existing rows.

Parameter	Type	Description
data	Object	The object that contains data for the ListView to display.
dataMember	String	The name of the table or list in the data object for which the DataGridView should load the items.

Returns: Int32. Numbers of items appended.

Use this method to fill a ListView without binding it to the data source.

AutoResizeColumn(columnIndex, headerAutoResize)

Resizes the width of the given column as indicated by the resize style.

Parameter	Type	Description
columnIndex	Int32	The zero-based index of the column to resize.
headerAutoResize	ColumnHeaderAutoResizeStyle	One of the ColumnHeaderAutoResizeStyle values.

Throws:

• ArgumentOutOfRangeException columnIndex is greater than 0 when Columns is null-or- columnIndex is less than 0 or greater than the number of columns set.

AutoResizeColumns(headerAutoResize)

Resizes the width of the columns as indicated by the resize style.

Parameter	Type	Description
headerAutoResize	ColumnHeaderAutoResizeStyle	One of the ColumnHeaderAutoResizeStyle values.

Throws:

• InvalidOperationException AutoResizeColumn is called with a value other than None when View is not set to Details.

BeginUpdate()

Prevents the control from updating until the EndUpdate method is called.

Clear()

Removes all items and columns from the control.

ClearSelection()

Clears the current selection.

CreateCellEditor()

Creates and returns a new control to be used as the cell editor.

Returns: Control. A Control instance that serves as the cell editor.

This method is intended to be overridden in a derived class to provide a custom cell editor. The returned control will be used to edit the value of a cell.

Dispose(disposing)

Disposes the control and all the owned columns.

Parameter	Type	Description
disposing	Boolean	true when this method is called by the application rather than a finalizer.

EndUpdate()

Resumes updating of the list view control after suspending it by the BeginUpdate method.

EnsureVisible(index)

Ensures that the specified item is visible within the control, scrolling the contents of the control if necessary.

Parameter	Type	Description
index	Int32	The zero-based index of the item to scroll into view.

Throws:

• ArgumentOutOfRangeException index is less than 0 or greater than the last item's index.

Fill(data, dataMember)

Populates the ListView from the data .

Parameter	Type	Description
data	Object	The object that contains data for the ListView to display.
dataMember	String	The name of the table or list in the data object for which the ListView should load the items.

Returns: Int32. Numbers of items added.

Use this method to fill a ListView without binding it to the data source.

FindItemWithText(text)

Finds the first ListViewItem that begins with the specified text value.

Parameter	Type	Description
text	String	The text to search for.

Returns: ListViewItem. The first ListViewItem that begins with the specified text value.

FindItemWithText(text, includeSubItemsInSearch, startIndex)

Finds the first ListViewItem or ListViewSubItem, if indicated, that begins with the specified text value. The search starts at the specified index.

Parameter	Type	Description
text	String	The text to search for.
includeSubItemsInSearch	Boolean	true to include sub-items in the search; otherwise, false.
startIndex	Int32	The index of the item at which to start the search.

Returns: ListViewItem. The first ListViewItem that begins with the specified text value.

Throws:

• ArgumentOutOfRangeException startIndex is less 0 or more than the number items in the ListView.

FindItemWithText(text, includeSubItemsInSearch, startIndex, isPrefixSearch)

Finds the first ListViewItem or ListViewSubItem, if indicated, that begins with the specified text value. The search starts at the specified index.

Parameter	Type	Description
text	String	The text to search for.
includeSubItemsInSearch	Boolean	true to include sub-items in the search; otherwise, false.
startIndex	Int32	The index of the item at which to start the search.
isPrefixSearch	Boolean	true to allow partial matches; otherwise, false.

Returns: ListViewItem. The first ListViewItem that begins with the specified text value.

Throws:

• ArgumentOutOfRangeException startIndex is less than 0 or more than the number of items in the ListView.

IsValidColumn(colIndex)

Verifies that the column index refer to a valid column.

Parameter	Type	Description
colIndex	Int32	The index of the column to verify.

Returns: Boolean. true if the column index corresponds to a valid column.

OnAddReferences(list)

Returns a collection of referenced components or collection of components.

Parameter	Type	Description
list	IList

OnAfterLabelEdit(e)

Fires the AfterLabelEdit event.

Parameter	Type	Description
e	LabelEditEventArgs	A LabelEditEventArgs that contains the event data.

OnBeforeLabelEdit(e)

Fires the BeforeLabelEdit event.

Parameter	Type	Description
e	LabelEditEventArgs	A LabelEditEventArgs that contains the event data.

OnBindingContextChanged(e)

Fires the BindingContextChanged event.

Parameter	Type	Description
e	EventArgs	A EventArgs that contains the event data.

OnCacheVirtualItems(e)

Fires the CacheVirtualItems event.

Parameter	Type	Description
e	CacheVirtualItemsEventArgs	A CacheVirtualItemsEventArgs that contains the event data.

OnColumnClick(e)

Fires the ColumnClick event.

Parameter	Type	Description
e	ColumnClickEventArgs	A ColumnClickEventArgs that contains the event data.

OnColumnDoubleClick(e)

Fires the ColumnDoubleClick event.

Parameter	Type	Description
e	ColumnClickEventArgs	A ColumnClickEventArgs that contains the event data.

OnColumnReordered(e)

Fires the ColumnReordered event.

Parameter	Type	Description
e	ColumnReorderedEventArgs	The ColumnReorderedEventArgs that contains the event data.

OnColumnWidthChanged(e)

Fires the ColumnWidthChanged event.

Parameter	Type	Description
e	ColumnWidthChangedEventArgs	A ColumnWidthChangedEventArgs that contains the event data.

OnDataBindingComplete(e)

Fires the DataBindingComplete event.

Parameter	Type	Description
e	ListViewBindingCompleteEventArgs	A ListViewBindingCompleteEventArgs that contains the event data.

OnDataMemberChanged(e)

Fires the DataMemberChanged event.

Parameter	Type	Description
e	EventArgs	An EventArgs that contains the event data.

OnDataSourceChanged(e)

Fires the DataSourceChanged event.

Parameter	Type	Description
e	EventArgs	A EventArgs that contains the event data.

OnDataUpdated(e)

Fires the DataUpdated event.

Parameter	Type	Description
e	ListViewDataUpdatedEventArgs	A ListViewDataUpdatedEventArgs that contains the event data.

OnItemCheck(e)

Fires the ItemCheck event.

Parameter	Type	Description
e	ItemCheckEventArgs	An ItemCheckEventArgs that contains the event data.

OnItemChecked(e)

Fires the ItemChecked event.

Parameter	Type	Description
e	ItemCheckedEventArgs	An ItemCheckedEventArgs that contains the event data.

OnItemClick(e)

Fires the ItemClick event.

Parameter	Type	Description
e	ItemClickEventArgs	A ItemClickEventArgs that contains the event data.

OnItemDoubleClick(e)

Fires the ItemDoubleClick event.

Parameter	Type	Description
e	ItemClickEventArgs	A ItemClickEventArgs that contains the event data.

OnItemDrag(e)

Fires the ItemDrag event.

Parameter	Type	Description
e	ListViewItemDragEventArgs	An ItemDragEventArgs that contains the event data.

OnItemMouseHover(e)

Fires the ItemMouseHover event.

Parameter	Type	Description
e	ItemMouseHoverEventArgs	A ItemMouseHoverEventArgs that contains the event data.

OnItemMouseLeave(e)

Fires the ItemMouseLeave event.

Parameter	Type	Description
e	ItemMouseHoverEventArgs	A ItemMouseHoverEventArgs that contains the event data.

OnItemSelectionChanged(e)

Fires the ItemSelectionChanged event.

Parameter	Type	Description
e	ItemSelectionChangedEventArgs	A ItemSelectionChangedEventArgs that contains the event data.

OnKeyDown(e)

Fires the KeyDown event.

Parameter	Type	Description
e	KeyEventArgs	A KeyEventArgs that contains the event data.

OnMouseUp(e)

Fires the MouseUp event.

Parameter	Type	Description
e	MouseEventArgs	A MouseEventArgs that contains the event data.

OnRetrieveVirtualItem(e)

Fires the RetrieveVirtualItem event.

Parameter	Type	Description
e	RetrieveVirtualItemEventArgs	A RetrieveVirtualItemEventArgs that contains the event data.

OnScroll(e)

Fires the Scroll event.

Parameter	Type	Description
e	ScrollEventArgs	A ScrollEventArgs that contains the event data.

This event fires only if there is an handler attached to it. A simple overload of the On[Event] method in a derived class will not be invoked unless there is at least one handler attached to the event.

OnSearchForVirtualItem(e)

Fires the SearchForVirtualItem event.

Parameter	Type	Description
e	SearchForVirtualItemEventArgs	A SearchForVirtualItemEventArgs that contains the event data.

OnSelectedIndexChanged(e)

Fires the SelectedIndexChanged event.

Parameter	Type	Description
e	EventArgs	An EventArgs that contains the event data.

OnToolClick(e)

Fires the ToolClick event.

Parameter	Type	Description
e	ToolClickEventArgs	A ToolClickEventArgs that contains the event data.

OnVirtualItemsSelectionRangeChanged(e)

Fires the VirtualItemsSelectionRangeChanged event.

Parameter	Type	Description
e	ListViewVirtualItemsSelectionRangeChangedEventArgs	A ListViewVirtualItemsSelectionRangeChangedEventArgs that contains the event data.

OnWebDataCount()

Returns the number of available data rows.

Returns: Int32.

OnWebDataRead(firstIndex, lastIndex, sortDirection, sortIndex)

Returns the data requested by the client.

Parameter	Type	Description
firstIndex	Int32	The index of the first requested row.
lastIndex	Int32	The index of the last requested row.
sortDirection	ListSortDirection	The sort direction.
sortIndex	Int32	The index of the sorted column. Can be -1 if there is no sorted column.

Returns: Object.

OnWebEvent(e)

Processes the event from the client.

Parameter	Type	Description
e	WisejEventArgs	Event arguments.

OnWebRender(config)

Renders the client component.

Parameter	Type	Description
config	Object	Dynamic configuration object.

OnWebUpdate(state)

Updates the client component using the state information.

Parameter	Type	Description
state	Object	Dynamic state object.

Refresh()

Forces a full reload of the data displayed by this ListView.

Refresh(refreshChildren)

Forces a full reload of the data displayed by this ListView.

Parameter	Type	Description
refreshChildren	Boolean	True to also refresh all the children of this control.

RefreshItem(index)

Resynchronizes the item data with the contents of the data source.

Parameter	Type	Description
index	Int32

RefreshItems()

Resynchronizes the item data with the contents of the data source.

ScrollColumnIntoView(column)

Scrolls the specified column into view.

Parameter	Type	Description
column	ColumnHeader	The ColumnHeaderto scroll into view.

Throws:

• ArgumentNullException column is null.
• ArgumentException column belong to a different ListView.

ScrollItemIntoView(item)

Scrolls the specified item into view.

Parameter	Type	Description
item	ListViewItem	The item to scroll into view.

Throws:

• ArgumentNullException item is null.
• ArgumentException item belong to a different ListView.

SelectAll()

Selects all items in the ListView.

Sort(comparison)

Sorts the items of the list view.

Parameter	Type	Description
comparison	Comparison<ListViewItem>	The comparison expression to use when sorting the items. It's optional - if not specified or null, the ItemSorter instance or a default internal comparer is used to compare the items and sort the list.

Update()

Causes the control to update the corresponding client side widget. When in design mode, causes the rendered control to update its entire surface in the designer.

Events

AfterLabelEdit

LabelEditEventHandler Fired when the label for an item is edited by the user.

BeforeLabelEdit

LabelEditEventHandler Fired when the user starts editing the label of an item.

CacheVirtualItems

CacheVirtualItemsEventHandler Fired when the contents of the display area for a ListView in virtual mode has changed, and the ListView determines that a new range of items is needed.

ColumnClick

ColumnClickEventHandler Fired when the user clicks a column header within the list view control.

ColumnDoubleClick

ColumnClickEventHandler Fired when the user double clicks a column header within the list view control.

ColumnReordered

ColumnReorderedEventHandler Fired when the column header order is changed.

ColumnWidthChanged

ColumnWidthChangedEventHandler Fired after the width of a column is successfully changed .

DataBindingComplete

ListViewBindingCompleteEventEventHandler Occurs after a data-binding operation has finished.

DataMemberChanged

EventHandler Fired when value of the DataMember property changes.

DataSourceChanged

EventHandler Fired when the DataSource property changes.

DataUpdated

ListViewDataUpdatedEventHandler Fired when the client has updated one or more items in the view.

This event is fired only if the application has attached at least one handler to the event. Otherwise, simply overriding OnDataUpdated won't work.

ItemCheck

ItemCheckEventHandler Fired when the check state of an item changes.

ItemChecked

ItemCheckedEventHandler Fired when the checked state of an item changes.

ItemClick

ItemClickEventHandler Fired when the item is clicked or tapped.

ItemDoubleClick

ItemClickEventHandler Fired when the item is double clicked or tapped.

ItemDrag

ListViewItemDragEventHandler Fired when the user begins dragging a ListViewItem.

ItemMouseHover

ItemMouseHoverEventHandler Fired when the pointer hovers over an item.

ItemMouseLeave

ItemMouseHoverEventHandler Fired when the pointer leaves an item.

ItemSelectionChanged

ItemSelectionChangedEventHandler Fired when the selection state of an item changes.

RetrieveVirtualItem

RetrieveVirtualItemEventHandler Fired when the ListView is in virtual mode and requires a ListViewItem.

Throws:

• InvalidOperationException The Item property is not set to an item when the RetrieveVirtualItem event is handled.

Scroll

ScrollEventHandler Fired when the user or code scrolls the ListView.

This event fires only if there is an handler attached to it. A simple overload of the On[Event] method in a derived class will not be invoked unless there is at least one handler attached to the event.

SearchForVirtualItem

SearchForVirtualItemEventHandler Fired when the ListView is in virtual mode and a search is requested.

SelectedIndexChanged

EventHandler Fired when the SelectedIndices collection changes.

ToolClick

ToolClickEventHandler Fired when a ComponentTool is clicked.

VirtualItemsSelectionRangeChanged

ListViewVirtualItemsSelectionRangeChangedEventHandler Fired when a ListView is in virtual mode and the selection state of a range of items has changed.

Implements

Name	Description
IUserData	Provides access to the UserData and Tag properties associated to the component implementing this interface.
IBindableComponent	Bindable components implement this interface.
IDropTarget	Controls that support drag & drop operations implement this interface.
IWisejComponent	All wisej components implement this interface.
IWisejControl	All wisej controls derived from the Control class must implement this interface.
IWisejDataStore	All wisej data stores implement this interface.
IWisejSerializable	Allows an object to serialize itself.