1 of 100

Lists & Grids

CheckedListBox

Wisej.Web.CheckedListBox

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.1.0.0)

Control
- ListControl
  - ListBox
    CheckedListBox

Displays a ListBox in which a check box is displayed to the left of each item.

public class CheckedListBox : ListBox

Public Class CheckedListBox
    Inherits ListBox

Constructors

CheckedListBox()

Initializes a new instance of the CheckedListBox class.

Properties

CheckedIndices

CheckedIndexCollection: Collection of checked indexes in the CheckedListBox.

CheckedObjectCollection: Collection of checked items in the CheckedListBox.

Boolean: Returns or sets whether list items are checked when they are clicked. The default is to check the item when clicking on the checkbox icon. (Default: False)

String: Returns or sets the property to bind to the CheckState of the items in the CheckedListBox control. (Default: "")

ObjectCollection: Returns the collection of items in this CheckedListBox.

Methods

Unchecks all items in the CheckedListBox.

Returns a value indicating whether the specified item is checked.

Returns: Boolean. true if the item is checked; otherwise, false.

Throws:

ArgumentException The index specified is less than zero; or the index specified is greater than or equal to the count of items in the list.

Returns a value indicating the check state of the current item.

Returns: CheckState. One of the CheckState values.

Throws:

ArgumentOutOfRangeException The index specified is less than zero; or the index specified is greater than or equal to the count of items in the list.

Sets CheckState for the item at the specified index to Checked.

Throws:

ArgumentException The index specified is less than zero; or the index is greater than the count of items in the list.

Sets the check state of the item at the specified index.

Throws:

ArgumentOutOfRangeException The index specified is less than zero; or the index is greater than or equal to the count of items in the list.

Events

ItemCheckEventHandler Fired after the checked state of an item changes.

EventHandler Fired when the CheckStateMember property changes.

EventHandler Fired when the user clicks the CheckedListBox control.

ItemCheckEventHandler Fired when the checked state of an item changes.

MouseEventHandler Fired when the user clicks the CheckedListBox control with the mouse.

Implements

CheckedListBox.CheckedIndexCollection

Wisej.Web.CheckedListBox CheckedIndexCollection

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.1.0.0)

Represents the collection containing the indexes to the selected items in a CheckedListBox.

public class CheckedIndexCollection : IList, ICollection, IEnumerable

Public Class CheckedIndexCollection
    Inherits IList
    Implements ICollection, IEnumerable

Properties

Count

Int32: Returns the number of selected items.

IsReadOnly

Boolean: Returns a value indicating whether this collection can be modified.

Item(index)

Int32: Returns the index of a checked item in the CheckedListBox control.

Throws:

ArgumentException The index is less than zero.-or- The index is not in the collection.

Methods

Determines if the specified index is located within the collection.

Returns: Boolean. true if the index is located within the collection; otherwise, false.

Copies the entire collection into an existing array at a specified location within the array.

Throws:

ArgumentNullException array is null.
RankException array is multidimensional.
ArgumentOutOfRangeException index is less than zero.
ArgumentException The number of elements in the source Array is greater than the available space from index to the end of the destination Array.
ArrayTypeMismatchException The type of the source Array cannot be cast automatically to the type of the destination Array.

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

Returns: IEnumerator. An IEnumerator for navigating through the list.

Returns an index into the collection of checked indexes.

Returns: Int32. The index that specifies the index of the checked item or -1 if the index parameter is not in the checked indexes collection.

CheckedListBox.CheckedObjectCollection

Wisej.Web.CheckedListBox CheckedObjectCollection

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.1.0.0)

Represents the collection of checked items in the CheckedListBox.

public class CheckedObjectCollection : IList, ICollection, IEnumerable

Public Class CheckedObjectCollection
    Inherits IList
    Implements ICollection, IEnumerable

Properties

Count

Int32: Returns the number of selected items.

IsReadOnly

Boolean: Returns a value indicating whether this collection can be modified.

Item(index)

Object: Return an item in the checked items collection.

Throws:

NotSupportedException The object cannot be set.

Methods

Determines if the specified item is located within the collection.

Returns: Boolean. true if the item is located within the collection; otherwise, false.

Copies the entire collection into an existing array at a specified location within the array.

Throws:

ArgumentNullException array is null.
RankException array is multidimensional.
ArgumentOutOfRangeException index is less than zero.
ArgumentException The number of elements in the source Array is greater than the available space from index to the end of the destination Array.
ArrayTypeMismatchException The type of the source Array cannot be cast automatically to the type of the destination Array.

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

Returns: IEnumerator. An IEnumerator for navigating through the list.

Returns an index into the collection of checked items.

Returns: Int32. The index of the object in the checked item collection or -1 if the object is not in the collection.

CheckedListBox.ObjectCollection

Wisej.Web.CheckedListBox ObjectCollection

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.1.0.0)

ObjectCollection
- ObjectCollection

Represents the collection of items in a CheckedListBox.

public class ObjectCollection : ObjectCollection

Public Class ObjectCollection
    Inherits ObjectCollection

Methods

Add(item)

Adds an item to the list of items for a ListBox.

Parameter

Type

Description

Returns: Int32. The zero-based index of the item in the collection.

Throws:

ArgumentNullException The item parameter was null.

Add(item, isChecked)

Adds an item to the list of items for a CheckedListBox.

Returns: Int32. The zero-based index of the item in the collection.

Throws:

ArgumentNullException The item parameter was null.

Adds an item to the list of items for a CheckedListBox.

Returns: Int32.

Adds a collection of items to the list.

Removes all items from the CheckedListBox control.

Inserts an item into the collection at the specified index.

Throws:

ArgumentNullException The item was null.
ArgumentOutOfRangeException The index was less than zero; or the index was greater than the count of items in the collection.

Inserts an item into the collection at the specified index.

Throws:

ArgumentNullException The item was null.
ArgumentOutOfRangeException The index was less than zero; or the index was greater than the count of items in the collection.

Removes an item from the ListBox at the specified index.

Throws:

ArgumentOutOfRangeException The index parameter was less than zero, or the index parameter was greater than or equal to the count of items in the collection.

ItemCheckEventArgs

Wisej.Web.ItemCheckEventArgs

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.1.0.0)

Provides data for the ItemCheck event of the CheckedListBox and ListView controls.

public class ItemCheckEventArgs : EventArgs

Public Class ItemCheckEventArgs
    Inherits EventArgs

Constructors

ItemCheckEventArgs(index, newCheckValue, currentValue)

Initializes a new instance of the ItemCheckEventArgs class.

Name

Type

Description

Properties

CurrentValue

CheckState: Returns a value indicating the current state of the item's check box.

Index

Int32: Returns the zero-based index of the item to change.

CheckState: Returns or sets whether to set the check box for the item to be checked, unchecked, or indeterminate.

Used By

ItemCheckEventHandler

Wisej.Web.ItemCheckEventHandler

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.1.0.0)

Represents the method that will handle the ItemCheck event of a CheckedListBox or ListView control.

public delegate void ItemCheckEventHandler(Object sender, ItemCheckEventArgs e)

Public Delegate Sub ItemCheckEventHandler(ByVal sender As [Object], ByVal e As ItemCheckEventArgs)

Parameters

Name

Type

Description

