Namespace: Wisej.Web

Assembly: Wisej.Framework (3.5.0.0)

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

public enum DataGridViewAutoSizeColumnMode : Enum

Public Enum DataGridViewAutoSizeColumnMode As [Enum]

Fields

Used By

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.5.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

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.5.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.

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.5.0.0)

Represents a Custom summary function.

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

Public Delegate Sub CustomSummary(ByVal group()

Parameters

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.5.0.0)

Defines how to adjust the heights of the rows.

public enum DataGridViewAutoSizeRowsMode : Enum

Public Enum DataGridViewAutoSizeRowsMode As [Enum]

Fields

Used By

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.5.0.0)

Defines values for specifying how the widths of columns are adjusted.

public enum DataGridViewAutoSizeColumnsMode : Enum

Public Enum DataGridViewAutoSizeColumnsMode As [Enum]

Fields

Used By

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.5.0.0)

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

public enum HitTestType : Enum

Public Enum HitTestType As [Enum]

Fields

Used By

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.5.0.0)

Defines how to adjust the height of a row.

Fields

Used By

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.5.0.0)

Provides data for the DataBindingComplete event.

public class DataGridViewBindingCompleteEventArgs : EventArgs

Public Class DataGridViewBindingCompleteEventArgs
    Inherits EventArgs

Constructors

DataGridViewBindingCompleteEventArgs(listChangedType)

Initializes a new instance of the DataGridViewBindingCompleteEventArgs class.

Properties

ListChangedType

ListChangedType: Returns a value specifying how the list changed.

Used By

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.5.0.0)

Represents the method that will handle the DataBindingComplete event of a DataGridView.

public delegate void DataGridViewBindingCompleteEventHandler(Object sender, DataGridViewBindingCompleteEventArgs e)

Public Delegate Sub DataGridViewBindingCompleteEventHandler(ByVal sender As [Object], ByVal e As DataGridViewBindingCompleteEventArgs)

Parameters

Fired By

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.5.0.0)

• DataGridViewElement

  • DataGridViewCell

    • DataGridViewButtonCell

Displays a button widget in a DataGridViewCell cell.

public class DataGridViewButtonCell : DataGridViewCell

Public Class DataGridViewButtonCell
    Inherits DataGridViewCell

Constructors

DataGridViewButtonCell()

Initializes a new instance of DataGridViewButtonCell.

Properties

UseColumnTextForButtonValue

Boolean: 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

Type: Returns or sets the data type of the values in the cell.

Implements

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.5.0.0)

• DataGridViewElement

  • DataGridViewBand

    • DataGridViewColumn

      • DataGridViewButtonColumn

Represents a DataGridView column that contains a collection of DataGridViewButtonCell cells.

public class DataGridViewButtonColumn : DataGridViewColumn

Public Class DataGridViewButtonColumn
    Inherits DataGridViewColumn

Constructors

DataGridViewButtonColumn()

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

DataGridViewButtonColumn(cellTemplate)

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

Properties

DataGridViewCell: Returns or sets the template used to model cell appearance.

Throws:

• InvalidOperationException The type is null.

• InvalidCastException The set type is not compatible with type DataGridViewButtonCell.

String: Gets or sets the default text displayed on the button cell when UseColumnTextForButtonValue is true. (Default: "")

Throws:

• InvalidOperationException When setting this property, the value of the CellTemplate property is null.

Boolean: 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)

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

• InvalidOperationException The property CellTemplate is null.

Implements

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.5.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

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.5.0.0)

Represents the method that will handle the CellBeginEdit and RowValidating events of a DataGridView.

public delegate void DataGridViewCellCancelEventHandler(Object sender, DataGridViewCellCancelEventArgs e)

Public Delegate Sub DataGridViewCellCancelEventHandler(ByVal sender As [Object], ByVal e As DataGridViewCellCancelEventArgs)

Parameters

Fired By

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.5.0.0)

Provides data for the CellBeginEdit and RowValidating events.

public class DataGridViewCellCancelEventArgs : CancelEventArgs

Public Class DataGridViewCellCancelEventArgs
    Inherits CancelEventArgs

Constructors

DataGridViewCellCancelEventArgs(columnIndex, rowIndex)

Initializes a new instance of the DataGridViewCellCancelEventArgs class.

Throws:

• ArgumentOutOfRangeException columnIndex is less than -1; or rowIndex is less than -1.

Properties

ColumnIndex

Int32: Returns the column index of the cell that the event occurs for.

Int32: Returns the row index of the cell that the event occurs for.

Used By

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.5.0.0)

• BaseCollection

  • DataGridViewCellCollection

