DataGridView
Wisej.Web.DataGridView
Namespace: Wisej.Web
Assembly: Wisej.Framework (3.0.0.0)
Represents a data grid control.
C#
VB.NET
1
public class DataGridView : Control, ISupportInitialize, IWisejDataStore, IWisejHandler, IReadOnly
Copied!
1
Public Class DataGridView
2
Inherits Control
3
Implements ISupportInitialize, IWisejDataStore, IWisejHandler, IReadOnly
Copied!
Constructors
DataGridView()
Properties
AllowSortingDataSource
Boolean: Returns or sets whether the DataGridView can automatically sort rows in the DataSource when the data is in an IList object.
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
AllowUserToDeleteRows
AllowUserToOrderColumns
AllowUserToResizeColumns
AllowUserToResizeRows
AutoGenerateColumns
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.
AutoSize
AutoSizeColumnsMode
DataGridViewAutoSizeColumnsMode: Returns or sets a value indicating how column widths are determined.
AutoSizeRowsMode
Throws:
- InvalidOperationException The specified value when setting this property is AllHeaders or DisplayedHeaders and row headers are hidden.
BlockSize
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
CellBorderStyle
ClipboardCopyMode
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.
ColumnCount
Throws:
- ArgumentOutOfRangeException The specified value when setting this property is less than 0. * InvalidOperationException When setting this property, the DataSource property has been set.
ColumnHeadersBorderStyle
DataGridViewCellBorderStyle: Returns or sets the border style for the column headers in the DataGridView control.
ColumnHeadersDefaultCellStyle
ColumnHeadersHeight
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.
ColumnHeadersHeightSizeMode
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.
ColumnHeadersVisible
Throws:
- InvalidOperationException The specified value when setting this property is false and one or more columns have an InheritedAutoSizeMode property value of ColumnHeader.
Columns
CurrentCell
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.
CurrentCellAddress
CurrentRow
DataMember
String: Returns or sets the name of the list or table in the data source for which the DataGridView is displaying data.
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.
DataSource
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.
DefaultCellStyle
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.
DefaultRowHeight
DefaultSortMode
DataGridViewColumnsSortMode: Returns or sets the default SortMode for all columns when the property SortMode is set to NotSet (default).
EditingControl
Control: Returns the control hosted by the current cell, if a cell with an editing control is in edit mode.
EditMode
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.
FirstDisplayedCell
DataGridViewCell: Returns the first cell currently displayed in the DataGridView in the upper left corner.
FirstDisplayedColumnIndex
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.
FirstDisplayedRowIndex
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.
HorizontalScrollingOffset
Indent
Throws:
- ArgumentOutOfRangeException The assigned value is less than 0 (see Remarks); or the assigned value is greater than 500.
IsCurrentCellDirty
IsCurrentCellInEditMode
IsCurrentRowDirty
Item(columnIndex, rowIndex)
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.
Item(columnName, rowIndex)
DataGridViewCell: Returns or set the cell located in the specified column and at the specified row.
Item(column, rowIndex)
DataGridViewCell: Returns or set the cell located in the specified column and at the specified row.
Item(cellAddress)
KeepSameRowHeight
LiveResize
Boolean: Returns or sets whether the column and row resizing should be live: updated as the user resizes the row or the column.
MaxCachedBlocks
It's better not to touch this value unless you know what you are doing.
MultiSelect
Boolean: Returns or sets whether the user is allowed to select more than one cell, row, or column of the DataGridView at a time.
NewRowIndex
NoDataMessage
String: Returns or sets an HTML string that is displayed when the DataGridView doesn't contain any row.
ReadOnly
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.
RightClickSelection
When the right click lands outside of a selected area the selection is not changed regardless of the value of RightClickSelection.
RowCount
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.
RowHeadersDefaultCellStyle
RowHeadersMinimumWidth
Throws:
- ArgumentOutOfRangeException The value is less than the minimum width of 2 pixels or is greater than the maximum width of 2000 pixels.
RowHeadersVisible
Throws:
- InvalidOperationException The specified value when setting this property is false and the AutoSizeRowsMode property is set to AllHeaders or DisplayedHeaders.
RowHeadersWidth
Throws:
- ArgumentOutOfRangeException The value is less than the minimum width of 2 pixels or is greater than the maximum width of 2000 pixels.
RowHeadersWidthSizeMode
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.
Rows
DataGridViewRowCollection: Returns a collection that contains all the rows in the DataGridView control.
RowTemplate
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
SelectedCells
SelectedColumns
SelectedRows
SelectionDelay
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:
SelectionMode
DataGridViewSelectionMode: Returns or sets a value indicating how the cells of the DataGridView can be selected.
ShowCellErrors
Boolean: Returns or sets whether cells will display an error glyphs for each cell that contains a data entry error.
ShowCellToolTips
Boolean: Returns or sets whether or not ToolTips will show when the mouse pointer pauses on a cell.
ShowColumnVisibilityMenu
ShowFocusCell
Boolean: Returns or sets a value indicating whether the DataGridView widget highlights the currently focused cell.
ShowRowErrors
Boolean: Returns or sets whether row headers will display an error glyphs for each row that contains a data entry error.
SortedColumn
SortFrozenRows
SortOrder
SortOrder: Returns a value indicating whether the items in the DataGridView control are sorted in ascending or descending order, or are not sorted.
SortSelectionMode
DataGridViewSortSelectionMode: Returns or sets a value indicating how the DataGridView updates the selection of rows and cells when it's sorted.
The selection is always cleared when sorting a data-bound DataGridView or when the grid contains hierarchical rows.
StandardTab
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.
Tools
ComponentToolCollection: Returns the instance of ComponentToolCollection associated with this control.
ToolsPosition
Position: Returns or sets the position of the T:Wisej.Web.ComponentTool items associated with this control.
TopLeftHeaderCell
DataGridViewHeaderCell: Returns the header cell located in the upper left corner of the DataGridView control.
TreeColumn
By default the DataGridView shows the open/close tree icons on the first visible and non-frozen column.
VirtualMode
Boolean: Returns or sets whether you have provided your own data-management operations for the DataGridView control.
VisibleRowCount
Methods
AddSummaryRows(summaryType, groupCol, summaryCol, style, customSummary)
Creates or updates a DataGridViewSummaryRow for each group limited by the values in column groupCol .
Parameter
Type
Description
Returns: DataGridViewSummaryRow[]. Array of the DataGridViewSummaryRow rows displaying the aggregated values.
AddSummaryRows(summaryType, summaryPosition, groupCol, summaryCol, style, customSummary)
Creates or updates a DataGridViewSummaryRow for each group limited by the values in column groupCol .
Parameter
Type
Description
Returns: DataGridViewSummaryRow[]. Array of the DataGridViewSummaryRow rows displaying the aggregated values.
AddSummaryRows(summaryType, groupFromCol, groupToCol, summaryCol, style, customSummary)
Creates or updates a DataGridViewSummaryRow for each group limited by the values in the columns from groupFromCol to groupToCol .
Parameter
Type
Description
Returns: DataGridViewSummaryRow[]. Array of the DataGridViewSummaryRow rows displaying the aggregated values.
AddSummaryRows(summaryType, summaryPosition, groupFromCol, groupToCol, summaryCol, style, customSummary)
Creates or updates a DataGridViewSummaryRow for each group limited by the values in the columns from groupFromCol to groupToCol .
Parameter
Type
Description
Returns: DataGridViewSummaryRow[]. Array of the DataGridViewSummaryRow rows displaying the aggregated values.
AddSummaryRows(summaryType, groupCol, summaryCol, style, customSummary)
Creates or updates a DataGridViewSummaryRow for each group limited by the values in columns groupCol .
Parameter
Type
Description
Returns: DataGridViewSummaryRow[]. Array of the DataGridViewSummaryRow rows displaying the aggregated values.
AddSummaryRows(summaryType, summaryPosition, groupCol, summaryCol, style, customSummary)
Creates or updates a DataGridViewSummaryRow for each group limited by the values in columns groupCol .
Parameter
Type
Description
Returns: DataGridViewSummaryRow[]. Array of the DataGridViewSummaryRow rows displaying the aggregated values.
AddSummaryRows(summaryType, groupFromCol, groupToCol, summaryCol, style, customSummary)
Creates or updates a DataGridViewSummaryRow for each group limited by the values in the columns from groupFromCol to groupToCol .
Parameter
Type
Description
Returns: DataGridViewSummaryRow[]. Array of the DataGridViewSummaryRow rows displaying the aggregated values.
AddSummaryRows(summaryType, summaryPosition, groupFromCol, groupToCol, summaryCol, style, customSummary)
Creates or updates a DataGridViewSummaryRow for each group limited by the values in the columns from groupFromCol to groupToCol .
Parameter
Type
Description
Returns: DataGridViewSummaryRow[]. Array of the DataGridViewSummaryRow rows displaying the aggregated values.
Append(data, dataMember)
Parameter
Type
Description
dataMember
AreAllCellsSelected(includeInvisibleCells)
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.
AutoResizeColumn(columnIndex)
Adjusts the width of the column to fit the contents of its cells including the header cell.
Parameter
Type
Description
Throws:
- ArgumentOutOfRangeException columnIndex is not in the valid range of -1 (all columns) to the number of columns minus 1.
AutoResizeColumn(columnIndex, extraSpace)
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.
AutoResizeColumn(columnIndex, autoSizeMode)
Adjusts the width of the specified column using the specified size mode.
Parameter
Type
Description
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.
AutoResizeColumn(columnIndex, autoSizeMode, extraSpace)
Adjusts the width of the specified column using the specified size mode.
Parameter
Type
Description
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.
AutoResizeColumnHeadersHeight()
Adjusts the height of the column headers to fit the contents of the largest header.
AutoResizeColumnHeadersHeight(columnIndex)
Adjusts the height of the column headers based on the contents of the header in the specified column.
Parameter
Type
Description
Throws:
- ArgumentOutOfRangeException columnIndex is not in the valid range of -1 (all columns) to the number of columns minus 1.
AutoResizeColumns(autoSizeMode)
Adjusts the width of all columns using the specified size mode.
Parameter
Type
Description
Throws:
- InvalidOperationException autoSizeMode has the value ColumnHeader and ColumnHeadersVisible is false. * ArgumentException autoSizeMode has the value DoubleClick or Fill.
AutoResizeColumns(autoSizeMode, extraSpace)
Adjusts the width of all columns using the specified size mode.