Fired By

Name

Description

ComboBox.ObjectCollection

Wisej.Web.ComboBox ObjectCollection

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.1.0.0)

Represents the collection of items in a Wisej.Web.ComboBox control.

public class ObjectCollection : IList, ICollection, IEnumerable

Public Class ObjectCollection
    Inherits IList
    Implements ICollection, IEnumerable

Properties

Count

Int32: Returns the number of items in the collection.

IsReadOnly

Boolean: Returns a value indicating whether this collection can be modified.

Item(index)

Object: Retrieves the item at the specified index within the collection.

Throws:

ArgumentOutOfRangeException The index was less than zero; or the index was greater of equal to the count of items in the collection.

Methods

Adds an item to the list of items for a ComboBox.

Returns: Int32. The zero-based index of the item in the collection.

Throws:

ArgumentNullException The item parameter was null.

Adds a collection of items to the list.

Removes all items from the ComboBox.

Determines if the specified item is located within the collection.

Returns: Boolean. true if the item is located within the collection; otherwise, false.

Throws:

ArgumentNullException value is null.

Copies the entire collection into an existing array of objects at a specified location within the array.

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

Returns: IEnumerator. A IEnumerator that represents the item collection.

Retrieves the index within the collection of the specified item.

Returns: Int32. The zero-based index where the item is located within the collection; otherwise, -1.

Throws:

ArgumentNullException The value parameter was null.

Inserts an item into the collection at the specified index.

Throws:

ArgumentNullException The item was null.
ArgumentOutOfRangeException The index was less than zero; or the index was greater than the count of items in the collection.

Removes the specified item from the ComboBox.

Removes an item from the ComboBox at the specified index.

Throws:

ArgumentOutOfRangeException The index parameter was less than zero, or the index parameter was greater than or equal to the count of items in the collection.

Events

CollectionChangeEventHandler Fired when the collection changes.

BaseCollection

Wisej.Web.BaseCollection

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.1.0.0)

Provides the base functionality for creating data-related collections in the DataGridView control.

public class BaseCollection : ICollection, IEnumerable

Public Class BaseCollection
    Inherits ICollection
    Implements IEnumerable

Constructors

BaseCollection()

Initializes a new instance of the BaseCollection class.

Inherited By

Name

Description

DataGridView.CustomSummary

Wisej.Web.DataGridView CustomSummary

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.1.0.0)

Represents a Custom summary function.

public delegate void CustomSummary(DataGridViewRow[] group, DataGridViewColumn summaryColumn)

Public Delegate Sub CustomSummary(ByVal group()

Parameters

Name

Type

Description

DataGridView.HitTestInfo

Wisej.Web.DataGridView HitTestInfo

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.1.0.0)

Provides data about the pointer position in the DataGridView control.

public class HitTestInfo

Public Class HitTestInfo

Properties

Cell

DataGridViewCell: Returns the DataGridViewCell at the specified coordinates.

Column

DataGridViewColumn: Returns the DataGridViewColumn at the specified coordinates.

ColumnIndex

Int32: Returns the index of the column that contains the specified coordinates.

DataGridView

DataGridView: Returns the DataGridView that generate this HitTestInfo instance.

Row

DataGridViewRow: Returns the DataGridViewRow at the specified coordinates.

Int32: Returns the index of the row that contains the specified coordinates

HitTestType: Returns the HitTestType that indicates which part of the DataGridView includes the specified coordinates.

DataGridView.HitTestType

Wisej.Web.DataGridView HitTestType

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.1.0.0)

Specifies the location in a DataGridView control returned by the method HitTest.

public enum HitTestType : Enum

Public Enum HitTestType As [Enum]

Fields

Name

Description

Used By

Name

Description

DataGridViewAutoSizeColumnMode

Wisej.Web.DataGridViewAutoSizeColumnMode

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.1.0.0)

Defines values for specifying how the width of a column is adjusted.

public enum DataGridViewAutoSizeColumnMode : Enum

Public Enum DataGridViewAutoSizeColumnMode As [Enum]

Fields

Name

Description

Used By

Name

Description

DataGridViewAutoSizeRowMode

Wisej.Web.DataGridViewAutoSizeRowMode

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.1.0.0)

Defines how to adjust the height of a row.

public enum DataGridViewAutoSizeRowMode : Enum

Public Enum DataGridViewAutoSizeRowMode As [Enum]

Fields

Name

Description

Used By

Name

Description

DataGridViewAutoSizeRowsMode

Wisej.Web.DataGridViewAutoSizeRowsMode

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.1.0.0)

Defines how to adjust the heights of the rows.

public enum DataGridViewAutoSizeRowsMode : Enum

Public Enum DataGridViewAutoSizeRowsMode As [Enum]

Fields

Name

Description

Used By

Name

Description

DataGridViewBand

Wisej.Web.DataGridViewBand

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.1.0.0)

DataGridViewElement
- DataGridViewBand

Represents a linear collection of elements in a DataGridView control.

public class DataGridViewBand : DataGridViewElement, ICloneable

Public Class DataGridViewBand
    Inherits DataGridViewElement
    Implements ICloneable

Properties

ContextMenu

ContextMenu: Returns or sets the shortcut menu for the row or the column object. (Default: null)

DefaultCellStyle

DataGridViewCellStyle: Returns or sets the default cell style of the band.

DefaultHeaderCellType

Type: Returns or sets the run-time type of the default header cell.

Throws:

ArgumentException The specified value when setting this property is not a Type representing DataGridViewHeaderCell or a derived type.

Boolean: Returns a value indicating whether the band is currently displayed on screen.

Boolean: Returns or sets whether the band will move when a user scrolls through the DataGridView. (Default: False)

Boolean: Returns a value indicating whether the DefaultCellStyle property has been set.

Boolean: Checks if the UserData dynamic object was created and has any value.

Int32: Returns the relative position of the band within the DataGridView control.

DataGridViewCellStyle: Returns the cell style in effect for the current band, taking into account style inheritance.

Boolean: Returns true when the implementation class is DataGridViewRow.

Boolean: Returns or sets whether the user can edit the band's cells. (Default: False)

DataGridViewTriState: Returns or sets whether the band can be resized in the user interface (UI).

Boolean: Returns or sets whether the band is in a selected user interface (UI) state.

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

Object: Returns a dynamic object that can be used to store custom data in relation to this band.

Boolean: Returns or sets whether the band is visible to the user. (Default: True)

Throws:

InvalidOperationException The specified value when setting this property is false and the band is the row for new records.

Methods

Creates an exact copy of this band.

Returns: Object. An Object that represents the cloned DataGridViewBand.

Inherited By

DataGridViewBindingCompleteEventArgs

Wisej.Web.DataGridViewBindingCompleteEventArgs

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.1.0.0)

Provides data for the event.

Constructors

DataGridViewBindingCompleteEventArgs(listChangedType)

Initializes a new instance of the class.

Name

Type

Description

Properties

ListChangedType

: Returns a value specifying how the list changed.

Used By

Name

Description

DataGridViewBindingCompleteEventHandler

Wisej.Web.DataGridViewBindingCompleteEventHandler

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.1.0.0)

Represents the method that will handle the event of a .

Parameters

Name

Type

Description

Fired By

Name

Description

DataGridViewButtonCell