Represents a collection of cells in a DataGridViewRow.

public class DataGridViewCellCollection : BaseCollection, IList, IList<DataGridViewCell>, ICollection<DataGridViewCell>, IEnumerable<DataGridViewCell>

Public Class DataGridViewCellCollection
    Inherits BaseCollection
    Implements IList, IList(Of DataGridViewCell), ICollection(Of DataGridViewCell), IEnumerable(Of DataGridViewCell)

Constructors

DataGridViewCellCollection(row)

Initializes a new instance of the DataGridViewCellCollection class.

Properties

Item(column)

DataGridViewCell: Returns or sets the cell contained in the specified column .

Throws:

• ArgumentNullException The specified value when setting this property is null; or column is null.

• InvalidOperationException The specified cell when setting this property already belongs to a DataGridView control, or the specified cell when setting this property already belongs to a DataGridViewRow

• ArgumentNullException column is null.

• ArgumentException The specified column does not belong to the same DataGridView that owns the cells.

• ArgumentOutOfRangeException The index of the specified column is less than 0 or is equal to or greater than the number of cells in the collection.

DataGridViewCell: Returns or sets the cell at the provided index location.

Throws:

• ArgumentNullException The specified value when setting this property is null.

• InvalidOperationException The specified cell when setting this property already belongs to a DataGridView control, or the specified cell when setting this property already belongs to a DataGridViewRow.

• ArgumentOutOfRangeException index is less than 0 or index is equal to or greater than the number of cells in the collection.

DataGridViewCell: Returns or sets the cell in the column with the provided name.

Throws:

• ArgumentException columnName does not match the name of any columns in the control.

• ArgumentNullException The specified value when setting this property is null; or columnName is null.

• InvalidOperationException The specified cell when setting this property already belongs to a DataGridView control, or the specified cell when setting this property already belongs to a DataGridViewRow.

Methods

Adds a cell to the collection.

Returns: Int32. The position in which to insert the new element.

Throws:

• InvalidOperationException The row that owns this DataGridViewCellCollection already belongs to a DataGridView control, or cell already belongs to a DataGridViewRow.

Adds an array of cells to the collection.

Throws:

• ArgumentNullException cells is null.

• InvalidOperationException The row that owns this DataGridViewCellCollection already belongs to a DataGridView control, or at least one value in cells is null, or at least one cell in cells already belongs to a DataGridViewRow, or at least two values in cells are references to the same DataGridViewCell.

Adds an array of cells to the collection.

Throws:

• ArgumentNullException cells is null.

• InvalidOperationException The row that owns this DataGridViewCellCollection already belongs to a DataGridView control, or at least one value in cells is null, or at least one cell in cells already belongs to a DataGridViewRow, or at least two values in cells are references to the same DataGridViewCell.

Clears all cells from the collection.

Throws:

• InvalidOperationException The row that owns this DataGridViewCellCollection already belongs to a DataGridView control.

Determines whether the specified cell is contained in the collection.

Returns: Boolean. true if cell is in the collection; otherwise, false.

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

Returns the index of the specified cell.

Returns: Int32. The zero-based index of the value of cell parameter, if it is found in the collection; otherwise, -1.

Inserts a cell into the collection at the specified index.

Throws:

• InvalidOperationException The row that owns this DataGridViewCellCollection already belongs to a DataGridView control, or cell already belongs to a DataGridViewRow.

Removes the specified cell from the collection.

Throws:

• InvalidOperationException The row that owns this DataGridViewCellCollection already belongs to a DataGridView control.

• ArgumentException cell could not be found in the collection.

Removes the cell at the specified index.

Throws:

• InvalidOperationException The row that owns this DataGridViewCellCollection already belongs to a DataGridView control.

Events

CollectionChangeEventHandler Fired when the collection changes.

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.5.0.0)

• DataGridViewElement

  • DataGridViewCell

Represents an individual cell in a DataGridView control.

public class DataGridViewCell : DataGridViewElement, ICloneable, ICommandSource

Public Class DataGridViewCell
    Inherits DataGridViewElement
    Implements ICloneable, ICommandSource

Constructors

DataGridViewCell()

Initializes a new instance of DataGridViewCell.

Properties

ColumnIndex

Int32: Returns the column index for this cell.

Command

ICommand: Returns or sets the ICommand implementation to invoke. (Default: null)

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

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

DataGridView: Returns the DataGridView control associated with this DataGridViewCell.

Object: Returns the default value for a cell in the row for new records.

Boolean: Returns a value that indicates whether the cell is currently displayed.

Boolean: Returns whether the cell can be edited.

Object: Returns the current, formatted value of the cell, regardless of whether the cell is in edit mode and the value has not been committed.

