Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Wisej.Web.ColumnClickEventArgs
Namespace: Wisej.Web
Assembly: Wisej.Framework (4.0.0.0)
Provides data for the ColumnClick event.
Initializes a new instance of the ColumnClickEventArgs class.
column
The zero-based index of the column that is clicked.
Initializes a new instance of the ColumnClickEventArgs class.
column
The zero-based index of the column that is clicked.
button
clicks
The number of times a mouse button was pressed.
MouseButtons: Returns which mouse button was pressed.
Int32: Returns the number of clicks or taps.
Int32: Returns the zero-based index of the column that is clicked.
Wisej.Web.CacheVirtualItemsEventArgs
Namespace: Wisej.Web
Assembly: Wisej.Framework (4.0.0.0)
Provides data for the CacheVirtualItems event.
Initializes a new instance of the CacheVirtualItemsEventArgs class with the specified starting and ending indices.
startIndex
endIndex
Int32: Returns the ending index for the range of values needed by a ListView control in virtual mode.
Int32: Returns the starting index for a range of values needed by a ListView control in virtual mode.
Wisej.Web.ListView
Namespace: Wisej.Web
Assembly: Wisej.Framework (4.0.0.0)
Represents a list view control, which displays a collection of items that can be displayed using one of four different views.
Initializes a new instance of the ListView class.
Boolean: Returns or sets whether the user can drag column headers to reorder columns in the control. (Default: False
)
Boolean: Returns or sets whether the user can sort columns by clicking on the header. (Default: False
)
BorderStyle: Returns or sets the border style of the control. (Default: Solid
)
Boolean: Returns or sets whether a check box appears next to each item. (Default: False
)
CheckedIndexCollection: Returns the indexes of the currently checked items in the control.
CheckedListViewItemCollection: Returns the currently checked items in the control.
Int32: Returns the number of columns without creating the columns collection.
ColumnHeaderCollection: Returns the collection of all column headers that appear in the control.
CurrencyManager: Returns the CurrencyManager associated with this control.
String: Returns or sets the name of the list or table in the data source for which the ListView is displaying data. (Default: ""
)
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.
Padding: Returns the default value for the ItemPadding property.
Int32: Returns or sets the index of the property bound to ListViewItem.Text.
String: Returns or sets the property to display in the Items. (Default: ""
)
ListViewItem: Returns or sets the item that currently has the focus.
Boolean: Returns or sets whether grid lines appear between the rows and columns containing the items and subitems in the control. (Default: True
)
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
)
ColumnHeaderStyle: Returns or sets the column header style. (Default: Clickable
)
Boolean: Returns whether the horizontal scroll bar is visible.
Int32: Returns or sets the index of the property bound to ListViewItem.Text.
String: Returns or sets the property to use as the icon for the Items. (Default: ""
)
Boolean: Returns true if the ListView is currently in the middle of adding items from a data source.
Boolean: Returns true if the ListView is currently in the middle of returning rows to a data store request.
Boolean: Returns true if the ListView is currently in the middle of sorting the data collection.
Boolean: Returns true if the ListView is bound to a data source.
Boolean: Returns if BeginUpdate is in effect.
Int32: Returns the number of items in the control.
Padding: Returns or sets the padding inside ListViewItem objects in any View mode.
ListViewItemCollection: Returns a collection containing all items in the control.
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.
IComparer<ListViewItem>: Returns or sets the sorting comparer for the control.
Boolean: Returns or sets whether the user can edit the labels of items in the control. (Default: False
)
Boolean: Returns or sets whether the text in the ListViewItem item can wrap. (Default: False
)
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.
ImagePropertySettings: Creates the property manager for the Image properties on first use.
Boolean: Returns or sets whether the column and row resizing should be updated as the user resizes the row or the column. (Default: False
)
Boolean: Returns or sets whether multiple items can be selected. (Default: False
)
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.
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
)
Int32: Returns or sets the index of the focused ListViewItem.
SelectedIndexCollection: Returns the indexes of the selected items in the control.
SelectedListViewItemCollection: Returns the items that are selected in the control.
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.
Boolean: Returns or sets whether ToolTips are shown for the ListViewItem objects contained in the ListView. (Default: False
)
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.
ImagePropertySettings: Creates the property manager for the Image properties on first use.
ColumnHeader: Returns the column by which the ListView contents are currently sorted.
SortOrder: Returns or sets the sort order for items in the control. (Default: None
)
SortOrder: Returns a value indicating whether the items in the ListView control are sorted in ascending or descending order, or are not sorted.
ImageList: Returns or sets the ImageList associated with states set for each ListViewItem. (Default: null
)
ImagePropertySettings: Creates the property manager for the Image properties on first use.
ComponentToolCollection: Returns the collection of the ComponentTool items associated with this control.
Position: Returns or sets the position of the ComponentTool items associated with this control. (Default: Top
)
View: Returns or sets how items are displayed in the control. (Default: LargeIcon
)
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.
Boolean: Returns or sets whether you have provided your own data-management operations for the ListView control. (Default: False
)
Boolean: Returns whether the vertical scroll bar is visible.
Populates the DataGridView from the data appending the rows to the existing rows.
data
Returns: Int32. Numbers of items appended.
Use this method to fill a ListView without binding it to the data source.
Resizes the width of the given column as indicated by the resize style.
columnIndex
The zero-based index of the column to resize.
headerAutoResize
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.
Resizes the width of the columns as indicated by the resize style.
headerAutoResize
Throws:
InvalidOperationException AutoResizeColumn is called with a value other than None when View is not set to Details.
item
Prevents the control from updating until the EndUpdate method is called.
bindingMemberInfo
Returns: Boolean.
Removes all items and columns from the control.
Clears the current selection.
Disposes the control and all the owned columns.
disposing
true when this method is called by the application rather than a finalizer.
Resumes updating of the list view control after suspending it by the BeginUpdate method.
Ensures that the specified item is visible within the control, scrolling the contents of the control if necessary.
index
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.
Populates the ListView from the data .
data
Returns: Int32. Numbers of items added.
Use this method to fill a ListView without binding it to the data source.
Finds the first ListViewItem that begins with the specified text value.
text
The text to search for.
Returns: ListViewItem. The first ListViewItem that begins with the specified text value.
Finds the first ListViewItem or ListViewSubItem, if indicated, that begins with the specified text value. The search starts at the specified index.
text
The text to search for.
includeSubItemsInSearch
true to include sub-items in the search; otherwise, false.
startIndex
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.
Finds the first ListViewItem or ListViewSubItem, if indicated, that begins with the specified text value. The search starts at the specified index.
text
The text to search for.
includeSubItemsInSearch
true to include sub-items in the search; otherwise, false.
startIndex
The index of the item at which to start the search.
isPrefixSearch
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.
item
Returns: Image.
item
Returns: String.
item
Returns: String.
subItem
Returns: String.
index
Returns: BitState32.
Verifies that the column index refer to a valid column.
colIndex
The index of the column to verify.
Returns: Boolean. true if the column index corresponds to a valid column.
Maps the data source name with the data connection manager.
propertyName
Returns: Int32.
Returns a collection of referenced components or collection of components.
items
Fires the AfterLabelEdit event.
e
Fires the BeforeLabelEdit event.
e
Fires the BindingContextChanged event.
e
Fires the CacheVirtualItems event.
e
Fires the ColumnClick event.
e
Fires the ColumnDoubleClick event.
e
header
newIndex
oldIndex
header
Fires the ColumnReordered event.
e
Fires the ColumnWidthChanged event.
e
Fires the DataBindingComplete event.
e
Fires the DataMemberChanged event.
e
Fires the DataSourceChanged event.
e
Fires the DataUpdated event.
e
index
item
Fires the ItemCheck event.
e
Fires the ItemChecked event.
e
item
item
value
Returns: Boolean.
Fires the ItemClick event.
e
Fires the ItemDoubleClick event.
e
Fires the ItemDrag event.
e
Fires the ItemMouseHover event.
e
Fires the ItemMouseLeave event.
e
item
hidden
item
Fires the ItemSelectionChanged event.
e
item
Fires the KeyDown event.
e
Fires the MouseUp event.
e
Fires the RetrieveVirtualItem event.
e
Fires the Scroll event.
e
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.
Fires the SearchForVirtualItem event.
e
Fires the SelectedIndexChanged event.
e
Fires the ToolClick event.
e
Fires the VirtualItemsSelectionRangeChanged event.
e
Returns the number of available data rows.
Returns: Int32.
Returns the data requested by the client.
firstIndex
The index of the first requested row.
lastIndex
The index of the last requested row.
sortDirection
The sort direction.
sortIndex
The index of the sorted column. Can be -1 if there is no sorted column.
Returns: Object.
Processes the event from the client.
e
Event arguments.
Renders the client component.
config
Dynamic configuration object.
Updates the client component using the state information.
state
Dynamic state object.
item
Forces a full reload of the data displayed by this ListView.
Forces a full reload of the data displayed by this ListView.
refreshChildren
True to also refresh all the children of this control.
Resynchronizes the item data with the contents of the data source.
index
Resynchronizes the item data with the contents of the data source.
Scrolls the specified column into view.
column
Throws:
ArgumentNullException column is null.
ArgumentException column belong to a different ListView.
Scrolls the specified item into view.
item
The item to scroll into view.
Throws:
ArgumentNullException item is null.
ArgumentException item belong to a different ListView.
Selects all items in the ListView.
item
text
subItem
text
index
flag
value
notify
Sorts the items of the list view.
index
Returns: Int32.
index
Returns: Int32.
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.
LabelEditEventHandler Fired when the label for an item is edited by the user.
LabelEditEventHandler Fired when the user starts editing the label of an item.
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.
ColumnClickEventHandler Fired when the user clicks a column header within the list view control.
ColumnClickEventHandler Fired when the user double clicks a column header within the list view control.
ColumnReorderedEventHandler Fired when the column header order is changed.
ColumnWidthChangedEventHandler Fired after the width of a column is successfully changed .
ListViewBindingCompleteEventEventHandler Occurs after a data-binding operation has finished.
EventHandler Fired when value of the DataMember property changes.
EventHandler Fired when the DataSource property changes.
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.
ItemCheckEventHandler Fired when the check state of an item changes.
ItemCheckedEventHandler Fired when the checked state of an item changes.
ItemClickEventHandler Fired when the item is clicked or tapped.
ItemClickEventHandler Fired when the item is double clicked or tapped.
ListViewItemDragEventHandler Fired when the user begins dragging a ListViewItem.
ItemMouseHoverEventHandler Fired when the pointer hovers over an item.
ItemMouseHoverEventHandler Fired when the pointer leaves an item.
ItemSelectionChangedEventHandler Fired when the selection state of an item changes.
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.
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.
SearchForVirtualItemEventHandler Fired when the ListView is in virtual mode and a search is requested.
EventHandler Fired when the SelectedIndices collection changes.
ToolClickEventHandler Fired when a ComponentTool is clicked.
ListViewVirtualItemsSelectionRangeChangedEventHandler Fired when a ListView is in virtual mode and the selection state of a range of items has changed.
Provides access to the UserData
and Tag
properties associated to the component implementing this interface.
Bindable components implement this interface.
Controls that support drag & drop operations implement this interface.
All wisej components implement this interface.
All wisej data stores implement this interface.
Allows an object to serialize itself.
Wisej.Web.CacheVirtualItemsEventHandler
Namespace: Wisej.Web
Assembly: Wisej.Framework (4.0.0.0)
Represents the method that will handle the CacheVirtualItems event of a ListView.
sender
The source of the event.
e
A that contains the event data.
Fired when the contents of the display area for a in virtual mode has changed, and the determines that a new range of items is needed.
Wisej.Web.ColumnClickEventHandler
Namespace: Wisej.Web
Assembly: Wisej.Framework (4.0.0.0)
Represents the method that will handle the ColumnClick event of a ListView.
sender
The source of the event.
e
A that contains the event data.
Fired when the user clicks a column header within the list view control.
Fired when the user double clicks a column header within the list view control.
One of the values that indicate which mouse button was pressed.
Represents the method that will handle the event of a .
The starting index of a range of items needed by the for the next event that occurs.
The ending index of a range of items needed by the for the next event that occurs.
Represents the method that will handle the event of a .
The object that contains data for the to display.
dataMember
The name of the table or list in the data object for which the should load the items.
One of the values.
One of the values.
The object that contains data for the to display.
dataMember
The name of the table or list in the data object for which the should load the items.
dataIndexOffset
dataIndexOffset
dataIndexOffset
A that contains the event data.
A that contains the event data.
A that contains the event data.
A that contains the event data.
A that contains the event data.
A that contains the event data.
The that contains the event data.
A that contains the event data.
A that contains the event data.
An that contains the event data.
A that contains the event data.
A that contains the event data.
An that contains the event data.
An that contains the event data.
A that contains the event data.
A that contains the event data.
An that contains the event data.
A that contains the event data.
A that contains the event data.
A that contains the event data.
A that contains the event data.
A that contains the event data.
A that contains the event data.
A that contains the event data.
A that contains the event data.
An that contains the event data.
A that contains the event data.
A that contains the event data.
The to scroll into view.
item
comparison
The comparison expression to use when sorting the items. It's optional - if not specified or null, the instance or a default internal comparer is used to compare the items and sort the list.
All wisej controls derived from the class must implement this interface.
Wisej.Web.ColumnHeaderAutoResizeStyle
Namespace: Wisej.Web
Assembly: Wisej.Framework (4.0.0.0)
Specifies how a column contained in a ListView should be resized.
ColumnContent
Specifies the column should be resized based on the size of the column content.
HeaderAndColumnContent
Specifies the column should be resized based on the size of the column header content and on the size of the column content.
HeaderSize
Specifies the column should be resized based on the size of the column header content.
None
Specifies no resizing should occur.
Resizes the width of the column as indicated by the resize style.
Resizes the width of the given column as indicated by the resize style.
Resizes the width of the columns as indicated by the resize style.
Wisej.Web.ColumnWidthChangedEventArgs
Namespace: Wisej.Web
Assembly: Wisej.Framework (4.0.0.0)
Provides data for the ColumnWidthChanged event.
Initializes a new instance of the ColumnWidthChangedEventArgs class.
columnIndex
The index of the column whose width is being changed.
Int32: Returns the column index for the column whose width is being changed.
Wisej.Web.ColumnWidthChangedEventHandler
Namespace: Wisej.Web
Assembly: Wisej.Framework (4.0.0.0)
Represents the method that will handle the ColumnWidthChanged event of a ListView.
sender
The source of the event.
e
A that contains the event data.
Fired after the width of a column is successfully changed .
Wisej.Web.ColumnReorderedEventArgs
Namespace: Wisej.Web
Assembly: Wisej.Framework (4.0.0.0)
Provides data for the ColumnReordered event.
Initializes a new instance of the ColumnReorderedEventArgs class.
oldDisplayIndex
newDisplayIndex
header
ColumnHeader: Returns the ColumnHeader that is being reordered.
Int32: Returns the new display position of the ColumnHeader
Int32: Returns the previous display position of the ColumnHeader.
Wisej.Web.ColumnHeaderStyle
Namespace: Wisej.Web
Assembly: Wisej.Framework (4.0.0.0)
Determines the styles of the column headers in a ListView control.
Clickable
The column headers can be clicked and can carry out an action, such as sorting, when clicked.
NonClickable
The column headers are not clickable.
None
The column header is not visible when in details view.
Returns or sets the column header style.
Wisej.Web.ColumnHeader
Namespace: Wisej.Web
Assembly: Wisej.Framework (4.0.0.0)
Displays a standard column header in a ListView control.
Initializes a new instance of the ColumnHeader class.
Initializes a new instance of the ColumnHeader class with the image specified.
imageIndex
Initializes a new instance of the ColumnHeader class with the image specified.
imageKey
Boolean: Returns or sets whether the ellipsis character (...) appears at the right edge of the header text when the View property is set to Details. (Default: True
)
Color: Returns or sets the background color for the ColumnHeader. (Default: Color [Empty]
)
The default is Empty to use the current theme's color set in "table-scroller/header/default/properties/backgroundColor".
String: Returns the name of the default cell renderer to use on the client side to render the cells that belong to this column. If it's null or empty it defaults to "Cell". (Default: null
)
The name of the cell renderer can be a fully qualified class name (i.e. "wisej.web.datagrid.cellRenderer.Cell") or just the class name (i.e. "ImageCell") in which case the client library prepends "wisej.web.datagrid.cellRenderer".
ContextMenu: Returns or sets the shortcut menu associated with the column header. (Default: null
)
Control: Returns or sets a child control to display inside the cell.
Int32: Returns or sets the index of the property bound to ListViewItem.Text.
Int32: Returns or sets the display order of the column relative to the currently displayed columns.
Throws:
ArgumentOutOfRangeException The value is less than 0 or greater than or equal to the value of the ColumnCount property.
String: Returns or sets the property to display in the Items. (Default: ""
)
Color: Returns or sets the text color of the ColumnHeader. (Default: Color [Empty]
)
The default is Empty to use the current theme's color set in "table-scroller/header/default/properties/textColor".
Boolean: Check if the component defines any responsive profile without forcing the creation of the collection.
Image: Returns or sets the image that is displayed in a ColumnHeader control.
Int32: Returns or sets the index of the image displayed in the ColumnHeader. (Default: -1
)
Throws:
ArgumentOutOfRangeException The specified index is less than -1.
String: Returns or sets the key of the image displayed in the ColumnHeader. (Default: ""
)
ImageList: Returns the image list associated with the ColumnHeader.
String: Returns or sets the theme name or URL for the image to display in the ColumnHeader control.
Int32: Returns the location of this ColumnHeader within the ListView control's ColumnHeaderCollection.
ListView: Returns the ListView control the ColumnHeader is located in.
Int32: Returns or sets the maximum width, in pixels, of the column. (Default: 32000
)
Throws:
ArgumentOutOfRangeException The value is less than 0 or greater than 32000.
Int32: Returns or sets the minimum width, in pixels, of the column. (Default: 20
)
Throws:
ArgumentOutOfRangeException The value is less than 0 or greater than 32000.
Boolean: Returns or sets whether the column header can be moved by the user. (Default: True
)
String: Returns or sets the name of the ColumnHeader.
Boolean: Returns or sets whether the column header can be resized by the user. (Default: True
)
Boolean: Returns or sets whether the column can be sorted by clicking on the header. (Default: True
)
SortOrder: Returns or sets the type of sort glyph to display in the column header. (Default: None
)
Object: Returns or sets an object that contains data to associate with the ColumnHeader. (Default: null
)
String: Returns or sets the text displayed in the column header. (Default: ""
)
HorizontalAlignment: Returns or sets the horizontal alignment of the text displayed in the ColumnHeader. (Default: Left
)
Boolean: Returns or sets whether the column is visible when the control is in Details view. (Default: True
)
Int32: Returns or sets the width of the column. (Default: 60
)
Resizes the width of the column as indicated by the resize style.
headerAutoResize
Creates an identical copy of the current ColumnHeader that is not attached to any list view control.
Returns: Object. An object representing a copy of this ColumnHeader object.
Disposes this ColumnHeader instance.
disposing
true when this method is called by the application rather than a finalizer.
Returns a collection of referenced components or collection of components.
list
List of referenced components or collection of components.
Renders the client component.
config
Dynamic configuration object.
Updates the component on the client.
Provides access to the UserData
and Tag
properties associated to the component implementing this interface.
Provides access to common image properties across the controls that implement this interface.
All wisej components implement this interface.
Allows an object to serialize itself.
Wisej.Web.ColumnReorderedEventHandler
Namespace: Wisej.Web
Assembly: Wisej.Framework (4.0.0.0)
Represents the method that will handle the ColumnReordered event of the ListView control.
sender
The source of the event.
e
A that contains the event data.
Fired when the column header order is changed.
Wisej.Web.ItemSelectionChangedEventHandler
Namespace: Wisej.Web
Assembly: Wisej.Framework (4.0.0.0)
Represents the method that will handle the ItemSelectionChanged event of a ListView.
sender
The source of the event.
e
An that contains the event data.
Fired when the selection state of an item changes.
Wisej.Web.ItemClickEventHandler
Namespace: Wisej.Web
Assembly: Wisej.Framework (4.0.0.0)
Represents the method that will handle the ItemClick event of a ListView.
sender
The source of the event.
e
A that contains the event data.
Fired when the item is clicked or tapped.
Fired when the item is double clicked or tapped.
Wisej.Web.ItemCheckedEventArgs
Namespace: Wisej.Web
Assembly: Wisej.Framework (4.0.0.0)
Provides data for the ItemChecked event of the ListView control.
Initializes a new instance of the ItemCheckedEventArgs class.
item
ListViewItem: Returns the ListViewItem whose checked state is changing.
Wisej.Web.ItemCheckedEventHandler
Namespace: Wisej.Web
Assembly: Wisej.Framework (4.0.0.0)
Represents the method that will handle the ItemChecked event of a ListView control.
sender
The source of the event
e
A that contains the event data.
Fired when the checked state of an item changes.
Wisej.Web.ImageColumnHeader
Namespace: Wisej.Web
Assembly: Wisej.Framework (4.0.0.0)
Displays an image column header in a ListView control.
The value of the items displayed under the ImageColumnHeader are displayed as either an image name or an image URL.
Initializes a new instance of the ImageColumnHeader class.
Provides access to the UserData
and Tag
properties associated to the component implementing this interface.
Provides access to common image properties across the controls that implement this interface.
All wisej components implement this interface.
Allows an object to serialize itself.
Wisej.Web.ItemClickEventArgs
Namespace: Wisej.Web
Assembly: Wisej.Framework (4.0.0.0)
Provides data for the ItemClick event.
Initializes a new instance of the ItemClickEventArgs class.
item
button
clicks
The number of times a mouse button was pressed.
ListViewItem: Returns the item that was clicked or tapped.
Wisej.Web.ItemMouseHoverEventArgs
Wisej.Web.LabelEditEventArgs
Namespace: Wisej.Web
Assembly: Wisej.Framework (4.0.0.0)
Provides data for the and events.
Initializes a new instance of the class with the specified index to the to edit or edited.
Initializes a new instance of the class with the specified index to the being edited and the new text for the label of the .
Wisej.Web.ItemSelectionChangedEventArgs
Namespace: Wisej.Web
Assembly: Wisej.Framework (4.0.0.0)
Provides data for the event.
Initializes a new instance of the class.
: Returns a value indicating whether the item's state has changed to selected.
Wisej.Web.ListView SelectedListViewItemCollection
Namespace: Wisej.Web
Assembly: Wisej.Framework (4.0.0.0)
Represents the collection that contains the selected items in a control.
Initializes a new instance of the class.
: Returns the number of items in the collection.
: Returns whether the collection is read-only.
Throws:
Throws:
Clears the selection.
Determines whether the specified item is located in the collection.
Determines if an item with the specified key is contained in the collection.
Returns an enumerator that can be used to iterate through the checked index collection.
Determines the index of an item with the specified key.
Wisej.Web.ListView SelectedIndexCollection
Namespace: Wisej.Web
Assembly: Wisej.Framework (4.0.0.0)
Represents the collection that contains the indexes to the selected items in a control.
Initializes a new instance of the class.
: Returns the number of items in the collection.
: Returns whether the collection is read-only.
Throws:
Throws:
Clears the selection.
Determines whether the specified index is located in the collection.
Copies the list of selected indexes into the specified array starting at the specified index .
Returns an enumerator that can be used to iterate through the selected index collection.
Throws:
Wisej.Web.ListView ListViewItemCollection
Namespace: Wisej.Web
Assembly: Wisej.Framework (4.0.0.0)
Represents the collection of items in a control.
: Returns the total number of items in the collection.
: Returns a value indicating whether the collection is read-only.
: Returns or sets the item at the specified index in the collection.
Throws:
The index value is less than 0 or is greater than the number of items in the collection.
Adds a new item with the specified label text to the end of the current collection.
Creates a new item with the specified key and text, and adds it to the collection.
Creates a new item with the specified key, text, and image, and adds it to the collection.
Creates a new item with the specified key, text, and image, and adds it to the collection.
Adds a previously created item to the end of the collection.
Throws:
Adds an array of previously created items to the collection.
Throws:
Adds an array of previously created items objects to the collection.
Throws:
Removes all items from the collection.
Removes all items from the collection and optionally disposes them.
Determines whether the specified item is a member of the collection.
Determines whether the collection contains an item with the specified key.
Copies the entire collection into an existing array at a specified location within the array.
Returns an enumerator that can be used to iterate through the collection.
Returns the index of the specified item in the collection.
Returns the index of the first occurrence of a item with the specified key.
Inserts an existing item into the collection at the specified location.
Throws:
Creates a new item with the specified text and inserts it at the specified index.
Creates a new item with the specified text and key, and inserts it into the collection.
Creates a new item with the specified key, text, and image, and inserts it into the collection at the specified index.
Creates a new item with the specified key, text, and image, and inserts it into the collection at the specified index.
Removes the specified item from the collection.
Removes the item from the collection at a specified index.
Removes the item with the specified key from the collection.
Removes excess entries.
Wisej.Web.ListView CheckedListViewItemCollection
Namespace: Wisej.Web
Assembly: Wisej.Framework (4.0.0.0)
Represents the collection of checked items in a list view control.
Initializes a new instance of the class.
: Returns the number of items in the collection.
: Returns whether the collection is read-only.
Throws:
Determines whether the specified item is located in the collection.
Determines if an item with the specified key is contained in the collection.
Returns an enumerator that can be used to iterate through the checked index collection.
Determines the index of an item with the specified key.
Represents the method that will handle the event of a .
The previous display position of the .
The new display position for the .
The that is being reordered.
Represents the method that will handle the event of the control.
The index of the image to display in the .
The key of the image to display in the .
One of the values.
Displays an image column header in a control.
The that is being checked or unchecked.
Represents the method that will handle the event of a control.
The the mouse pointer is currently hovering over.
One of the values that indicate which mouse button was pressed.
Represents the method that will handle the event of a .
: Returns or sets whether changes made to the label of the should be canceled.
: Returns the containing the label to edit or edited.
: Returns the new text assigned to the label of the .
: Returns the item whose selection state has changed.
: Returns the index of the item whose selection state has changed.
: Returns the item value at the specified index within the collection.
The index parameter is less than 0 or greater than or equal to the value of the property of .
: Returns the item with the specified key within the collection.
Adds the specified item in the collection to the collection.
Returns: . The new count of selected items.
item is null.
item doesn't belongs to a different .
Returns: . true if the specified index from the for the is an item in the collection; otherwise, false.
Returns: . true if an item with the specified key is contained in the collection; otherwise, false.
Returns: . An that represents the checked index collection.
Returns the index within the of the specified item.
Returns: . The zero-based index in the collection; otherwise, -1 if the item is not located in the collection.
Returns: . The zero-based index for the with the specified name, if found; otherwise, -1.
Removes the item in the collection from the collection.
: Returns the index value at the specified index within the collection.
The index parameter is less than 0 or greater than or equal to the value of the property of .
Adds the item at the specified index in the collection to the collection.
Returns: . The new count of selected items.
The specified index is less than 0 or greater than or equal to the number of items in the owner . Or The owner is in virtual mode, and the specified index is less than 0 or greater than or equal to the value of .
Returns: . true if the specified index from the for the is an item in the collection; otherwise, false.
Returns: . An that represents the selected index collection.
Returns the index within the of the specified index from the of the list view control.
Returns: . The zero-based index in the collection where the specified index of the is located within the ; otherwise, -1 if the index is not located in the collection.
Removes the item at the specified index in the collection from the collection.
The specified index is less than 0 or greater than or equal to the number of items in the owner . Or The owner is in virtual mode, and the specified index is less than 0 or greater than or equal to the value of .
: Returns the item with the specified key from the collection.
Returns: . A that represents the item being added to the collection.
Returns: . The that was added to the collection.
Returns: . The that was added to the collection.
Returns: . The that was added to the collection.
Returns: . The zero-based index value of the added to the collection.
The item is currently assigned to another .
items is null.
items is the child of another .
items is null.
items is the child of another .
Returns: . true if the is a member of the collection; otherwise, false.
Returns: . true to indicate the collection contains a with the specified key; otherwise, false.
Returns: . An that represents the .
Returns: . The zero-based index of the item found in the ; otherwise, -1.
Returns: . The zero-based index of the first occurrence of a with the specified key, if found; otherwise, -1.
The item is currently assigned to another .
Returns: . The that was inserted in the collection.
Returns: . The that was inserted in the collection.
Returns: . The that was inserted in the collection.
Returns: . The that was inserted in the collection.
Fires the event.
Fired when the collection changes.
: Returns the item value at the specified index within the collection.
The index parameter is less than 0 or greater than or equal to the value of the property of .
: Returns the item with the specified key within the collection.
Returns: . true if the specified index from the for the is an item in the collection; otherwise, false.
Returns: . true if an item with the specified key is contained in the collection; otherwise, false.
Returns: . An that represents the checked index collection.
Returns the index within the of the specified item.
Returns: . The zero-based index in the collection; otherwise, -1 if the item is not located in the collection.
Returns: . The zero-based index for the with the specified name, if found; otherwise, -1.
Represents the method that handles the BeforeLabelEdit and AfterLabelEdit events.
Represents the method that will handle the ItemSelectionChanged event of a ListView.
item
The item in the Items collection to add to the SelectedItems collection.
item
The ListViewItem to locate in the collection.
key
The name of the item to search for.
item
The ListViewItem to locate in the collection.
key
The name of the item to retrieve the index for.
item
The item in the Items collection to remove from the SelectedItems collection.
index
The index of the item in the Items collection to add to the SelectedIndices collection.
selectedIndex
The index of the selected item to locate in the collection.
array
Array that will received the list of selected indexes.
index
Starting index in array .
selectedIndex
The zero-based index from the ListViewItemCollection to locate in the collection.
index
The index of the item in the Items collection to remove from the SelectedIndices collection.
text
The label text displayed by the ListViewItem.
key
The name of the ListViewItem.
text
The text to display in the ListViewItem.
key
The name of the ListViewItem.
text
The text to display in the ListViewItem.
imageIndex
The index of the image to display in the ListViewItem.
key
The name of the item.
text
The text to display in the ListViewItem.
imageKey
The image to display in the ListViewItem.
item
The ListViewItem to add to the collection.
items
An array of ListViewItem objects representing the items to add to the collection.
items
An array of ListViewItem objects representing the items to add to the collection.
dispose
Indicates whether the removed items should be disposed.
item
The ListViewItem to locate in the collection.
key
The name of the ListViewItem to search for.
dest
The destination array.
index
The index in the destination array at which storing begins.
item
The ListViewItem to locate in the collection.
key
The name of the ListViewItem to search for.
index
The indexed location within the collection to insert the item.
item
The ListViewItemCollection to insert into the collection.
index
The location within the collection to insert the ListViewItem.
text
The text to display in the ListViewItem.
index
The location within the collection to insert the ListViewItem.
key
The name of the ListViewItem.
text
The text to display in theListViewItem.
index
The location within the collection to insert the ListViewItem.
key
The name of the ListViewItem.
text
The text to display in the ListViewItem.
imageIndex
The index of the image to display in the ListViewItem.
index
The location within the collection to insert the ListViewItem.
key
The name of the ListViewItem.
text
The text to display in the ListViewItem.
imageKey
The key of the image to display in the ListViewItem.
action
One of CollectionChangeAction indicating the reason the collection has changed.
element
The element that was added or removed from the collection, or null.
item
The ListViewItem to remove.
index
The index of the ListViewItem to remove.
key
The name of the ListViewItem to remove from the collection.
itemSorter
item
The ListViewItem to locate in the collection.
key
The name of the item to search for.
item
The ListViewItem to locate in the collection.
key
The name of the item to retrieve the index for.
Both
Vertical and horizontal lines
Horizontal
An horizontal line.
None
No lines.
Vertical
A vertical line.
sender
The source of the event.
e
A LabelEditEventArgs that contains the event data.
Fired when the label for an item is edited by the user.
Fired when the user starts editing the label of an item.
sender
The source of the event.
e
A ItemMouseHoverEventArgs that contains the event data.
Fired when the pointer hovers over an item.
Fired when the pointer leaves an item.
item
The ListViewItem the pointer is currently hovering over.
Represents the method that will handle the ItemMouseHover event of a ListView.
item
The ListViewItem, containing the label to edit.
item
The ListViewItem, containing the label to edit.
label
The new text assigned to the label of the ListViewItem.
item
The ListViewItem whose selection state has changed.
itemIndex
The index of the ListViewItem whose selection state has changed.
isSelected
true to indicate the item's state has changed to selected; false to indicate the item's state has changed to deselected.
owner
A ListView control that owns the collection.
owner
A ListView control that owns the collection.
owner
A ListView control that owns the collection.
Wisej.Web.ListView ColumnHeaderCollection
Namespace: Wisej.Web
Assembly: Wisej.Framework (4.0.0.0)
Represents the collection of column headers in a ListView control.
Initializes a new instance of the ColumnHeaderCollection class.
owner
Int32: Returns the number of items in the collection.
Boolean: Returns or sets the dirty state for the collection. When true, the list of items must be sent back to the client.
Boolean: Returns or sets the new state for the collection. When true, the entire list is cleared and reloaded on the client.
Boolean: Returns whether the collection is read-only.
ColumnHeader: Returns the column header at the specified index within the collection.
Throws:
ArgumentOutOfRangeException index is less than 0 or greater than or equal to the value of the Count property of the ColumnHeaderCollection.
ColumnHeader: Returns the column header with the specified key from the collection.
Adds a column header to the collection with specified text, width, and alignment settings.
text
The text to display in the column header.
width
The initial width of the column header.
textAlign
Returns: ColumnHeader. The ColumnHeader that was created and added to the collection.
Adds an existing ColumnHeader to the collection.
header
Returns: Int32. The zero-based index into the collection where the item was added.
Creates and adds a column with the specified text to the collection.
text
The text to display in the column header.
Returns: ColumnHeader. The ColumnHeader with the specified text that was added to the ColumnHeaderCollection.
Creates and adds a column with the specified text and width to the collection.
text
width
Returns: ColumnHeader. The ColumnHeader with the specified text and width that was added to the ColumnHeaderCollection.
Creates and adds a column with the specified text and key to the collection.
key
text
Returns: ColumnHeader. The ColumnHeader with the specified key and text that was added to the ColumnHeaderCollection.
Creates and adds a column with the specified text, key, and width to the collection.
key
The key of the column header.
text
The text to display in the column header.
width
Returns: ColumnHeader. The ColumnHeader with the given text, key, and width that was added to the collection.
Creates and adds a column with the specified key, aligned text, width, and image key to the collection.
key
The key of the column header.
text
The text to display in the column header.
width
The initial width of the column header.
textAlign
imageKey
The key value of the image to display in the column header.
Returns: ColumnHeader. The ColumnHeader with the specified key, aligned text, width, and image key that has been added to the collection.
Creates and adds a column with the specified key, aligned text, width, and image index to the collection.
key
The key of the column header.
text
The text to display in the column header.
width
The initial width of the column header.
textAlign
imageIndex
The index value of the image to display in the column.
Returns: ColumnHeader. The ColumnHeader with the specified key, aligned text, width, and image index that has been added to the collection.
Adds an array of column headers to the collection.
headers
Removes all column headers from the collection.
Removes all column headers from the collection and optionally disposes them.
dispose
Indicates that the child columns should be disposed after being removed.
Determines whether the specified header is located in the collection.
header
Returns: Boolean. true if the header is contained in the collection; otherwise, false.
Determines if a header with the specified key is contained in the collection.
key
The name of the header to search for.
Returns: Boolean. true if a header with the specified name is contained in the collection; otherwise, false.
array
arrayIndex
Returns an enumerator to use to iterate through the column header collection.
Returns: IEnumerator. An IEnumerator that represents the column header collection.
Returns the index, within the collection, of the specified header.
value
Returns: Int32. The zero-based index of the header's location in the collection. If the header is not located in the collection, the return value is -1.
Determines the index for a header with the specified key.
key
The name of the header to retrieve the index for.
Returns: Int32. The zero-based index for the first occurrence of the column with the specified name, if found; otherwise, -1.
Inserts an existing header into the collection at the specified index.
index
The zero-based index location where the header is inserted.
header
Throws:
ArgumentOutOfRangeException index is less than 0 or greater than or equal to the value of the Count property of the ColumnHeaderCollection.
Creates a new column header and inserts it into the collection at the specified index.
index
The zero-based index location where the header is inserted.
text
The text to display in the header.
width
The initial width of the header. Set to -1 to autosize the header to the size of the largest subitem text in the column or -2 to autosize the header to the size of the text of the header.
textAlign
Throws:
ArgumentOutOfRangeException index is less than 0 or greater than or equal to the value of the Count property of the ColumnHeaderCollection.
Creates a new column with the specified text, and inserts the header into the collection at the specified index.
index
The zero-based index location where the header is inserted.
text
The text to display in the header.
Throws:
ArgumentOutOfRangeException index is less than 0 or greater than or equal to the value of the Count property of the ColumnHeaderCollection.
Creates a new header with the specified text and initial width, and inserts the header into the collection at the specified index.
index
The zero-based index location where the header is inserted.
text
The text to display in the header.
width
The initial width, in pixels, of the header.
Creates a new header with the specified text and key, and inserts the header into the collection at the specified index.
index
The zero-based index location where the header is inserted.
key
The name of the header.
text
The text to display in the header.
Creates a new column with the specified text, key, and width, and inserts the header into the collection at the specified index.
index
The zero-based index location where the header is inserted.
key
The name of the header.
text
The text to display in the header.
width
The initial width, in pixels, of the header.
Creates a new header with the specified aligned text, key, width, and image key, and inserts the header into the collection at the specified index.
index
The zero-based index location where the column header is inserted.
key
The name of the header.
text
The text to display in the header.
width
The initial width, in pixels, of the header.
textAlign
imageKey
The key of the image to display in the header.
Creates a new header with the specified aligned text, key, width, and image index, and inserts the header into the collection at the specified index.
index
The zero-based index location where the column header is inserted.
key
The name of the header.
text
The text to display in the column header.
width
The initial width, in pixels, of the header.
textAlign
imageIndex
The index of the image to display in the header.
Fires the CollectionChanged event.
action
element
The element that was added or removed from the collection, or null.
Removes the specified header from the collection.
column
Removes the header at the specified index within the collection.
index
The zero-based index of the header to remove.
Throws:
ArgumentOutOfRangeException index is less than 0 or greater than or equal to the value of the Count property of the ColumnHeaderCollection.
Removes the header with the specified key from the collection.
key
The name of the header to remove from the collection.
Renders the collection to the json definition for the client.
Returns: Object.
CollectionChangeEventHandler Fired when the collection changes.
Wisej.Web.ListViewBindingCompleteEventEventHandler
Namespace: Wisej.Web
Assembly: Wisej.Framework (4.0.0.0)
Represents the method that will handle the DataBindingComplete event of a ListView.
sender
The source of the event.
e
A that contains the event data.
Occurs after a data-binding operation has finished.
Wisej.Web.ListView CheckedIndexCollection
Namespace: Wisej.Web
Assembly: Wisej.Framework (4.0.0.0)
Represents the collection containing the indexes to the checked items in a list view control.
Int32: Returns the number of items in the collection.
Boolean: Returns whether the collection is read-only.
Int32: Returns the index value at the specified index within the collection.
Throws:
ArgumentOutOfRangeException The index parameter is less than 0 or greater than or equal to the value of the Count property of CheckedIndexCollection.
Adds the item at the specified index in the Items collection to the CheckedIndexCollection.
index
Returns: Int32. The new count of selected items.
Throws:
ArgumentOutOfRangeException The specified index is less than 0 or greater than or equal to the number of items in the owner ListView. Or The owner ListView is in virtual mode, and the specified index is less than 0 or greater than or equal to the value of VirtualListSize.
Clears the selection.
Determines whether the specified index is located in the collection.
checkedIndex
The index of the checked item to locate in the collection.
Returns: Boolean. true if the specified index from the ListViewItemCollection for the ListView is an item in the collection; otherwise, false.
Copies the list of checked indexes into the specified array starting at the specified index .
array
Array that will received the list of selected indexes.
index
Starting index in array .
Returns an enumerator that can be used to iterate through the checked index collection.
Returns: IEnumerator<Int32>. An IEnumerator that represents the checked index collection.
Returns the index within the CheckedIndexCollection of the specified index from the ListViewItemCollection of the list view control.
checkedIndex
Returns: Int32. The zero-based index in the collection where the specified index of the ListViewItemCollection is located within the CheckedIndexCollection; otherwise, -1 if the index is not located in the collection.
Removes the item at the specified index in the Items collection from the CheckedIndexCollection.
index
Throws:
ArgumentOutOfRangeException The specified index is less than 0 or greater than or equal to the number of items in the owner ListView. Or The owner ListView is in virtual mode, and the specified index is less than 0 or greater than or equal to the value of VirtualListSize.
Wisej.Web.ListViewDataUpdatedEventArgs
Namespace: Wisej.Web
Assembly: Wisej.Framework (4.0.0.0)
Provides data for the DataUpdated event.
Int32: The index of the first ListViewItem that has been loaded on the client.
Int32: The index of the last ListViewItem that has been loaded on the client.
Represents the method that will handle the event of a .
Wisej.Web.ListViewBindingCompleteEventArgs
Namespace: Wisej.Web
Assembly: Wisej.Framework (4.0.0.0)
Provides data for the DataBindingComplete event.
ListChangedType: Returns a value specifying how the list changed.
Represents the method that will handle the event of a .
Wisej.Web.ListViewItem ListViewSubItem
Namespace: Wisej.Web
Assembly: Wisej.Framework (4.0.0.0)
Represents a sub-item of a ListViewItem.
Initializes a new instance of the ListViewSubItem class.
Initializes a new instance of the ListViewSubItem class with the specified owner and text.
owner
text
The text to display for the sub item.
Initializes a new instance of the ListViewSubItem class with the specified owner, text, foreground color, background color, and font values.
owner
text
The text to display for the sub item.
foreColor
backColor
font
Boolean: Returns or sets a value indicating that the item can display HTML text. (Default: False
)
When AllowHtml is set to true, the text in the item can contain HTML content. If the text contains new lines (CRLF) but doesn't contain HTML elements (at least one "<") all CRLF are automatically substituted with "<br/>".
Color: Returns or sets the background color of the ListViewSubItem.
Int32: Returns or sets the number of columns that this sub-item can use to render its content when the ListView is in Details mode. (Default: 1
)
Throws:
ArgumentOutOfRangeException The value is lower than 1 or greater than 100.
Control: Returns or sets a child control to display inside the sub-item.
Font: Returns or sets the font of the text displayed by the ListViewSubItem.
Font:
Color: Returns or sets the foreground color of the ListViewSubItem.
Boolean: Checks if the UserData dynamic object was created and has any value.
Boolean: Returns whether the ListViewItem is data bound.
String: Returns or sets the name associated with this subitem.
ListViewItem: Returns the ListViewItem that contains the sub-item.
Int32: Returns or sets the number of rows that this sub-item can use to render its content when the ListView is in Details mode. (Default: 1
)
Throws:
ArgumentOutOfRangeException The value is lower than 1 or greater than 100.
Object: Returns or sets an object that contains data to associate with the sub-item. (Default: null
)
String: Returns or sets the text of the sub item.
Object: Returns a dynamic object that can be used to store custom data in relation to this item.
Releases all resources used by the ListViewSubItem.
Releases the resources used by the ListViewSubItem.
disposing
true when this method is called by the application rather than a finalizer.
Destructor dispose pattern.
Renders the subitem into the specified configuration maps.
dataName
data
styles
dataName
styles
Provides access to the UserData
and Tag
properties associated to the component implementing this interface.
Wisej.Web.ListViewDataUpdatedEventHandler
Namespace: Wisej.Web
Assembly: Wisej.Framework (4.0.0.0)
Represents the method that will handle the DataUpdated event of a ListView.
sender
The source of the event.
e
A that contains the event data.
Fired when the client has updated one or more items in the view.
Wisej.Web.ListViewItem
Namespace: Wisej.Web
Assembly: Wisej.Framework (4.0.0.0)
Represents an item in a ListView control.
Initializes a new instance of the ListViewItem class with default values.
Initializes a new instance of the ListViewItem class with the specified item text.
text
The text to display for the item.
Initializes a new instance of the ListViewItem class with an array of strings representing sub-items.
items
An array of strings that represent the sub-items of the new item.
Initializes a new instance of the ListViewItem class with the specified item text and the image index position of the item's icon.
text
The text to display for the item.
imageIndex
Initializes a new instance of the ListViewItem class with the image index position of the item's icon and an array of strings representing sub-items.
items
An array of strings that represent the sub-items of the new item.
imageIndex
Initializes a new instance of the ListViewItem class with the image index position of the item's icon; the foreground color, background color, and font of the item; and an array of strings representing sub-items.
items
An array of strings that represent the sub-items of the new item.
imageIndex
foreColor
backColor
font
Initializes a new instance of the ListViewItem class with the image index position of the item's icon and an array of ListViewSubItem objects.
subItems
imageIndex
Initializes a new instance of the ListViewItem class with the specified text and image.
text
The text to display for the item. This should not exceed 259 characters.
imageKey
Initializes a new instance of the ListViewItem class with the specified item and sub-item text and image.
items
imageKey
Initializes a new instance of the ListViewItem class with the sub-items containing the specified text, image, colors, and font.
items
imageKey
foreColor
backColor
font
Initializes a new instance of the ListViewItem class with the specified sub-items and image.
subItems
imageKey
Boolean: Returns or sets a value indicating that the item can display HTML text. (Default: False
)
When AllowHtml is set to true, the text in the item can contain HTML content. If the text contains new lines (CRLF) but doesn't contain HTML elements (at least one "<") all CRLF are automatically substituted with "<br/>".
Color: Returns or sets the background color of the ListView.
Boolean: Returns or sets whether the item is checked. (Default: False
)
Int32: Returns or sets the number of columns that this item can use to render its content when the ListView is in Details mode. (Default: 1
)
Throws:
ArgumentOutOfRangeException The value is lower than 1 or greater than 100.
ContextMenu: Returns or sets the shortcut menu associated with the item. (Default: null
)
Control: Returns or sets a child control to display inside the item.
Object: Returns the data-bound object for this ListViewItem.
Boolean: Return or sets whether the item has the focus within the ListView parent.
Font: Returns or sets the font of the text displayed by the ListView.
Color: Returns or sets the foreground color of the ListView.
Boolean: Returns true if the ListViewItem specified the row height.
Boolean: Checks if the UserData dynamic object was created and has any value.
Image: Returns or sets the image that is displayed on a ListViewItem.
Int32: Returns or sets the image list index value of the image displayed in the ListViewItem. (Default: -1
)
Throws:
ArgumentOutOfRangeException The specified index is less than -1.
String: Returns or sets the key accessor for the image in the ImageList. (Default: ""
)
ImageList: Returns the ImageList that contains the images displayed in the ListViewItem.
ImagePropertySettings: Creates the property manager for the Image properties on first use.
String: Returns or sets the theme name or URL for the image to display in the ListViewItem.
Int32: Returns the zero-based index of the item within the ListView control.
Boolean: Returns whether the ListViewItem is data bound.
Boolean: Returns a value indicating whether the tree node is in an editable state.
ListView: Returns the ListView control that contains the item.
String: Returns or sets the name associated with this item.
Int32: Returns or sets the height of the row corresponding to this item when in Details view.
Int32: Returns or sets the number of rows that this item can use to render its content when the ListView is in Details mode. (Default: 1
)
Throws:
ArgumentOutOfRangeException The value is lower than 1 or greater than 100.
Boolean: Returns or sets whether the item is selected.
Int32: Returns or sets the image list index value of the state icon displayed in the ListViewItem. (Default: -1
)
Throws:
ArgumentOutOfRangeException The specified index is less than -1.
String: Returns or sets the key for the state icon displayed in the ImageList. (Default: ""
)
ImageList: Returns the ImageList that contains the state images displayed in the ListViewItem.
ImagePropertySettings: Creates the property manager for the Image properties on first use.
String: Returns or sets the theme name or URL for the state icon to display in the ListViewItem.
ListViewSubItemCollection: Returns a collection containing all sub items.
Object: Returns or sets an object that contains data to associate with the item. (Default: null
)
String: Returns or sets the text of the item. (Default: ""
)
String: Returns or sets the text shown when the mouse pointer rests on the ListViewItem. (Default: ""
)
Object: Returns a dynamic object that can be used to store custom data in relation to this item.
Boolean: Returns or sets whether the item is visible.
Places the item in edit mode.
Throws:
InvalidOperationException The LabelEdit property of the associated ListView is not set to true.
Creates an identical copy of the item.
Returns: Object. An object that represents an item that has the same text, image, and sub-items associated with it as the cloned item.
Releases all resources used by the ListViewItem.
Releases the resources used by the ListViewItem.
disposing
true when this method is called by the application rather than a finalizer.
Ensures that the item is visible within the control, scrolling the contents of the control, if necessary.
Destructor dispose pattern.
inherit
Returns: Color.
inherit
Returns: Font.
inherit
Returns: Color.
Removes the item from its associated ListView control.
Renders the item.
Returns: Object.
Renders the item.
config
The object we are rendering into.
Updates the item in the ListView owner.
Provides access to the UserData
and Tag
properties associated to the component implementing this interface.
Provides access to common image properties across the controls that implement this interface.
Wisej.Web.ListViewVirtualItemsSelectionRangeChangedEventArgs
Namespace: Wisej.Web
Assembly: Wisej.Framework (4.0.0.0)
Provides data for the VirtualItemsSelectionRangeChanged event.
Initializes a new instance of the ListViewVirtualItemsSelectionRangeChangedEventArgs class.
startIndex
The index of the first item in the range that has changed.
endIndex
The index of the last item in the range that has changed.
isSelected
true to indicate the items are selected; false to indicate the items are deselected.
Throws:
ArgumentException startIndex is larger than endIndex..
Int32: Returns the index for the last item in the range of items whose selection state has changed.
Boolean: Returns a value indicating whether the range of items is selected.
Int32: Returns the index for the first item in the range of items whose selection state has changed.
Wisej.Web.ListViewVirtualItemsSelectionRangeChangedEventHandler
Namespace: Wisej.Web
Assembly: Wisej.Framework (4.0.0.0)
Represents the method that will handle the VirtualItemsSelectionRangeChanged event of a ListView.
sender
The source of the event.
e
A that contains the event data.
Fired when a is in virtual mode and the selection state of a range of items has changed.
Wisej.Web.ListViewItemDragEventHandler
Wisej.Web.RetrieveVirtualItemEventArgs
Namespace: Wisej.Web
Assembly: Wisej.Framework (4.0.0.0)
Provides data for the event.
Initializes a new instance of the class.
: Returns or sets the item retrieved from the cache.
: Returns the index of the item to retrieve from the cache.
Wisej.Web.ListViewItemDragEventArgs
Namespace: Wisej.Web
Assembly: Wisej.Framework (4.0.0.0)
Provides data for the event of the controls.
Initializes a new instance of the class with a specified mouse button.
Initializes a new instance of the class with a specified mouse button and the that is being dragged.
Wisej.Web.RetrieveVirtualItemEventHandler
Wisej.Web.SearchForVirtualItemEventArgs
Namespace: Wisej.Web
Assembly: Wisej.Framework (4.0.0.0)
Provides data for the event.
Initializes a new instance of the class.
: Returns a value indicating whether the search should include sub items of list items.
Wisej.Web.ListViewItem ListViewSubItemCollection
Namespace: Wisej.Web
Assembly: Wisej.Framework (4.0.0.0)
Represents the collection of subitems in a item.
: Returns the total number of subitems in the collection.
: Returns a value indicating whether the collection is read-only.
: Returns or sets the subitem at the specified index in the collection.
Throws:
The index value is less than 0 or is greater than the number of items in the collection.
Adds a new subitem with the specified label text to the end of the current collection.
Adds a new subitem to the collection with the specified text, foreground color, background color, and font settings.
Adds a previously created subitem to the end of the collection.
Throws:
Creates new subitems based on an array of strings and adds them to the collection.
Creates new subitems based on an array of strings and adds them to the collection with the specified foreground color, background color, and font.
Adds an array of previously created subitems to the collection.
Throws:
Determines whether the specified subitem is a member of the collection.
Determines whether the collection contains a subitem with the specified key.
Copies the entire collection into an existing array at a specified location within the array.
Returns an enumerator that can be used to iterate through the collection.
Returns the index of the specified subitem in the collection.
Returns the index of the first occurrence of a subitem with the specified key.
Throws:
Creates a new subitem with the specified text and inserts it at the specified index.
Creates a new subitem with the specified text and key, and inserts it into the collection.
Removes the specified subitem from the collection.
Removes a subitem from the collection at a specified index.
Removes the subitem with the specified key from the collection.
comparison
The that owns this collection.
One of the values.
The to add to the collection.
The text of the to add to the collection.
The width of the to add to the collection.
The key of the to add to the collection.
The text of the to add to the collection.
The initial width of the .
One of the values.
One of the values.
An array of objects to add to the collection.
A representing the header to locate in the collection.
A representing the header to locate in the collection.
The to insert into the collection.
One of the values.
One of the values.
One of the values.
One of indicating the reason the collection has changed.
A representing the header to remove from the collection.
The index of the item in the collection to add to the .
The zero-based index from the to locate in the collection.
The index of the item in the collection to remove from the .
A that represents the item that owns the sub item.
A that represents the item that owns the sub item.
A that represents the foreground color of the sub item.
A that represents the background color of the sub item.
A that represents the font to display the sub item's text in.
The zero-based index of the image within the associated with the that contains the item.
The zero-based index of the image within the associated with the that contains the item.
The zero-based index of the image within the associated with the that contains the item.
A that represents the foreground color of the item.
A that represents the background color of the item.
A that represents the font to display the item's text in.
An array of type that represents the sub-items of the item.
The zero-based index of the image within the associated with the that contains the item.
The name of the image within the of the owning to display in the .
An array containing the text of the sub-items of the .
The name of the image within the of the owning to display in the .
An array of strings that represent the text of the sub-items for the .
The name of the image within the of the owning to display in the item.
A that represents the foreground color of the item.
A that represents the background color of the item.
A to apply to the item text.
An array of objects.
The name of the image within the of the owning to display in the .
Represents the method that will handle the event of a .
: Returns a value that indicates which mouse buttons were pressed during the drag operation.
: Returns the that is being dragged.
: Returns or sets the index of the found in the .
: Returns a value indicating whether the search should return an item if its text starts with the search text.
: Returns the index of the where the search starts.
: Returns the text used to find an item in the control.
: Returns the subitem with the specified key from the collection.
Returns: . A that represents the item being added to the collection.
Returns: . The that was added to the collection.
Returns: . A that represents the item being added to the collection.
The item is currently assigned to another .
items is null.
items is the child of another .
Removes all instances from the collection.
Removes all instances from the collection and optionally disposes them.
Returns: . true if the is a member of the collection; otherwise, false.
Returns: . true to indicate the collection contains a with the specified key; otherwise, false.
Returns: . An that represents the .
Returns: . The zero-based index of the item found in the ; otherwise, -1.
Returns: . The zero-based index of the first occurrence of a with the specified key, if found; otherwise, -1.
Inserts an existing into the collection at the specified location.
Returns: . The that was inserted in the collection.
The item is currently assigned to another .
Returns: . The that was inserted in the collection.
Returns: . The that was inserted in the collection.
Fires the event.
Fired when the collection changes.
Represents the method that will handle the RetrieveVirtualItem event of a ListView.
Represents the method that will handle the SearchForVirtualItem event of a ListView.
text
The label text displayed by the ListViewSubItem.
text
The text to display for the subitem.
foreColor
A Color that represents the foreground color of the subitem.
backColor
A Color that represents the background color of the subitem.
font
A Font that represents the typeface to display the subitem's text in.
item
The ListViewSubItem to add to the collection.
items
An array of strings representing the text of each subitem to add to the collection.
items
An array of strings representing the text of each subitem to add to the collection.
foreColor
A Color that represents the foreground color of the subitem.
backColor
A Color that represents the background color of the subitem.
font
A Font that represents the typeface to display the subitem's text in.
items
An array of ListViewSubItem to add to the collection.
dispose
Indicates whether the removed items should be disposed.
item
The ListViewSubItem to locate in the collection.
key
The name of the ListViewSubItem to search for.
dest
The destination array.
index
The index in the destination array at which storing begins.
subitem
The ListViewSubItem to locate in the collection.
key
The name of the ListViewSubItem to search for.
index
The indexed location within the collection to insert the subitem.
item
The ListViewSubItem to insert into the collection.
index
The location within the collection to insert the ListViewSubItem.
text
The text to display in the ListViewSubItem.
index
The location within the collection to insert the ListViewSubItem.
key
The name of the ListViewSubItem.
text
The text to display in theListViewSubItem.
action
One of CollectionChangeAction indicating the reason the collection has changed.
element
The element that was added or removed from the collection, or null.
item
The ListViewSubItem to remove.
index
The index of the ListViewSubItem to remove.
key
The name of the ListViewSubItem to remove from the collection.
Checked
The item is checked.
Default
The item is in its default state.
Disabled
The item is disabled.
Selected
The item is selected.
sender
The source of the event.
e
A SearchForVirtualItemEventArgs that contains the event data.
Fired when the ListView is in virtual mode and a search is requested.
Details
Each item appears on a separate line with further information about each item arranged in columns. The left-most column contains a small icon and label, and subsequent columns contain sub items as specified by the application. A column displays a header which can display a caption for the column. The user can resize each column at run time.
LargeIcon
Each item appears as a full-sized icon with a label below it.
SmallIcon
Each item appears as a small icon with a label to its right.
Tile
Each item appears as a full-sized icon with the item label and sub item information below the label. Items wrap to a new line from left to right.
Returns or sets how items are displayed in the control.
Returns or sets how items are displayed in the control.
sender
The source of the event.
e
A RetrieveVirtualItemEventArgs that contains the event data.
Fired when the ListView is in virtual mode and requires a ListViewItem.
itemIndex
The index of the item to retrieve.
button
A combination of MouseButtons values that indicates which mouse buttons were pressed.
button
A combination of MouseButtons values that indicates which mouse buttons were pressed.
item
The ListViewItem being dragged.
isPrefixSearch
A value indicating whether the search is a prefix search.
includeSubItemsInSearch
A value indicating whether to include sub items of list items in the search.
text
The text of the item to search for.
startIndex
The index of the ListViewItem at which to start the search.