Wisej.Web.DataGridViewButtonCell

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.1.0.0)

Displays a button widget in a cell.

Constructors

DataGridViewButtonCell()

Properties

UseColumnTextForButtonValue

: Gets or sets a value indicating if the button in the cell uses the owning column's text instead of the value of the cell. (Default: False)

ValueType

DataGridViewButtonColumn

Wisej.Web.DataGridViewButtonColumn

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.1.0.0)

Represents a column that contains a collection of cells.

Constructors

DataGridViewButtonColumn()

Initializes a new instance of the class to the default state.

DataGridViewButtonColumn(cellTemplate)

Initializes a new instance of the class to the default state.

Name

Type

Description

Properties

Throws:

This value is inherited by all the cells in the column that do not specify a value for this property. Throws:

Implements

DataGridViewCell

Wisej.Web.DataGridViewCell

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.1.0.0)

Represents an individual cell in a control.

Constructors

DataGridViewCell()

Properties

ColumnIndex

: Returns the column index for this cell.

ContextMenu

: Returns or sets the shortcut menu associated with the cell. (Default: null)

Throws:

Methods

Creates a copy of this cell.

Returns the current, formatted value of the cell, regardless the cell being in edit mode.

Throws:

Returns a value indicating the current state of the cell as inherited from the state of its row and column.

Returns the style applied to the cell.

Throws:

Converts a value to the actual cell value.

Throws:

Updates the cell on the client.

Inherited By

DataGridView

Wisej.Web.DataGridView

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.1.0.0)

Control
- DataGridView

Represents a data grid control.

public class DataGridView : Control, ISupportInitialize, IWisejDataStore, IWisejHandler, IReadOnly

Public Class DataGridView
    Inherits Control
    Implements ISupportInitialize, IWisejDataStore, IWisejHandler, IReadOnly

Constructors

DataGridView()

Initializes a new instance of the DataGridView class.

Properties

AllowSortingDataSource

Boolean: Returns or sets whether the DataGridView can automatically sort rows in the DataSource when the data is in an IList object. (Default: True)

When the DataGridView is data-bound, sorting is delegated to the DataSource when it supports sorting (see SupportsSorting). Otherwise, if the data is in an IList object and AllowSortingDataSource is true, Wisej swaps the rows in the data source. This behavior is different than WinForms, where sorting of the data source is always delegated to the data source and is otherwise ignored. Setting AllowSortingDataSource to false reverts to the same behavior as in WinForms.

AllowUserToAddRows

Boolean: Returns or sets whether the user can add new rows. (Default: False)

Boolean: Returns or sets whether the user is allowed to delete rows from the DataGridView. (Default: False)

Boolean: Returns or sets whether manual column repositioning is enabled. (Default: False)

Boolean: Returns or sets whether users can resize columns. (Default: True)

Boolean: Returns or sets whether users can resize rows. (Default: True)

Boolean: Returns or sets whether columns are created automatically when the DataSource or DataMember properties are set. This property is ignored in design mode - auto column generation is always on. (Default: True)

Boolean: Returns or sets a value that indicates whether the control resizes based on its contents. (Default: False)

DataGridViewAutoSizeColumnsMode: Returns or sets a value indicating how column widths are determined. (Default: None)

DataGridViewAutoSizeRowsMode: Returns or sets a value indicating how row heights are determined. (Default: None)

Throws:

InvalidOperationException The specified value when setting this property is RowHeader and row headers are hidden.

Int32: Number of rows stored in a cache block. Determines the number of rows requested by the client when scrolling the grid.

It's better not to touch this value unless you know what you are doing.

BorderStyle: Returns or sets the border style for the DataGridView. (Default: Solid)

DataGridViewCellBorderStyle: Returns or sets the cell border style for the DataGridView control. (Default: Both)

DataGridViewClipboardCopyMode: Returns or sets a value that indicates whether users can copy cell text values to the Clipboard and whether row and column header text is included. (Default: EnableWithAutoHeaderText)

Int32: Returns or sets the number of columns displayed in the DataGridView. (Default: 0)

Throws:

ArgumentOutOfRangeException The specified value when setting this property is less than 0.
InvalidOperationException When setting this property, the DataSource property has been set.

DataGridViewCellBorderStyle: Returns or sets the border style for the column headers in the DataGridView control. (Default: Both)

DataGridViewCellStyle: Returns or sets the default column header style.

Int32: Returns or sets the height, in pixels, of the column headers row.

Throws:

ArgumentOutOfRangeException The specified value when setting this property is less than the minimum height of 4 pixels or is greater than the maximum height of 32768 pixels.

DataGridViewColumnHeadersHeightSizeMode: Returns or sets whether the height of the column headers is adjustable and whether it can be adjusted by the user or is automatically adjusted to fit the contents of the headers. [Since 3.0.13] (Default: DisableResizing)

Boolean: Returns or sets whether the column header row is displayed. (Default: True)

Throws:

InvalidOperationException The specified value when setting this property is false and one or more columns have an InheritedAutoSizeMode property value of ColumnHeader.

DataGridViewColumnCollection: Returns a collection that contains all the columns in the control.

DataGridViewCell: Returns or sets the currently active cell.

Throws:

InvalidOperationException The value of this property cannot be set because changes to the current cell cannot be committed or canceled. Or the specified cell when setting this property is in a hidden row or column. Re-entrant calling is only allowed when the DataGridView is bound to a DataSource. Re-entrant calling results from a change to the underlying data.
ArgumentException The specified cell when setting this property is not in the DataGridView.

Point: Returns the row and column indexes of the currently active cell.

DataGridViewRow: Returns the row containing the current cell.

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

Throws:

Exception An error occurred in the data source and either there is no handler for the DataError event or the handler has set the ThrowException property to true. The exception object can typically be cast to type FormatException.

Object: Returns or sets the data source that the DataGridView is displaying data for. (Default: null)

Throws:

Exception An error occurred in the data source and either there is no handler for the DataError event or the handler has set the ThrowException property to true. The exception object can typically be cast to type FormatException.

DataGridViewCellStyle: Returns or sets the default cell style to be applied to the cells in the DataGridView if no other cell style properties are set.

Int32: Returns or sets the default row height.

DataGridViewColumnsSortMode: Returns or sets the default SortMode for all columns when the property SortMode is set to NotSet (default). (Default: Automatic)

Control: Returns the control hosted by the current cell, if a cell with an editing control is in edit mode.

DataGridViewEditMode: Returns or sets a value indicating how to begin editing a cell. (Default: EditOnKeystrokeOrF2)

Throws:

Exception The specified value when setting this property would cause the control to enter edit mode, but initialization of the editing cell value failed and either there is no handler for the DataError event or the handler has set the ThrowException property to true. The exception object can typically be cast to type FormatException.

DataGridViewCell: Returns the first cell currently displayed in the DataGridView in the upper left corner.

Int32: Returns the index of the column that is the first non-frozen column displayed on the DataGridView.

Throws:

ArgumentOutOfRangeException The specified value when setting this property is less than 0 or greater than the number of columns in the control minus 1.
InvalidOperationException The specified value when setting this property indicates a column with a Visible property value of false. Or the specified value when setting this property indicates a column with a Frozen property value of true.