Throws:

• ArgumentOutOfRangeException The row containing the cell is a shared row; or the cell is a column header cell.

• InvalidOperationException ColumnIndex is less than 0, indicating that the cell is a row header cell.

• Exception Formatting failed and either there is no handler for the DataError event of the DataGridView control or the handler set the ThrowException property to true. The exception object can typically be cast to type FormatException.

String: Returns or sets the text describing an error condition associated with the cell.

Object: Returns the value of the cell as formatted for display.

Throws:

• InvalidOperationException ColumnIndex is less than 0, indicating that the cell is a row header cell.

• ArgumentOutOfRangeException The row containing the cell is a shared row; or the cell is a column header cell.

• Exception Formatting failed and either there is no handler for the DataError event of the DataGridView control or the handler set the ThrowException property to true. The exception object can typically be cast to type FormatException.

Type: Returns the type of the formatted value associated with the cell.

Boolean: Returns a value indicating whether the cell is frozen.

Boolean: Returns true it the Style property has been set.

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

Int32: Returns the height of the cell.

DataGridViewElementStates: Returns the current state of the cell as inherited from the state of its row and column.

Throws:

• ArgumentException The cell is not contained within a DataGridView control and the value of its RowIndex property is not -1.

• ArgumentOutOfRangeException The cell is contained within a DataGridView control and the value of its RowIndex property is -1.

DataGridViewCellStyle: Returns the style currently applied to the cell.

Throws:

• InvalidOperationException The cell does not belong to a DataGridView control; or ColumnIndex is less than 0, indicating that the cell is a row header cell.

• ArgumentOutOfRangeException The row containing the cell is a shared row; or the cell is a column header cell.

Boolean: Returns whether this is the current cell in the DataGridView.

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

DataGridViewColumn: Returns the column that contains this cell.

DataGridViewRow: Returns the row that contains this cell.

Boolean: Returns or sets whether the cell's data can be edited.

Boolean: Returns a value indicating whether the cell can be resized.

Int32: Returns the index of the cell's parent row.

Boolean: Returns or sets whether the cell has been selected.

Size: Returns the size of the cell.

DataGridViewCellStyle: Returns or sets the style for the cell.

Object: Returns or sets the object that contains supplemental data about the cell. (Default: null)

String: Returns or sets the ToolTip text associated with this cell.

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

Boolean: Enables or disables the user paint feature for this cell. When UserPaint is true, the application can handle the CellPaint event to draw custom content in the cell. (Default: False)

Object: Returns or sets the value associated with this cell.

Throws:

• ArgumentOutOfRangeException RowIndex is outside the valid range of 0 to the number of rows in the control minus 1.

• InvalidOperationException ColumnIndex is less than 0, indicating that the cell is a row header cell.

Type: Returns or sets the data type of the values in the cell.

Boolean: Returns a value indicating whether the cell is in a row or column that has been hidden.

Int32: Returns the width of the cell.

Methods

Creates a copy of this cell.

Returns: DataGridViewCell. The cloned DataGridViewCell.

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

Returns: Object. The current, formatted value of the DataGridViewCell.

Throws:

• Exception Formatting failed and either there is no handler for the DataError event of the DataGridView control or the handler set the ThrowException property to true. The exception object can typically be cast to type FormatException.

Returns the inherited ContextMenu for the current cell.

Returns: ContextMenu. A ContextMenu instance if the DataGridViewCell, or the owner DataGridViewRow, or the owner DataGridViewColumn, or the owner DataGridView has a ContextMenu assigned; otherwise, null.

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

Returns: DataGridViewElementStates. A combination of DataGridViewElementStates values representing the current state of the cell.

Returns the style applied to the cell.

Returns: DataGridViewCellStyle. A DataGridViewCellStyle that includes the style settings of the cell inherited from the cell's parent row, column, and DataGridView.

Throws:

• InvalidOperationException The cell has no associated DataGridView.

Converts a value to the actual cell value.

Returns: Object. The cell value.

Throws:

• ArgumentNullException cellStyle is null.

• FormatException The FormattedValueType property value is null or the ValueType property value is null or value cannot be converted.

• ArgumentException value is null or the type of value does not match the type indicated by the FormattedValueType property.

Resets the ReadOnly state to inherit its value from the OwningColumn, OwningRowand the DataGridView.

Indicates whether the cell data should be updated on the client even if the user didn't change the value when editing. Since 3.2.5

Returns: Boolean. true to force the cell to update the client.

Used to allow the server to update the cell after editing mode is terminated and the user didn't change anything. For example, a password cell can be obfuscated, or a custom cell may need to always format the rendered value when terminating edit mode.

