Namespace: Wisej.Web

Assembly: Wisej.Framework (2.5.0.0)

Represents the method that will handle the ColumnClick event of a ListView.

public delegate void ColumnClickEventHandler(Object sender, ColumnClickEventArgs e)

Public Delegate Sub ColumnClickEventHandler(ByVal sender As [Object], ByVal e As ColumnClickEventArgs)

Parameters

Fired By

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.5.0.0)

Provides data for the CacheVirtualItems event.

public class CacheVirtualItemsEventArgs : EventArgs

Public Class CacheVirtualItemsEventArgs
    Inherits EventArgs

Constructors

CacheVirtualItemsEventArgs(startIndex, endIndex)

Initializes a new instance of the CacheVirtualItemsEventArgs class with the specified starting and ending indices.

Properties

EndIndex

Int32: Returns the ending index for the range of values needed by a ListView control in virtual mode.

StartIndex

Int32: Returns the starting index for a range of values needed by a ListView control in virtual mode.

Used By

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.5.0.0)

Provides data for the event.

Constructors

ColumnClickEventArgs(column)

Initializes a new instance of the class.

ColumnClickEventArgs(column, button, clicks)

Initializes a new instance of the class.

Properties

Button

Used By

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.5.0.0)

Represents the method that will handle the CacheVirtualItems event of a ListView.

public delegate void CacheVirtualItemsEventHandler(Object sender, CacheVirtualItemsEventArgs e)

Public Delegate Sub CacheVirtualItemsEventHandler(ByVal sender As [Object], ByVal e As CacheVirtualItemsEventArgs)

Parameters

Fired By

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.5.0.0)

Specifies how a column contained in a should be resized.

Fields

Used By

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.5.0.0)

• Component

  • Component

    • ColumnHeader

Displays a standard column header in a ListView control.

public class ColumnHeader : Component, ICloneable, IHasPropertyStore, IHasResponsiveProfiles

Public Class ColumnHeader
    Inherits Component
    Implements ICloneable, IHasPropertyStore, IHasResponsiveProfiles

Constructors

ColumnHeader()

Initializes a new instance of the ColumnHeader class.

ColumnHeader(imageIndex)

Initializes a new instance of the ColumnHeader class with the image specified.

ColumnHeader(imageKey)

Initializes a new instance of the ColumnHeader class with the image specified.

Properties

Boolean: Returns or sets whether the ellipsis character (...) appears at the right edge of the cell when the View property is set to Details, denoting that the text extends beyond the size of the cell.

Color: Returns or sets the background color for the ColumnHeader.

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".

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.

Control: Returns or sets a child control to display inside the cell.

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 Count property.

String: Returns or sets the property to display in the Items.

Color: Returns or sets the text color of the ColumnHeader.

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.

Throws:

• ArgumentOutOfRangeException The specified index is less than -1.

String: Returns or sets the key of the image displayed in the ColumnHeader.

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 minimum width, in pixels, of the column.

Throws:

• ArgumentOutOfRangeException The value is less than 2 or greater than 32000.

Boolean: Returns or sets whether the column header can be moved by the user.

String: Returns or sets the name of the ColumnHeader.

Boolean: Returns or sets whether the column header can be resized by the user.

Boolean: Returns or sets whether the column can be sorted by clicking on the header.

SortOrder: Returns or sets the type of sort glyph to display in the column header.

Object: Returns or sets an object that contains data to associate with the ColumnHeader.

String: Returns or sets the text displayed in the column header.

HorizontalAlignment: Returns or sets the horizontal alignment of the text displayed in the ColumnHeader.

Boolean: Returns or sets whether the column is visible when the control is in Details view.

Int32: Returns or sets the width of the column.

Methods

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

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.

Inherited By

Implements

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.5.0.0)

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

Constructors

ListView()

Initializes a new instance of the class.

Properties

AllowColumnReorder

: Returns or sets whether the user can drag column headers to reorder columns in the control.

AllowColumnSorting

Throws:

Throws:

Methods

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

Throws:

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

Throws:

Removes all items and columns from the control.

Clears the current selection.

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

Throws:

Throws:

Scrolls the specified column into view.

Sorts the items of the list view.

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

Throws:

Implements

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.5.0.0)

Represents the method that will handle the event of a .

Parameters

Fired By

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.5.0.0)

Determines the styles of the column headers in a control.

Fields

Used By

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.5.0.0)

Represents the method that will handle the event of the control.

Parameters

Fired By

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.5.0.0)

Provides data for the event.

Constructors

ColumnReorderedEventArgs(oldDisplayIndex, newDisplayIndex, header)

Initializes a new instance of the class.

Properties

Header

: Returns the that is being reordered.

NewDisplayIndex

Used By

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.5.0.0)

Specifies the line styles that can be applied to the cell of a ListView control when its View property is set to Details.

public enum GridLineStyle : Enum

Public Enum GridLineStyle As [Enum]

Fields

Used By

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.5.0.0)

Provides data for the ColumnWidthChanged event.

public class ColumnWidthChangedEventArgs : EventArgs

Public Class ColumnWidthChangedEventArgs
    Inherits EventArgs

Constructors

ColumnWidthChangedEventArgs(columnIndex)

Initializes a new instance of the ColumnWidthChangedEventArgs class.

Properties

ColumnIndex

Int32: Returns the column index for the column whose width is being changed.

Used By

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.5.0.0)

• Component

  • Component

    • ColumnHeader

      • ImageColumnHeader

Displays an image column header in a ListView control.

public class ImageColumnHeader : ColumnHeader

Public Class ImageColumnHeader
    Inherits ColumnHeader

The value of the items displayed under the ImageColumnHeader are displayed as either an image name or an image URL.

Constructors

ImageColumnHeader()

Initializes a new instance of the ImageColumnHeader class.

Implements

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.5.0.0)

Represents the method that will handle the ItemChecked event of a ListView control.

public delegate void ItemCheckedEventHandler(Object sender, ItemCheckedEventArgs e)

Public Delegate Sub ItemCheckedEventHandler(ByVal sender As [Object], ByVal e As ItemCheckedEventArgs)

Parameters

Fired By

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.5.0.0)

Provides data for the ItemClick event.

public class ItemClickEventArgs : EventArgs

Public Class ItemClickEventArgs
    Inherits EventArgs

Constructors

ItemClickEventArgs(item, button, clicks)

Initializes a new instance of the ItemClickEventArgs class.

Properties

Button

MouseButtons: Returns which mouse button was pressed.

Clicks

Int32: Returns the number of clicks or taps.

ListViewItem: Returns the item that was clicked or tapped.

String: Returns the internal role assigned to the element that generated the pointer event: checkbox, button, ...

The value in the Role property is taken from the "role" attribute of the clicked element inside the cell. You can detect clicks on custom HTML content by adding the role attribute to the custom element.

Used By

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.5.0.0)

Provides data for the ItemChecked event of the ListView control.

public class ItemCheckedEventArgs : EventArgs

Public Class ItemCheckedEventArgs
    Inherits EventArgs

Constructors

ItemCheckedEventArgs(item)

Initializes a new instance of the ItemCheckedEventArgs class.

Properties

Item

ListViewItem: Returns the ListViewItem whose checked state is changing.

Used By

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.5.0.0)

Represents the method that will handle the ItemClick event of a ListView.

public delegate void ItemClickEventHandler(Object sender, ItemClickEventArgs e)

Public Delegate Sub ItemClickEventHandler(ByVal sender As [Object], ByVal e As ItemClickEventArgs)

Parameters

Fired By

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.5.0.0)

Provides data for the ItemMouseHover event.

public class ItemMouseHoverEventArgs : EventArgs

Public Class ItemMouseHoverEventArgs
    Inherits EventArgs

Constructors

ItemMouseHoverEventArgs(item)

Initializes a new instance of the ItemMouseHoverEventArgs class.

Properties

Item

ListViewItem: Returns the item the pointer is currently hovering over.