Int32: Returns the index of the row that is the first row displayed on the DataGridView.

Throws:

ArgumentOutOfRangeException The specified value when setting this property is less than 0 or greater than the number of rows in the control minus 1.
InvalidOperationException The specified value when setting this property indicates a row with a Visible property value of false. Or the specified value when setting this property indicates a column with a Frozen property value of true.

Int32: Returns the number of pixels by which the control is scrolled horizontally.

Int32: Returns or sets the distance in pixels to indent each child row node level. (Default: -1)

Throws:

ArgumentOutOfRangeException The assigned value is less than 0 (see Remarks); or the assigned value is greater than 500.

Boolean: Returns a value indicating whether the current cell has uncommitted changes.

Boolean: Returns a value indicating whether the currently active cell is being edited.

Boolean: Returns a value indicating whether the current row has uncommitted changes.

DataGridViewCell: Returns or set the cell located in the specified column and at the specified row.

Throws:

ArgumentOutOfRangeException columnIndex is less than 0 or greater than the number of columns in the control minus 1; or rowIndex is less than 0 or greater than the number of rows in the control minus 1.

DataGridViewCell: Returns or set the cell located in the specified column and at the specified row.

DataGridViewCell: Returns or set the cell located in the specified location.

Boolean: Returns or sets whether the rows are always of the same height. (Default: False)

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

Int32: Maximum number of blocks kept in the client cache.

It's better not to touch this value unless you know what you are doing.

Boolean: Returns or sets whether the user is allowed to select more than one cell, row, or column of the DataGridView at a time. (Default: True)

Int32: Returns the index of the row for new records.

String: Returns or sets an HTML string that is displayed when the DataGridView doesn't contain any row. (Default: "")

Boolean: Returns or sets whether the user can edit the cells of the DataGridView control. (Default: False)

Throws:

InvalidOperationException The specified value when setting this property is true, the current cell is in edit mode, and the current cell contains changes that cannot be committed.
Exception The specified value when setting this property would cause the control to enter edit mode, but initialization of the editing cell value failed and either there is no handler for the DataError event or the handler has set the ThrowException property to true. The exception object can typically be cast to type FormatException.

Boolean: Returns or sets whether the row under the pointer gets selected on a right click. (Default: False)

When the right click lands outside of a selected area the selection is not changed regardless of the value of RightClickSelection.

Int32: Returns or sets the number of rows displayed in the DataGridView. (Default: 0)

Throws:

ArgumentException The specified value when setting this property is less than 0 or less than 1 and AllowUserToAddRows is set to true.
InvalidOperationException When setting this property, the DataSource property is set.

DataGridViewColumn: Returns the DataGridViewColumn for the row headers.

Use this DataGridViewColumn to set the style and other properties for all the row headers.

DataGridViewCellStyle: Returns or sets the default style applied to the row header cells.

Int32: Returns or sets the minimum width, in pixels, of the column that contains the row headers.

Throws:

ArgumentOutOfRangeException The value is less than the minimum width of 2 pixels or is greater than the maximum width of 2000 pixels.

Boolean: Returns or sets whether the column that contains row headers is displayed. (Default: True)

Int32: Returns or sets the width, in pixels, of the column that contains the row headers.

Throws:

ArgumentOutOfRangeException The value is less than the minimum width of 2 pixels or is greater than the maximum width of 2000 pixels.

DataGridViewRowHeadersWidthSizeMode: Returns or sets whether the width of the row headers is adjustable and whether it can be adjusted by the user or is automatically adjusted to fit the contents of the headers. (Default: EnableResizing)

DataGridViewRowCollection: Returns a collection that contains all the rows in the DataGridView control.

DataGridViewRow: Returns or sets the row that represents the template for all the rows in the control.

Throws:

InvalidOperationException The specified row when setting this property has its DataGridView property set.

ScrollBars: Returns or sets the type of scroll bars to display for the DataGridView control. (Default: Both)

DataGridViewSelectedCellCollection: Returns the collection of selected cells.

DataGridViewSelectedColumnCollection: Returns the collection of selected columns.

DataGridViewSelectedRowCollection: Returns the collection of selected rows.

Int32: Milliseconds to wait before sending selection events to the server. (Default: 150)

Use this property to avoid flooding the server with selection change events when users quickly select rows in a data-bound DataGridView that triggers other data-bounds controls to get updated. Throws:

ArgumentOutOfRangeException When the value is less than 0 or greater than 10000 (10 seconds).

DataGridViewSelectionMode: Returns or sets a value indicating how the cells of the DataGridView can be selected. (Default: FullRowSelect)

Boolean: Returns or sets whether cells will display an error glyphs for each cell that contains a data entry error. (Default: True)

Boolean: Returns or sets whether or not ToolTips will show when the mouse pointer pauses on a cell. (Default: True)

Boolean: Returns or sets whether the column visibility menu button is visible. (Default: True)

Boolean: Returns or sets a value indicating whether the DataGridView widget highlights the currently focused cell. (Default: True)

Boolean: Returns or sets whether row headers will display an error glyphs for each row that contains a data entry error. (Default: True)

DataGridViewColumn: Returns the column by which the DataGridView contents are currently sorted.

Boolean: Returns or sets whether frozen rows should be sorted when sorting a column. (Default: True)

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

DataGridViewSortSelectionMode: Returns or sets a value indicating how the DataGridView updates the selection of rows and cells when it's sorted. (Default: UpdatePosition)

The selection is always cleared when sorting a data-bound DataGridView or when the grid contains hierarchical rows.

Boolean: Returns or sets whether the TAB key moves the focus to the next control in the tab order rather than moving focus to the next cell. (Default: False)

ComponentToolCollection: Returns the instance of ComponentToolCollection associated with this control.

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

DataGridViewColumnHeaderCell: Returns or sets the header cell located in the upper left corner of the DataGridView control.

DataGridViewColumn: Returns or sets the column that displays the node open/close tree icons.

By default the DataGridView shows the open/close tree icons on the first visible and non-frozen column.

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

Int32: Returns the total number of visible rows currently displayed.

Methods

Creates or updates a DataGridViewSummaryRow for each group limited by the values in column groupCol .

Returns: DataGridViewSummaryRow[]. Array of the DataGridViewSummaryRow rows displaying the aggregated values.

Creates or updates a DataGridViewSummaryRow for each group limited by the values in column groupCol .

Returns: DataGridViewSummaryRow[]. Array of the DataGridViewSummaryRow rows displaying the aggregated values.

Creates or updates a DataGridViewSummaryRow for each group limited by the values in the columns from groupFromCol to groupToCol .

Returns: DataGridViewSummaryRow[]. Array of the DataGridViewSummaryRow rows displaying the aggregated values.

Creates or updates a DataGridViewSummaryRow for each group limited by the values in the columns from groupFromCol to groupToCol .

Returns: DataGridViewSummaryRow[]. Array of the DataGridViewSummaryRow rows displaying the aggregated values.

Creates or updates a DataGridViewSummaryRow for each group limited by the values in columns groupCol .

Returns: DataGridViewSummaryRow[]. Array of the DataGridViewSummaryRow rows displaying the aggregated values.

Creates or updates a DataGridViewSummaryRow for each group limited by the values in columns groupCol .