Updates the cell on the client.

Inherited By

Implements

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.5.0.0)

Specifies the border styles that can be applied to the cells of a control.

Fields

Used By

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.5.0.0)

Represents the method that will handle a event of a .

Parameters

Fired By

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.5.0.0)

Represents the method that will handle the event of a .

Parameters

Fired By

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.5.0.0)

Provides data for the event of the control.

Constructors

DataGridViewCellCommandEventArgs(columnIndex, rowIndex, command)

Initializes a new instance of the class.

Throws:

• columnIndex is less than 0; or rowIndex is less than 0.

Properties

ColumnIndex

: Returns a value indicating the column index of the cell that the event occurs for.

Used By

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.5.0.0)

Provides data for the event.

Constructors

DataGridViewCellContextMenuNeededEventArgs(columnIndex, rowIndex)

Initializes a new instance of the class.

DataGridViewCellContextMenuNeededEventArgs(columnIndex, rowIndex, x, y)

Initializes a new instance of the class.

Properties

Used By

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.5.0.0)

Represents the method that will handle the CellErrorTextNeeded event of a DataGridView.

public delegate void DataGridViewCellErrorTextNeededEventHandler(Object sender, DataGridViewCellErrorTextNeededEventArgs e)

Public Delegate Sub DataGridViewCellErrorTextNeededEventHandler(ByVal sender As [Object], ByVal e As DataGridViewCellErrorTextNeededEventArgs)

Parameters

Fired By

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.5.0.0)

• DataGridViewCellEventArgs

  • DataGridViewCellErrorTextNeededEventArgs

Provides data for the CellErrorTextNeeded event of a DataGridView control.

public class DataGridViewCellErrorTextNeededEventArgs : DataGridViewCellEventArgs

Public Class DataGridViewCellErrorTextNeededEventArgs
    Inherits DataGridViewCellEventArgs

Properties

ErrorText

String: Gets or sets the error message that is displayed when the cell is selected.

Used By

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.5.0.0)

Represents the method that will handle DataGridView events related to cell and row operations.

public delegate void DataGridViewCellEventHandler(Object sender, DataGridViewCellEventArgs e)

Public Delegate Sub DataGridViewCellEventHandler(ByVal sender As [Object], ByVal e As DataGridViewCellEventArgs)

Parameters

Fired By

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.5.0.0)

• ConvertEventArgs

  • DataGridViewCellFormattingEventArgs

Provides data for the CellFormatting event of a DataGridView.

public class DataGridViewCellFormattingEventArgs : ConvertEventArgs

Public Class DataGridViewCellFormattingEventArgs
    Inherits ConvertEventArgs

Constructors

DataGridViewCellFormattingEventArgs(columnIndex, rowIndex, value, desiredType, cellStyle)

Initializes a new instance of the DataGridViewCellFormattingEventArgs class.

Throws:

• ArgumentOutOfRangeException columnIndex is less than -1 or rowIndex is less than -1.

Properties

DataGridViewCellStyle: Returns or sets the style of the cell that is being formatted.

Int32: Returns the column index of the cell that is being formatted.

Boolean: Returns or sets whether the cell value has been successfully formatted.

Int32: Returns the row index of the cell that is being formatted.

Used By

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.5.0.0)

Provides data for DataGridView events related to cell and row operations.

public class DataGridViewCellEventArgs : EventArgs

Public Class DataGridViewCellEventArgs
    Inherits EventArgs

Constructors

DataGridViewCellEventArgs(columnIndex, rowIndex)

Initializes a new instance of the DataGridViewCellEventArgs class.

Throws:

• ArgumentOutOfRangeException columnIndex is less than -1, or rowIndex is less than -1.

Properties

ColumnIndex

Int32: Returns a value indicating the column index of the cell that the event occurs for.

Point: Returns the location of the mouse or pointer event.

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.

Int32: Returns a value indicating the row index of the cell that the event occurs for.

Int32: Returns the x-coordinate of the mouse or touch event.

Int32: Returns the y-coordinate of the mouse or touch event.

Used By

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.5.0.0)

Represents a data grid control.

Constructors

DataGridView()

Initializes a new instance of the class.

DataGridView(dataSource, onCellClick)

Initializes a new instance of the class with a specified data source and an event handler for the event.

DataGridView(location, size)

Initializes a new instance of the class with a specified location and size.

Properties

Throws:

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

Throws:

Throws:

Throws:

Throws:

Throws:

Throws:

Throws:

Throws:

Throws:

Throws:

Throws:

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

Throws:

Throws:

Throws:

Throws:

Throws:

Throws:

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

Methods