Used By

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.5.0.0)

Represents the method that will handle the ItemMouseHover event of a ListView.

public delegate void ItemMouseHoverEventHandler(Object sender, ItemMouseHoverEventArgs e)

Public Delegate Sub ItemMouseHoverEventHandler(ByVal sender As [Object], ByVal e As ItemMouseHoverEventArgs)

Parameters

Fired By

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.5.0.0)

Provides data for the ItemSelectionChanged event.

public class ItemSelectionChangedEventArgs : EventArgs

Public Class ItemSelectionChangedEventArgs
    Inherits EventArgs

Constructors

ItemSelectionChangedEventArgs(item, itemIndex, isSelected)

Initializes a new instance of the ItemSelectionChangedEventArgs class.

Properties

IsSelected

Boolean: Returns a value indicating whether the item's state has changed to selected.

Item

ListViewItem: Returns the item whose selection state has changed.

Int32: Returns the index of the item whose selection state has changed.

Used By

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.5.0.0)

Provides data for the and events.

Constructors

LabelEditEventArgs(item)

Initializes a new instance of the class with the specified index to the to edit or edited.

LabelEditEventArgs(item, label)

Initializes a new instance of the class with the specified index to the being edited and the new text for the label of the .

Properties

CancelEdit

Used By

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.5.0.0)

Represents the method that handles the BeforeLabelEdit and AfterLabelEdit events.

public delegate void LabelEditEventHandler(Object sender, LabelEditEventArgs e)

Public Delegate Sub LabelEditEventHandler(ByVal sender As [Object], ByVal e As LabelEditEventArgs)

Parameters

Fired By

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.5.0.0)

Represents the collection of checked items in a list view control.

public class CheckedListViewItemCollection : IList<ListViewItem>, ICollection<ListViewItem>, IEnumerable<ListViewItem>, IEnumerable

Public Class CheckedListViewItemCollection
    Inherits IList(Of ListViewItem)
    Implements ICollection(Of ListViewItem), IEnumerable(Of ListViewItem), IEnumerable

Constructors

CheckedListViewItemCollection(owner)

Initializes a new instance of the CheckedListViewItemCollection class.

Properties

Count

Int32: Returns the number of items in the collection.

IsReadOnly

Boolean: Returns whether the collection is read-only.

Item(index)

ListViewItem: Returns the item 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 SelectedListViewItemCollection.

ListViewItem: Returns the item with the specified key within the collection.

Methods

Determines whether the specified item is located in the collection.

Returns: Boolean. true if the specified index from the ListViewItemCollection for the ListView is an item in the collection; otherwise, false.

Determines if an item with the specified key is contained in the collection.

Returns: Boolean. true if an item with the specified key is contained in the collection; otherwise, false.

Returns an enumerator that can be used to iterate through the checked index collection.

Returns: IEnumerator<ListViewItem>. An IEnumerator that represents the checked index collection.

Returns the index within the CheckedListViewItemCollection of the specified item.

Returns: Int32. The zero-based index in the collection; otherwise, -1 if the item is not located in the collection.

Determines the index of an item with the specified key.

Returns: Int32. The zero-based index for the ListViewItem with the specified name, if found; otherwise, -1.

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.5.0.0)

Represents the collection containing the indexes to the checked items in a list view control.

public class CheckedIndexCollection : IList<Int32>, ICollection<Int32>, IEnumerable<Int32>, IEnumerable

Public Class CheckedIndexCollection
    Inherits IList(Of Int32)
    Implements ICollection(Of Int32), IEnumerable(Of Int32), IEnumerable

Constructors

CheckedIndexCollection(owner)

Initializes a new instance of the CheckedIndexCollection class.

Properties

Count

Int32: Returns the number of items in the collection.

IsReadOnly

Boolean: Returns whether the collection is read-only.

Item(index)

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.

Methods

Adds the item at the specified index in the Items collection to the CheckedIndexCollection.

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.

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 .

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.

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.

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.

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.5.0.0)

Represents the method that will handle the event of a .

Parameters

Fired By