Returns: DataGridViewSummaryRow[]. Array of the DataGridViewSummaryRow rows displaying the aggregated values.

Creates or updates a DataGridViewSummaryRow for each group limited by the values in the columns from groupFromCol to groupToCol .

Returns: DataGridViewSummaryRow[]. Array of the DataGridViewSummaryRow rows displaying the aggregated values.

Creates or updates a DataGridViewSummaryRow for each group limited by the values in the columns from groupFromCol to groupToCol .

Returns: DataGridViewSummaryRow[]. Array of the DataGridViewSummaryRow rows displaying the aggregated values.

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

Returns: Int32. Numbers of rows appended.

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

Returns whether all the cells are currently selected.

Returns: Boolean. true if all cells (or all visible cells) are selected or if there are no cells (or no visible cells); otherwise, returns false.

Adjusts the width of the column to fit the contents of its cells including the header cell.

Throws:

ArgumentOutOfRangeException columnIndex is not in the valid range of -1 (all columns) to the number of columns minus 1.

Adjusts the width of the column to fit the contents of its cells including the header cell.

Throws:

ArgumentOutOfRangeException columnIndex is not in the valid range of -1 (all columns) to the number of columns minus 1.

Adjusts the width of the specified column using the specified size mode.

Throws:

InvalidOperationException autoSizeMode has the value ColumnHeader and ColumnHeadersVisible is false.
ArgumentException autoSizeMode has the value NotSet, DoubleClick, or Fill.
ArgumentOutOfRangeException columnIndex is not in the valid range of -1 (all columns) to the number of columns minus 1.

Adjusts the width of the specified column using the specified size mode.

Throws:

InvalidOperationException autoSizeMode has the value ColumnHeader and ColumnHeadersVisible is false.
ArgumentException autoSizeMode has the value NotSet, DoubleClick, or Fill.
ArgumentOutOfRangeException columnIndex is not in the valid range of -1 (all columns) to the number of columns minus 1.

Adjusts the height of the column headers to fit the contents of the largest header.

Adjusts the height of the column headers based on the contents of the header in the specified column.

Throws:

ArgumentOutOfRangeException columnIndex is not in the valid range of -1 (all columns) to the number of columns minus 1.

Adjusts the width of all columns to fit the contents of their cells including the header cells.

Adjusts the width of all columns using the specified size mode.

Throws:

InvalidOperationException autoSizeMode has the value ColumnHeader and ColumnHeadersVisible is false.
ArgumentException autoSizeMode has the value DoubleClick or Fill.

Adjusts the width of all columns using the specified size mode.

Throws:

InvalidOperationException autoSizeMode has the value ColumnHeader and ColumnHeadersVisible is false.
ArgumentException autoSizeMode has the value DoubleClick or Fill.

Adjusts the height of the row to fit the contents of all its cells including the header cell.

Throws:

ArgumentOutOfRangeException rowIndex is not in the valid range of -1 (all rows) to the number of rows minus 1.

Adjusts the height of the row to fit the contents of all its cells including the header cell.

Throws:

ArgumentOutOfRangeException rowIndex is not in the valid range of -1 (all rows) to the number of rows minus 1.

Adjusts the height of the row using the specified size mode.

Throws:

InvalidOperationException autoSizeMode has the value RowHeader and RowHeadersVisible is false.
ArgumentOutOfRangeException rowIndex is not in the valid range of -1 (all rows) to the number of rows minus 1.

Adjusts the height of the row using the specified size mode.

Throws:

InvalidOperationException autoSizeMode has the value RowHeader and RowHeadersVisible is false.
ArgumentOutOfRangeException rowIndex is not in the valid range of -1 (all rows) to the number of rows minus 1.

Adjusts the width of the row headers using the specified size mode.

Throws:

ArgumentException autoSizeMode has the value EnableResizing or DisableResizing.

Adjusts the width of the row headers using the specified size mode.

Throws:

ArgumentException autoSizeMode has the value EnableResizing or DisableResizing.

Adjusts the width of the row headers based on the contents of the header in the specified row and using the specified size mode.

Throws:

ArgumentOutOfRangeException rowIndex is not in the valid range of -1 (all rows) to the number of rows minus 1.
ArgumentException autoSizeMode has the value EnableResizing or DisableResizing

Adjusts the width of the row headers based on the contents of the header in the specified row and using the specified size mode.

Throws:

ArgumentOutOfRangeException rowIndex is not in the valid range of -1 (all rows) to the number of rows minus 1.
ArgumentException autoSizeMode has the value EnableResizing or DisableResizing

Adjusts the heights of all rows in the client's data cache to fit the contents of all their cells, including the header cells.

Adjusts the heights of the rows using the specified size mode.

Throws:

ArgumentException autoSizeMode has the value DoubleClick
InvalidOperationException autoSizeMode has the value RowHeader and RowHeadersVisible is false.

Puts the current cell in edit mode.

Returns: Boolean. true if the current cell is already in edit mode or successfully enters edit mode; otherwise, false.

Throws:

InvalidOperationException CurrentCell is not set to a valid cell.

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

Cancels edit mode for the currently selected cell and discards any changes.

Returns: Boolean. true if the cancel was successful; otherwise, false.

Clears the current selection.

Commits changes to cell without ending edit mode.

Returns: Boolean. true if the changes were committed; otherwise false.

Throws:

Exception The cell value could not be committed and either there is no handler for the DataError event or the handler has set the ThrowException property to true.

Commits and ends the edit operation on the current cell.

Returns: Boolean. true if the edit operation is committed and ended; otherwise, false.

Throws:

Exception The cell value could not be committed and either there is no handler for the DataError event or the handler has set the ThrowException property to true.

Resumes updating of the control after it was suspended by the BeginUpdate method.

Populates the DataGridView from the data .

Returns: Int32. Numbers of rows added.

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

Returns the formatted values that represent the contents of the selected cells for copying to the Clipboard.

Returns: DataObject. A DataObject with the contents of the selected cells.

Throws:

NotSupportedException ClipboardCopyMode is set to Disable.

Retrieves the value for the specified cell, as formatted for display, without retrieving a DataGridViewRow and without causing the permanent creation of a row instance. This method is particularly useful when the grid shows a large data set and/or it's operating in VirtualMode.

Returns: Object. The formatted value stored in the cell.

Throws:

ArgumentOutOfRangeException columnIndex is less than 0 or columnIndex is equal to or greater than the number of cells in the collection.
ArgumentOutOfRangeException rowIndex is less than 0.- or - rowIndex is equal to or greater than Count.

Returns: Object. The formatted value stored in the cell.

Throws:

ArgumentNullException column is null.
ArgumentException The specified column does not belong to the same DataGridView that owns the cells.
ArgumentOutOfRangeException rowIndex is less than 0.- or - rowIndex is equal to or greater than Count.

Returns: Object. The formatted value stored in the cell.

Throws:

ArgumentException columnName does not match the name of any columns in the control.
ArgumentOutOfRangeException rowIndex is less than 0.- or - rowIndex is equal to or greater than Count.

Returns the state of the DataGridViewRow at the specified index.

Returns: DataGridViewElementStates. A combination of DataGridViewElementStates values indicating the state of the row.

Throws:

ArgumentOutOfRangeException rowIndex is less than zero and greater than the number of rows in the collection.

Retrieves the value for the specified cell without retrieving a DataGridViewRow and without causing the permanent creation of a row instance. This method is particularly useful when the grid shows a large data set and/or it's operating in VirtualMode.

Returns: Object. The object value stored in the cell.

Throws:

ArgumentOutOfRangeException columnIndex is less than 0 or columnIndex is equal to or greater than the number of cells in the collection.
ArgumentOutOfRangeException rowIndex is less than 0.- or - rowIndex is equal to or greater than Count.

Returns: Object. The object value stored in the cell.

Throws:

ArgumentOutOfRangeException cellAddress is less than 0 or equal to or greater than the number of row or columns in the collection.

Returns: Object. The object value stored in the cell.

Throws:

ArgumentNullException column is null.
ArgumentException The specified column does not belong to the same DataGridView that owns the cells.
ArgumentOutOfRangeException rowIndex is less than 0.- or - rowIndex is equal to or greater than Count.

Returns: Object. The object value stored in the cell.

Throws:

ArgumentException columnName does not match the name of any columns in the control.
ArgumentOutOfRangeException rowIndex is less than 0.- or - rowIndex is equal to or greater than Count.

Returns the column index and row index that contain the specified x, y client coordinates.

Returns: HitTestInfo. A HitTestInfo that contains the column index and row index information.

Returns the column index and row index that contain the specified x, y client coordinates.

Returns: HitTestInfo. A HitTestInfo that contains the column index and row index information.

Checks if the specified cell can enter edit mode.

Returns: Boolean. true is the specified cell, the owner row, owner column and the data source, allow user editing.

Checks if the cell at the colIndex and rowIndex location can enter edit mode.

Returns: Boolean. true is the specified cell, the owner row, owner column and the data source, allow user editing.

Checks if the cell at the cellAddress location can enter edit mode.

Returns: Boolean. true is the specified cell, the owner row, owner column and the data source, allow user editing.

Checks if the specified cell is visible.

Returns: Boolean. true is the specified cell, the owner row, owner column and the data source, allow user editing.

Checks if the cell at the colIndex and rowIndex location is visible.

Returns: Boolean. true is the specified cell, the owner row, owner column and the data source, allow user editing.

Checks if the cell at the cellAddress location is visible.

Returns: Boolean. true is the specified cell, the owner row, owner column and the data source, allow user editing.

Verifies that the cell address refers to a valid cell.

Returns: Boolean. true if the coordinates correspond to a valid cell address.

Verifies that the column index and row index refer to a valid cell.

Returns: Boolean. true if the coordinates correspond to a valid cell address.

Verifies that the column index refer to a valid column.

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

Verifies that the row index refer to a valid row.

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

Notifies the DataGridView that the current cell has uncommitted changes.

Fires the TopLeftHeaderClick event, if MultiSelect is true, selects all the rows in the control.

Throws:

ArgumentOutOfRangeException The value of the ColumnIndex property of e is greater than the number of columns in the control, or the value of the RowIndex property of e is greater than the number of rows in the control.

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

Removes the all the summary rows.

Removes the summary rows that match the specified summaryPosition .

Removes the summary rows grouped by groupFromCol .

Removes the summary rows grouped by groupFromCol and groupToCol .

Removes the summary rows grouped by groupFromCol .

Removes the summary rows grouped by groupFromCol and groupToCol .

Removes the summary rows that match the specified summaryPosition and grouped by groupFromCol .

Removes the summary rows that match the specified summaryPosition and grouped by groupFromCol and groupToCol .

Scrolls the specified cell into view.

Throws:

ArgumentNullException cell is null.
ArgumentException cell doesn't belong to this DataGridView.

Scrolls the specified cell into view aligned according to the position specified by alignX and alignY , if possible.

Throws:

ArgumentNullException cell is null.
ArgumentException cell doesn't belong to this DataGridView.

Scrolls the specified cell into view.

Throws:

ArgumentOutOfRangeException cellAddress .X is less than -1 or greater than the number of columns in the control, or cellAddress .Y is less than -1 or greater than the number of rows in the control.

Scrolls the specified cell into view aligned according to the position specified by alignX and alignY , if possible.

Throws:

ArgumentOutOfRangeException cellAddress .X is less than -1 or greater than the number of columns in the control, or cellAddress .Y is less than -1 or greater than the number of rows in the control.

Scrolls the specified cell into view.

Throws:

ArgumentOutOfRangeException columnIndex is less than -1 or greater than the number of columns in the control, or rowIndex is less than -1 or greater than the number of rows in the control.

Scrolls the specified cell into view aligned according to the position specified by alignX and alignY , if possible.

Throws:

ArgumentOutOfRangeException columnIndex is less than -1 or greater than the number of columns in the control, or rowIndex is less than -1 or greater than the number of rows in the control.

Scrolls the specified column into view.

Throws:

ArgumentOutOfRangeException columnIndex is less than -1 or greater than the number of columns in the control.

Scrolls the specified column into view aligned to the left or right according to the position specified by alignX .

Throws:

ArgumentOutOfRangeException columnIndex is less than -1 or greater than the number of columns in the control.

Scrolls the specified column into view.

Throws:

ArgumentNullException column is null.
ArgumentException column doesn't belong to this DataGridView.

Scrolls the specified column into view aligned to the left or right according to position specified by alignX .

Throws:

ArgumentNullException column is null.
ArgumentException column doesn't belong to this DataGridView.

Scrolls the specified row into view.

Throws:

ArgumentOutOfRangeException rowIndex is less than -1 or greater than the number of rows in the control.

Scrolls the specified row into view aligned to the top or bottom according to the position specified by alignY .

Throws:

ArgumentOutOfRangeException rowIndex is less than -1 or greater than the number of rows in the control.

Scrolls the specified row into view.

Throws:

ArgumentNullException row is null.
ArgumentException row doesn't belong to this DataGridView.

Scrolls the specified row into view aligned to the top or bottom according to the position specified by alignY .

Throws:

ArgumentNullException row is null.
ArgumentException row doesn't belong to this DataGridView.

Selects all the cells, or rows, or columns, according to the SelectionMode property when the MultiSelect is true.

Selects all the cells, regardless of the SelectionMode and MultiSelect properties.

Selects all the columns, regardless of the SelectionMode and MultiSelect properties.

Selects all the rows, regardless of the SelectionMode and MultiSelect properties.

Sets the currently focused cell.

Sets the state for the row at rowIndex .

Throws:

ArgumentOutOfRangeException rowIndex is less than zero and greater than the number of rows in the collection.

Sets the value of the specified cell without retrieving a DataGridViewRow and without causing the permanent creation of a row instance. This method is particularly useful when the grid shows a large data set and/or it's operating in VirtualMode.

Throws:

ArgumentOutOfRangeException columnIndex is less than 0 or columnIndex is equal to or greater than the number of cells in the collection.
ArgumentOutOfRangeException rowIndex is less than 0.- or - rowIndex is equal to or greater than Count.

Throws:

ArgumentOutOfRangeException cellAddress is less than 0 or equal to or greater than the number of row or columns in the collection.

Throws:

ArgumentException columnName does not match the name of any columns in the control.
ArgumentOutOfRangeException rowIndex is less than 0.- or - rowIndex is equal to or greater than Count.

Throws:

ArgumentNullException column is null.
ArgumentException The specified column does not belong to the same DataGridView that owns the cells.
ArgumentOutOfRangeException rowIndex is less than 0.- or - rowIndex is equal to or greater than Count.

Sorts the contents of the DataGridView control in ascending or descending order based on the contents of the specified column.

Throws:

ArgumentException The specified column is not part of this DataGridView; or the DataSource property has been set and the IsDataBound property of the specified column returns false.
ArgumentNullException column is null.
InvalidOperationException The VirtualMode property is set to true and the IsDataBound property of the specified column returns false; or the object specified by the DataSource property does not implement the IBindingList interface; or the object specified by the DataSource property has a SupportsSorting property value of false.

Sorts the contents of the DataGridView control using an implementation of the IComparer interface.

Throws:

ArgumentNullException comparer is null.
InvalidOperationException VirtualMode is set to true; or DataSource is not null.

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

EventHandler Fired when the value of the AllowUserToAddRows property changes.

EventHandler Fired when the value of the AllowUserToDeleteRowsChanged property changes.

EventHandler Fired when the value of the AllowUserToOrderColumns property changes.

EventHandler Fired when the value of the AllowUserToResizeColumns property changes.

EventHandler Fired when the value of the AllowUserToResizeRows property changes.

DataGridViewCellCancelEventHandler Fired when edit mode starts for the selected cell.

DataGridViewCellEventHandler Fired when any part of a cell is clicked.

DataGridViewCellContextMenuNeededEventHandler Fired when a cell's context menu is needed.

DataGridViewCellEventHandler Fired when the user double-clicks anywhere in a cell.

DataGridViewCellEventHandler Fired when edit mode stops for the current cell.

DataGridViewCellEventHandler Fired when the current cell changes in the DataGridView control or when the control receives input focus.

DataGridViewCellEventHandler Fired when the value of the ErrorText property of a cell changes.

DataGridViewCellErrorTextNeededEventHandler Fired when a cell's error text is needed.

DataGridViewCellFormattingEventHandler Fired when the contents of a cell need to be formatted for display.

DataGridViewCellEventHandler Fired when a cell loses input focus and is no longer the current cell.

DataGridViewCellMouseEventHandler Occurs whenever the user clicks anywhere on a cell with the mouse.

DataGridViewCellMouseEventHandler Fired when a cell within the DataGridView is double-clicked.

DataGridViewCellMouseEventHandler Fired when the user presses a mouse button while the pointer is within the boundaries of a cell.

DataGridViewCellEventHandler Fired when the mouse pointer enters a cell.

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.

DataGridViewCellEventHandler Fired when the mouse pointer leaves a cell.

DataGridViewCellMouseEventHandler Fired when the mouse pointer moves over the DataGridView control.

DataGridViewCellMouseEventHandler Fired when the user releases a mouse button while over a cell.

DataGridViewCellPaintEventHandler Fired when a cell with the property UserPaint set to true needs to be drawn.

DataGridViewCellParsingEventHandler Fired when a cell leaves edit mode if the cell value has been modified.

DataGridViewCellStateChangedEventHandler Fired when a cell state changes, such as when the cell is selected or focused.

DataGridViewCellEventHandler Fired when the Style property of a DataGridViewCell changes.

DataGridViewCellStyleContentChangedEventHandler Fired when one of the values of a cell style changes.

DataGridViewToolClickEventHandler Fired when a ComponentTool hosted in a cell editor is clicked.

DataGridViewCellEventHandler Fired when the value of the ToolTipText property of a cell changes.

DataGridViewCellToolTipTextNeededEventHandler Fired when a cell's ToolTip text is needed.

DataGridViewCellEventHandler Occurs after the cell has finished validating.

DataGridViewCellValidatingEventHandler Fired when a cell loses input focus, enabling content validation.

DataGridViewCellEventHandler Fired when the value of a cell changes.

DataGridViewCellValueEventHandler Fired when the VirtualMode property of the DataGridView control is true and the DataGridView requires a value for a cell in order to format and display the cell.

DataGridViewCellValueEventHandler Fired when the VirtualMode property of the DataGridView control is true and a cell value has changed and requires storage in the underlying data source.

DataGridViewColumnEventHandler Fired when a column is added to the control.

DataGridViewColumnEventHandler Fired when the value the DisplayIndex property for a column changes.

DataGridViewColumnEventHandler Fired when the FillWeight property changes.

DataGridViewCellMouseEventHandler Fired when the user clicks a column header.

DataGridViewCellMouseEventHandler Fired when a column header is double-clicked.

EventHandler Fired when the value of the ColumnHeadersHeight property changes.

DataGridViewColumnEventHandler Fired when the value of the MaximumWidth property for a column changes.

DataGridViewColumnEventHandler Fired when the value of the MinimumWidth property for a column changes.

DataGridViewColumnEventHandler Fired when the Name property changes.

DataGridViewColumnEventHandler Fired when a column is removed from the control.

DataGridViewColumnEventHandler Fired when the value of the SortMode property changes.

DataGridViewColumnStateChangedEventHandler Fired when a column changes state, such as becoming visible.

DataGridViewColumnEventHandler Fired when the value of the Width property for a column changes.

EventHandler Fired when the CurrentCell property changes.

DataGridViewBindingCompleteEventHandler Occurs after a data-binding operation has finished.

DataGridViewDataErrorEventHandler Fired when a data parsing or data validation operation throws an exception, or when committing data to a data source fails.

EventHandler Fired when value of the DataMember property changes.

DataGridViewDataReadEventHandler Occurs when the client requests a set of rows from the server.

You can use this event when the DataGridView is in VirtualMode to pre-populate a paged data set used when handling the CellValueNeeded events.

EventHandler Fired when the value of the DataSource property changes.

DataGridViewDataUpdatedEventHandler Fired when the client has updated one or more rows in the grid.

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

EventHandler Fired when the value of the DefaultRowHeight property changes.

DataGridViewRowEventHandler Fired when the user enters the row for new records so that it can be populated with default values.

DataGridViewEditingControlShowingEventHandler Fired when a control for editing a cell is showing.

EventHandler Fired when the value of the EditMode property changes.

EventHandler Fired when the value of the KeepSameRowHeight property changes.

DataGridViewCellEventHandler Fired when the user tabs past the last cell.

EventHandler Fired when the value of the LiveResize property changes.

EventHandler Fired when the value of the MultiSelect property changes.

DataGridViewRowEventHandler Fired when the VirtualMode property of the DataGridView is true and the user navigates to the new row at the bottom of the DataGridView.

EventHandler Fired when the value of the ReadOnly property changes.

DataGridViewRowEventHandler Fired when a parent row is collapsed.

DataGridViewCellEventHandler Fired when a row receives input focus but before it becomes the current row.

DataGridViewRowEventHandler Fired when the ErrorText property of a row changes.

DataGridViewRowErrorTextNeededEventHandler Fired when the row's error text is required.

DataGridViewRowEventHandler Fired when a parent row is expanded.

DataGridViewCellMouseEventHandler Fired when the user clicks within the boundaries of a row header.

DataGridViewCellMouseEventHandler Fired when a row header is double-clicked.

EventHandler Fired when value of the RowHeadersWidth property changes.

DataGridViewRowEventHandler Fired when the value of the Height property for a row changes.

DataGridViewRowHeightInfoNeededEventHandler Fired when information about row height is requested.

DataGridViewCellEventHandler Fired when a row loses input focus and is no longer the current row.

DataGridViewRowEventHandler Fired when the value of the MaximumHeight property for a row changes.

DataGridViewRowEventHandler Fired when the value of the MinimumHeight property for a row changes.

DataGridViewRowsAddedEventHandler Occurs after a new row is added to the DataGridView.

DataGridViewRowsRemovedEventHandler Fired when a row or rows are deleted from the DataGridView.

DataGridViewRowStateChangedEventHandler Fired when a row changes state, such as getting selected.

DataGridViewCellEventHandler Occurs after a row has finished validating.

DataGridViewCellCancelEventHandler Fired when a row is validating.

ScrollEventHandler Fired when the user or code scrolls the grid.

EventHandler Fired when the current selection changes.

EventHandler Fired when the value of the ShowColumnVisibilityMenu property changes.

DataGridViewSortCompareEventHandler Fired when the DataGridView compares two cell values to perform a sort operation.

EventHandler Fired when the DataGridView control completes a sorting operation.

EventHandler Fired when the value of the StandardTab property changes.

ToolClickEventHandler Fired when a ComponentTool is clicked.

DataGridViewCellCancelEventHandler Fired when the user presses a mouse button while the pointer is on the top-left corner cell.

DataGridViewRowEventHandler Fired when the user has finished adding a row to the DataGridView control.

DataGridViewRowEventHandler Fired when the user has finished deleting a row from the DataGridView control.

DataGridViewRowCancelEventHandler Fired when the user deletes a row from the DataGridView control.

Implements

ComboBox

Wisej.Web.ComboBox

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.1.0.0)

Control
- ListControl
  - ComboBox

Represents a combo box control.

public class ComboBox : ListControl, IModified, ILabel, IReadOnly

Public Class ComboBox
    Inherits ListControl
    Implements IModified, ILabel, IReadOnly

Constructors

ComboBox()

Initializes an instance of ComboBox.

Properties

AllowHtml

Boolean: Returns or sets a value indicating that the control can display html in the Text property. (Default: False)

AutoCompleteMode

AutoCompleteMode: Returns or sets how automatic completion works for the ComboBox. (Default: None)

Boolean: Returns or sets whether the height of the control is set automatically. (Default: True)

CharacterCasing: Returns or sets whether the ComboBox control modifies the case of characters as they are typed. (Default: Normal)

Int32: Returns or sets the maximum height in pixels of the drop-down portion of the ComboBox. (Default: 400)

Throws:

ArgumentException The specified value is less than one.

ComboBoxStyle: Returns or sets the drop down style of the combo box. (Default: DropDown)

Int32: Returns or sets the maximum width in pixels of the drop-down list of the ComboBox. When the value is 0, the drop-down list will grow to fit the largest item. (Default: 0)

Throws:

ArgumentException The specified value is less than one.

Boolean: Returns or sets whether the combo box is displaying its drop-down portion.

Boolean: Enables or disables the browser's context menu. (Default: True)

Boolean: Returns or sets whether items are selected incrementally as the user types within a timeout of 1 second. (Default: True)

Int32: Gets or sets the height of the list items in the drop-down list. When the value is -1, uses the value set in the theme. (Default: -1)

Throws:

ArgumentOutOfRangeException The assigned value is less than -1; or the assigned value is greater than 500.

ObjectCollection: Returns the collection of the items contained in this ComboBox.

LabelWrapper: Provides a label related to the control.

String: Returns or sets the localizable label associated with this control. (Default: "")

Boolean: Returns or sets whether the items are sent to the client the first time the list is opened and enables the Load event. (Default: False)

Int32: Returns or sets the number of characters a user can type into the ComboBox. (Default: 0)

Throws:

ArgumentOutOfRangeException The value is less than 0.

Boolean: Returns or sets whether the control is read-only. (Default: False)

Int32: Returns or sets the index of the currently selected item.

Throws:

ArgumentOutOfRangeException The specified index is less than -1; o the specified index is greater than the number of items in the combo box.

Object: Returns or sets currently selected item in the ComboBox.

String: Returns or sets the text that is selected in the editable portion of a ComboBox.

Int32: Returns or sets the number of characters selected in the editable portion of the combo box.

Throws:

ArgumentException The value was less than zero.

Int32: Returns or sets the starting index of text selected in the combo box.

Throws:

ArgumentException The value is less than zero.

Boolean: Returns or sets whether the items in the combo box are sorted. (Default: False)

Throws:

ArgumentException An attempt was made to sort a ComboBox that is attached to a data source.

Boolean: Returns or sets whether the text in the ComboBox is spell checked by the browser. (Default: False)

String: Returns or sets the text associated with this control. (Default: "")

ComponentToolCollection: Returns the instance of ComponentToolCollection associated with this control.

String: Returns or sets the text to show when the control is empty. (Default: null)

Methods

Not used. Kept for compatibility.

Copies the current selection in the text box to the Clipboard.

Moves the current selection in the text box to the Clipboard.

Not used. Kept for compatibility.

Returns the index of the first item in the ComboBox that starts with the specified string.

Returns: Int32. The zero-based index of the first item found; returns -1 if no match is found.

Returns the index of the first item in the ComboBox beyond the specified index that contains the specified string. The search is not case sensitive.

Returns: Int32. The zero-based index of the first item found; returns -1 if no match is found, or 0 if the text parameter specifies Empty.

Finds the first item in the combo box that matches the specified string.

Returns: Int32. The zero-based index of the first item found; returns -1 if no match is found, or 0 if the text parameter specifies Empty.

Finds the first item after the specified index that matches the specified string.

Returns: Int32. The zero-based index of the first item found; returns -1 if no match is found, or 0 if the text parameter specifies Empty.

Replaces the current selection in the text box with the contents of the Clipboard.

Selects a range of text in the editable portion of the ComboBox.

Selects all the text in the editable portion of the ComboBox.

Events

HandledEventHandler Fired when before the Validating event when the DropDownStyle is set to DropDown or Simple.

The application may implement a different way to select the item when the user types a text and the ComboBox is validated. Set e.Handled to true to override the standard behavior.



this.comboBox1.AutoComplete += (s, e) =>
{
  if (this.comboBox1.Text == "T")
  {
    this.compoBox1.SelectedIndex = 1;
    e.Handled = true;
  }
}

EventHandler Fired when the drop-down portion of a ComboBox is shown.

EventHandler Fired when the drop-down portion of the ComboBox is no longer visible.

EventHandler Fired when the DropDownStyle property has changed.

EventHandler Fired when the drop-down list is first opened and the LazyLoading property is true.

When LazyLoading is true An application may fill the items at any time prior to the drop-down list being opened, or while processing the DropDown or Load event.

EventHandler Fired when the value of the ReadOnly property has changed.

EventHandler Fired when the SelectedIndex property has changed.

EventHandler Fired when the SelectedItem property has changed.

EventHandler Fired when the selected item has changed and that change is displayed in the ComboBox.

EventHandler Fired when the Sorted property has changed.

ToolClickEventHandler Fired when a ComponentTool is clicked.