1 of 100

Lists & Grids

ItemCheckEventArgs

Wisej.Web.ItemCheckEventArgs

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

Provides data for the event of the and controls.

ItemCheckEventHandler

Wisej.Web.ItemCheckEventHandler

Namespace: Wisej.Web

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

DataGridView.CustomSummary

Wisej.Web.DataGridView CustomSummary

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.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.0.0.0)

Provides data about the pointer position in the DataGridView control.

public class HitTestInfo

Public Class HitTestInfo

Properties

Cell

: Returns the at the specified coordinates.

Column

: Returns the at the specified coordinates.

ColumnIndex

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

DataGridView

: Returns the that generate this instance.

Row

: Returns the at the specified coordinates.

RowIndex

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

Type

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

DataGridView.HitTestType

Wisej.Web.DataGridView HitTestType

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

Specifies the location in a control returned by the method .

DataGridViewAutoSizeRowMode

Wisej.Web.DataGridViewAutoSizeRowMode

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.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.0.0.0)

Defines how to adjust the heights of the rows.

Fields

DataGridViewBindingCompleteEventArgs

Wisej.Web.DataGridViewBindingCompleteEventArgs

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

Provides data for the event.

Constructors

DataGridViewBindingCompleteEventHandler

Wisej.Web.DataGridViewBindingCompleteEventHandler

Namespace: Wisej.Web

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

Name

Type

Description

Fired By

Name

Description

DataGridViewButtonCell

Wisej.Web.DataGridViewButtonCell

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

DataGridViewElement
- DataGridViewCell

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.

ValueType

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

DataGridViewCellBorderStyle

Wisej.Web.DataGridViewCellBorderStyle

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

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

Fields

DataGridViewCellCancelEventArgs

Wisej.Web.DataGridViewCellCancelEventArgs

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

Provides data for and events.

DataGridViewCellCancelEventHandler

Wisej.Web.DataGridViewCellCancelEventHandler

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

Represents the method that will handle the and events of a .

DataGridViewCellContextMenuNeededEventHandler

Wisej.Web.DataGridViewCellContextMenuNeededEventHandler

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

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

public delegate void DataGridViewCellContextMenuNeededEventHandler(Object sender, DataGridViewCellContextMenuNeededEventArgs e)

Public Delegate Sub DataGridViewCellContextMenuNeededEventHandler(ByVal sender As [Object], ByVal e As DataGridViewCellContextMenuNeededEventArgs)

Parameters

Name

Type

Description

Fired By

Name

Description

DataGridViewCellErrorTextNeededEventArgs

Wisej.Web.DataGridViewCellErrorTextNeededEventArgs

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

DataGridViewCellEventArgs
- DataGridViewCellErrorTextNeededEventArgs

Provides data for the CellErrorTextNeeded event of a control.

Properties

ErrorText

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

Used By

Name

Description

DataGridViewCellErrorTextNeededEventHandler

Wisej.Web.DataGridViewCellErrorTextNeededEventHandler

Namespace: Wisej.Web

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

Name

Type

Description

Fired By

Name

Description

DataGridViewCellFormattingEventHandler

Wisej.Web.DataGridViewCellFormattingEventHandler

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

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

public delegate void DataGridViewCellFormattingEventHandler(Object sender, DataGridViewCellFormattingEventArgs e)

Public Delegate Sub DataGridViewCellFormattingEventHandler(ByVal sender As [Object], ByVal e As DataGridViewCellFormattingEventArgs)

Parameters

Name

Type

Description

Fired By

Name

Description

DataGridViewCellMouseEventArgs

Wisej.Web.DataGridViewCellMouseEventArgs

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

MouseEventArgs
- DataGridViewCellMouseEventArgs

Provides data for mouse events raised by a DataGridView.

Properties

ColumnIndex

: Returns the zero-based column index of the cell.

RowIndex

: Returns the zero-based row index of the cell.

Used By

Name

Description

DataGridViewCellPaintEventHandler

Wisej.Web.DataGridViewCellPaintEventHandler

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

Represents the method that will handle CellPaint events.

public delegate void DataGridViewCellPaintEventHandler(Object sender, DataGridViewCellPaintEventArgs e)

Public Delegate Sub DataGridViewCellPaintEventHandler(ByVal sender As [Object], ByVal e As DataGridViewCellPaintEventArgs)

Parameters

Name

Type

Description

Fired By

Name

Description

DataGridViewCellParsingEventHandler

Wisej.Web.DataGridViewCellParsingEventHandler

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

Represents the method that will handle a event of a .

DataGridViewCellStateChangedEventHandler

Wisej.Web.DataGridViewCellStateChangedEventHandler

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

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

public delegate void DataGridViewCellStateChangedEventHandler(Object sender, DataGridViewCellStateChangedEventArgs e)

Public Delegate Sub DataGridViewCellStateChangedEventHandler(ByVal sender As [Object], ByVal e As DataGridViewCellStateChangedEventArgs)

Parameters

Name

Type

Description

Fired By

Name

Description

DataGridViewCellStyleContentChangedEventArgs

Wisej.Web.DataGridViewCellStyleContentChangedEventArgs

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

Provides data for the CellStyleContentChanged event.

public class DataGridViewCellStyleContentChangedEventArgs : EventArgs

Public Class DataGridViewCellStyleContentChangedEventArgs
    Inherits EventArgs

Properties

CellStyle

: Returns the changed .

PropertyName

: Returns the name of the property that has changed in .

Used By

Name

Description

DataGridViewCellStyleContentChangedEventHandler

Wisej.Web.DataGridViewCellStyleContentChangedEventHandler

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

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

public delegate void DataGridViewCellStyleContentChangedEventHandler(Object sender, DataGridViewCellStyleContentChangedEventArgs e)

Public Delegate Sub DataGridViewCellStyleContentChangedEventHandler(ByVal sender As [Object], ByVal e As DataGridViewCellStyleContentChangedEventArgs)

Parameters

Name

Type

Description

Fired By

Name

Description

DataGridViewCellStyleScopes

Wisej.Web.DataGridViewCellStyleScopes

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

Specifies the scope (the type of object) that owns the cell style.

public enum DataGridViewCellStyleScopes : Enum

Public Enum DataGridViewCellStyleScopes As [Enum]

Fields

Name

Description

Used By

Name

Description

DataGridViewCellToolTipTextNeededEventArgs

Wisej.Web.DataGridViewCellToolTipTextNeededEventArgs

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

Provides data for the

DataGridViewCellToolTipTextNeededEventHandler

Wisej.Web.DataGridViewCellToolTipTextNeededEventHandler

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

Represents the method that handles the CellToolTipTextNeeded event of a DataGridView.

public delegate void DataGridViewCellToolTipTextNeededEventHandler(Object sender, DataGridViewCellToolTipTextNeededEventArgs e)

Public Delegate Sub DataGridViewCellToolTipTextNeededEventHandler(ByVal sender As [Object], ByVal e As DataGridViewCellToolTipTextNeededEventArgs)

Parameters

Name

Type

Description

Fired By

Name

Description

DataGridViewCellValidatingEventHandler

Wisej.Web.DataGridViewCellValidatingEventHandler

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

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

DataGridViewCellValueEventHandler

Wisej.Web.DataGridViewCellValueEventHandler

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

Represents the method that will handle the event or event of a .

DataGridViewClipboardCopyMode

Wisej.Web.DataGridViewClipboardCopyMode

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

Defines how content is copied from a control to the Clipboard.

Fields

DataGridViewColumnEventArgs

Wisej.Web.DataGridViewColumnEventArgs

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

Provides data for column-related events of a DataGridView.

public class DataGridViewColumnEventArgs : EventArgs

Public Class DataGridViewColumnEventArgs
    Inherits EventArgs

Constructors

DataGridViewColumnEventArgs(column)

Initializes a new instance of the class.

Name

Type

Description

Throws:

column is null.

Properties

Column

: Returns the column that the event occurs for.

Used By

Name

Description

DataGridViewColumnHeadersHeightSizeMode

Wisej.Web.DataGridViewColumnHeadersHeightSizeMode

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

Defines values for specifying how the height of the column headers is adjusted.

public enum DataGridViewColumnHeadersHeightSizeMode : Enum

Public Enum DataGridViewColumnHeadersHeightSizeMode As [Enum]

Fields

Name

Description

Used By

Name

Description

DataGridViewColumnSortMode

Wisej.Web.DataGridViewColumnSortMode

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

Defines how a DataGridView column can be sorted by the user.

public enum DataGridViewColumnSortMode : Enum

Public Enum DataGridViewColumnSortMode As [Enum]

Fields

Name

Description

Used By

Name

Description

DataGridViewColumnsSortMode

Wisej.Web.DataGridViewColumnsSortMode

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

Defines how a columns can be sorted by the user.

Fields

DataGridViewColumnStateChangedEventArgs

Wisej.Web.DataGridViewColumnStateChangedEventArgs

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

Provides data for the event.

Constructors

DataGridViewDataErrorEventHandler

Wisej.Web.DataGridViewDataErrorEventHandler

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

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

public delegate void DataGridViewDataErrorEventHandler(Object sender, DataGridViewDataErrorEventArgs e)

Public Delegate Sub DataGridViewDataErrorEventHandler(ByVal sender As [Object], ByVal e As DataGridViewDataErrorEventArgs)

Parameters

Name

Type

Description

Fired By

Name

Description

DataGridViewDataReadEventArgs

Wisej.Web.DataGridViewDataReadEventArgs

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

Provides data for the DataRead event.

public class DataGridViewDataReadEventArgs : EventArgs

Public Class DataGridViewDataReadEventArgs
    Inherits EventArgs

Constructors

DataGridViewDataReadEventArgs(firstIndex, lastIndex)

Initializes a new instance of the class.

Name

Type

Description

Properties

FirstIndex

: Returns the index of the first row requested by the grid.

LastIndex

: Returns the index of the last row requested by the grid.

Used By

Name

Description

DataGridViewDataUpdatedEventHandler

Wisej.Web.DataGridViewDataUpdatedEventHandler

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

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

public delegate void DataGridViewDataUpdatedEventHandler(Object sender, DataGridViewDataUpdatedEventArgs e)

Public Delegate Sub DataGridViewDataUpdatedEventHandler(ByVal sender As [Object], ByVal e As DataGridViewDataUpdatedEventArgs)

Parameters

Name

Type

Description

Fired By

Name

Description

DataGridViewEditingControlShowingEventArgs

Wisej.Web.DataGridViewEditingControlShowingEventArgs

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

Provides data for the

DataGridViewEditingControlShowingEventHandler

Wisej.Web.DataGridViewEditingControlShowingEventHandler

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

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

public delegate void DataGridViewEditingControlShowingEventHandler(Object sender, DataGridViewEditingControlShowingEventArgs e)

Public Delegate Sub DataGridViewEditingControlShowingEventHandler(ByVal sender As [Object], ByVal e As DataGridViewEditingControlShowingEventArgs)

Parameters

Name

Type

Description

Fired By

Name

Description

DataGridViewEditMode

Wisej.Web.DataGridViewEditMode

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

Specifies how a user starts cell editing in the DataGridView control.

public enum DataGridViewEditMode : Enum

Public Enum DataGridViewEditMode As [Enum]

Fields

Name

Description

Used By

Name

Description

DataGridViewImageCell

Wisej.Web.DataGridViewImageCell

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

DataGridViewElement
- DataGridViewCell

Displays an image in a cell.

Constructors

DataGridViewImageCell()

Properties

FormattedValueType

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

ImageAlignment

: Gets or sets the alignment of the image in the cell.

ImageLayout

: Gets or sets the layout of the image in the cell.

ValueType

: Returns the data type of the values in the cell.

DataGridViewImageCellLayout

Wisej.Web.DataGridViewImageCellLayout

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

Specifies the layout for an image contained in a .

Fields

DataGridViewColumnCollection

Wisej.Web.DataGridViewColumnCollection

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

BaseCollection
- DataGridViewColumnCollection

Represents a collection of DataGridViewColumn objects in a control.

Constructors

DataGridViewColumnCollection(dataGrid)

Initializes a new instance of the class for the given .

Name

Type

Description

Properties

Item(index)

: Returns the column at the given index in the collection.

Throws:

index is less than zero or greater than the number of columns in the collection minus one.

Item(name)

: Returns the column of the given name in the collection.

Throws:

name is null.

Methods

Add(column)

Adds the given to the collection.

Parameter

Type

Description

Returns: . The index of the column.

Throws:

column is null.
The associated control is performing one of the following actions that temporarily prevents new columns from being added: - Selecting all cells in the control. - Clearing the selection.Updating column property values. Or this method is being called from a handler for one of the following events: - - - - - - - -

Add(name)

Adds a with the given column name to the collection.

Parameter

Type

Description

Returns: . The index of the column.

Throws:

The associated control is performing one of the following actions that temporarily prevents new columns from being added: - Selecting all cells in the control. - Clearing the selection.Updating column property values. Or this method is being called from a handler for one of the following events: - - - - - - - -

Add(name, valueType)

Adds a with the given column name and call value type to the collection.

Parameter

Type

Description

Returns: . The index of the column.

Throws:

The associated control is performing one of the following actions that temporarily prevents new columns from being added: - Selecting all cells in the control. - Clearing the selection.Updating column property values. Or this method is being called from a handler for one of the following events: - - - - - - - -

Add(name, caption)

Adds a with the given column name and column header text to the collection.

Parameter

Type

Description

Returns: . The index of the column.

Throws:

The associated control is performing one of the following actions that temporarily prevents new columns from being added: - Selecting all cells in the control. - Clearing the selection.Updating column property values. Or this method is being called from a handler for one of the following events: - - - - - - - -

Add(name, caption, valueType)

Adds a with the given column name, column header text, and cell value type to the collection.

Parameter

Type

Description

Returns: . The index of the column.

Throws:

The associated control is performing one of the following actions that temporarily prevents new columns from being added: - Selecting all cells in the control. - Clearing the selection.Updating column property values. Or this method is being called from a handler for one of the following events: - - - - - - - -

AddRange(newColumns)

Adds a range of columns to the collection.

Parameter

Type

Description

Throws:

newColumns is null.
The associated control is performing one of the following actions that temporarily prevents new columns from being added: - Selecting all cells in the control. - Clearing the selection.Updating column property values. Or this method is being called from a handler for one of the following events: - - - - - - - -

Clear()

Clears the collection.

Throws:

The associated control is performing one of the following actions that temporarily prevents new columns from being added: - Selecting all cells in the control. - Clearing the selection.Updating column property values. Or this method is being called from a handler for one of the following events: - - - - - - - -

Clear(dispose)

Clears the collection and disposes the columns.

Parameter

Type

Description

Contains(column)

Determines whether the collection contains the given .

Parameter

Type

Description

Returns: . true if the given column is in the collection; otherwise, false.

Contains(name)

Determines whether the collection contains the given .

Parameter

Type

Description

Returns: . true if the given column is in the collection; otherwise, false.

CopyTo(array, index)

Copies the items from the collection to the given array.

Parameter

Type

Description

GetColumnCount(includeFilter)

Returns the number of columns that match the includeFilter .

Parameter

Type

Description

Returns: . The number of columns that match the filter.

Throws:

includeFilter is not a valid combination of values.

GetColumnsWidth(includeFilter)

Returns the width, in pixels, required to display all of the columns that meet the includeFilter .

Parameter

Type

Description

Returns: . The width, in pixels, that is necessary to display all of the columns that match the filter.

Throws:

includeFilter is not a valid combination of values.

GetFirstColumn(includeFilter, excludeFilter)

Returns the first in display order that matches the includeFilter and excludeFilter .

Parameter

Type

Description

Returns: . The first in display order that matches the given filters, or null if no column is found.

Throws:

At least one of the filter values is not a valid combination of values.

GetLastColumn(includeFilter, excludeFilter)

Returns the last in display order that matches the includeFilter and excludeFilter .

Parameter

Type

Description

Returns: . The last displayed in display order that matches the specified filters, or null if no column is found.

Throws:

At least one of the filter values is not a valid combination of values.

GetNextColumn(startColumn, includeFilter, excludeFilter)

Returns the first after the given column in display order that matches the includeFilter and excludeFilter .

Parameter

Type

Description

Returns: . The next that matches the filters, or null if no column is found.

Throws:

startColumn is null.
At least one of the filter values is not a valid combination of values.

GetPreviousColumn(startColumn, includeFilter, excludeFilter)

Returns the last prior to the given column in display order that matches the includeFilter and excludeFilter .

Parameter

Type

Description

Returns: . The previous column that matches the given filters, or null if no column is found.

Throws:

startColumn is null.
At least one of the filter values is not a valid combination of values.

IndexOf(column)

Returns the index of the given in the collection.

Parameter

Type

Description

Returns: . The index of the given .

IndexOf(name)

Returns the index of the with the specified name from the collection.

Parameter

Type

Description

Returns: . The index of the given .

Throws:

name is null.

Insert(index, column)

Inserts a at the given index in the collection.

Parameter

Type

Description

Throws:

column is null.
The associated control is performing one of the following actions that temporarily prevents new columns from being added:Selecting all cells in the control.Clearing the selection.Updating column property values; or this method is being called from a handler for one of the following events: or column already belongs to a control; or the column property value is and the property value is

Remove(column)

Removes the specified from the collection.

Parameter

Type

Description

Throws:

column is not in the collection.
column is null.
The associated control is performing one of the following actions that temporarily prevents new columns from being added:Selecting all cells in the control.Clearing the selection.Updating column property values; or this method is being called from a handler for one of the following events:

Remove(name)

Removes the with the specified name from the collection.

Parameter

Type

Description

Throws:

name does not match the name of any column in the collection.
name is null.
The associated control is performing one of the following actions that temporarily prevents new columns from being added:Selecting all cells in the control.Clearing the selection.Updating column property values; or this method is being called from a handler for one of the following events:

RemoveAt(index)

Removes the at the given index in the collection.

Parameter

Type

Description

Throws:

index is less than zero or greater than the number of columns in the control minus one.
The associated control is performing one of the following actions that temporarily prevents new columns from being added: - Selecting all cells in the control. - Clearing the selection.Updating column property values. Or this method is being called from a handler for one of the following events: - - - - - - - -

SetColumnIndex(column, newIndex)

Moves the specified column to the new newIndex .

Parameter

Type

Description

This method updates both the column's index in the column collection and the display index without firing the event.

Events

CollectionChanged

Fired when the collection changes.

DataGridView

Wisej.Web.DataGridView

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

Control
- DataGridView

Represents a data grid control.

Constructors

DataGridView()

Initializes a new instance of the class.

Properties

AllowSortingDataSource

: Returns or sets whether the can automatically sort rows in the when the data is in an object.

When the is data-bound, sorting is delegated to the when it supports sorting (see ). Otherwise, if the data is in an object and 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 to false reverts to the same behavior as in WinForms.

AllowUserToAddRows

: Returns or sets whether the user can add new rows.

AllowUserToDeleteRows

: Returns or sets whether the user is allowed to delete rows from the .

AllowUserToOrderColumns

: Returns or sets whether manual column repositioning is enabled.

AllowUserToResizeColumns

: Returns or sets whether users can resize columns.

AllowUserToResizeRows

: Returns or sets whether users can resize rows.

AutoGenerateColumns

: Returns or sets whether columns are created automatically when the or properties are set. This property is ignored in design mode - auto column generation is always on.

AutoSize

: Returns or sets a value that indicates whether the control resizes based on its contents.

AutoSizeColumnsMode

: Returns or sets a value indicating how column widths are determined.

AutoSizeRowsMode

: Returns or sets a value indicating how row heights are determined.

Throws:

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

BlockSize

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

CellBorderStyle

: Returns or sets the cell border style for the control.

ClipboardCopyMode

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

ColumnCount

: Returns or sets the number of columns displayed in the .

Throws:

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

ColumnHeadersBorderStyle

: Returns or sets the border style for the column headers in the control.

ColumnHeadersDefaultCellStyle

: Returns or sets the default column header style.

ColumnHeadersHeight

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

Throws:

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

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

ColumnHeadersVisible

: Returns or sets whether the column header row is displayed.

Throws:

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

Columns

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

CurrentCell

: Returns or sets the currently active cell.

Throws:

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 is bound to a . Re-entrant calling results from a change to the underlying data.
The specified cell when setting this property is not in the .

CurrentCellAddress

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

CurrentRow

: Returns the row containing the current cell.

DataMember

: Returns or sets the name of the list or table in the data source for which the is displaying data.

Throws:

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

DataSource

: Returns or sets the data source that the is displaying data for.

Throws:

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

DefaultCellStyle

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

DefaultRowHeight

: Returns or sets the default row height.

DefaultSortMode

: Returns or sets the default for all columns when the property is set to (default).

EditingControl

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

EditMode

: Returns or sets a value indicating how to begin editing a cell.

Throws:

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 event or the handler has set the property to true. The exception object can typically be cast to type .

FirstDisplayedCell

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

FirstDisplayedColumnIndex

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

Throws:

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

FirstDisplayedRowIndex

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

Throws:

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

HorizontalScrollingOffset

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

Indent

: Returns or sets the distance in pixels to indent each child row node level.

Throws:

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

IsCurrentCellDirty

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

IsCurrentCellInEditMode

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

IsCurrentRowDirty

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

Item(columnIndex, rowIndex)

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

Throws:

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)

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

Item(column, rowIndex)

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

Item(cellAddress)

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

KeepSameRowHeight

: Returns or sets whether the rows are always of the same height.

LiveResize

: Returns or sets whether the column and row resizing should be live: updated as the user resizes the row or the column.

MaxCachedBlocks

: Maximum number of blocks kept in the client cache.

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

MultiSelect

: Returns or sets whether the user is allowed to select more than one cell, row, or column of the at a time.

NewRowIndex

: Returns the index of the row for new records.

NoDataMessage

: Returns or sets an HTML string that is displayed when the doesn't contain any row.

ReadOnly

: Returns or sets whether the user can edit the cells of the control.

Throws:

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.
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 event or the handler has set the property to true. The exception object can typically be cast to type .

RightClickSelection

: Returns or sets whether the row under the pointer gets selected on a right click.

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

RowCount

: Returns or sets the number of rows displayed in the .

Throws:

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

RowHeaderColumn

: Returns the for the row headers.

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

RowHeadersDefaultCellStyle

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

RowHeadersMinimumWidth

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

Throws:

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

RowHeadersVisible

: Returns or sets whether the column that contains row headers is displayed.

Throws:

The specified value when setting this property is false and the property is set to or .

RowHeadersWidth

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

Throws:

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

RowHeadersWidthSizeMode

: 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

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

RowTemplate

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

Throws:

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

ScrollBars

: Returns or sets the type of scroll bars to display for the control.

SelectedCells

: Returns the collection of selected cells.

SelectedColumns

: Returns the collection of selected columns.

SelectedRows

: Returns the collection of selected rows.

SelectionDelay

: milliseconds to wait before sending selection events to the server.

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

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

SelectionMode

: Returns or sets a value indicating how the cells of the can be selected.

ShowCellErrors

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

ShowCellToolTips

: Returns or sets whether or not ToolTips will show when the mouse pointer pauses on a cell.

ShowColumnVisibilityMenu

: Returns or sets whether the column visibility menu button is visible.

ShowFocusCell

: Returns or sets a value indicating whether the widget highlights the currently focused cell.

ShowRowErrors

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

SortedColumn

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

SortFrozenRows

: Returns or sets whether frozen rows should be sorted when sorting a column.

SortOrder

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

SortSelectionMode

: Returns or sets a value indicating how the updates the selection of rows and cells when it's sorted.

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

StandardTab

: 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

: Returns the instance of associated with this control.

ToolsPosition

: Returns or sets the position of the items associated with this control.

TopLeftHeaderCell

: Returns the header cell located in the upper left corner of the control.

TreeColumn

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

VirtualMode

: Returns or sets whether you have provided your own data-management operations for the control.

VisibleRowCount

: Returns the total number of visible rows currently displayed.

Methods

AddSummaryRows(summaryType, groupCol, summaryCol, style, customSummary)

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

Parameter

Type

Description

Returns: . Array of the rows displaying the aggregated values.

AddSummaryRows(summaryType, summaryPosition, groupCol, summaryCol, style, customSummary)

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

Parameter

Type

Description

Returns: . Array of the rows displaying the aggregated values.

AddSummaryRows(summaryType, groupFromCol, groupToCol, summaryCol, style, customSummary)

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

Parameter

Type

Description

Returns: . Array of the rows displaying the aggregated values.

AddSummaryRows(summaryType, summaryPosition, groupFromCol, groupToCol, summaryCol, style, customSummary)

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

Parameter

Type

Description

Returns: . Array of the rows displaying the aggregated values.

AddSummaryRows(summaryType, groupCol, summaryCol, style, customSummary)

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

Parameter

Type

Description

Returns: . Array of the rows displaying the aggregated values.

AddSummaryRows(summaryType, summaryPosition, groupCol, summaryCol, style, customSummary)

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

Parameter

Type

Description

Returns: . Array of the rows displaying the aggregated values.

AddSummaryRows(summaryType, groupFromCol, groupToCol, summaryCol, style, customSummary)

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

Parameter

Type

Description

Returns: . Array of the rows displaying the aggregated values.

AddSummaryRows(summaryType, summaryPosition, groupFromCol, groupToCol, summaryCol, style, customSummary)

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

Parameter

Type

Description

Returns: . Array of the rows displaying the aggregated values.

Append(data, dataMember)

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

Parameter

Type

Description

Returns: . Numbers of rows appended.

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

AreAllCellsSelected(includeInvisibleCells)

Returns whether all the cells are currently selected.

Parameter

Type

Description

Returns: . 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:

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.

Parameter

Type

Description

Throws:

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:

autoSizeMode has the value and is false.
autoSizeMode has the value , , or .
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:

autoSizeMode has the value and is false.
autoSizeMode has the value , , or .
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:

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

AutoResizeColumns()

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

AutoResizeColumns(extraSpace)

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

Parameter

Type

Description

AutoResizeColumns(autoSizeMode)

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

Parameter

Type

Description

Throws:

autoSizeMode has the value and is false.
autoSizeMode has the value or .

AutoResizeColumns(autoSizeMode, extraSpace)

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

Parameter

Type

Description

Throws:

autoSizeMode has the value and is false.
autoSizeMode has the value or .

AutoResizeRow(rowIndex)

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

Parameter

Type

Description

Throws:

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

AutoResizeRow(rowIndex, extraSpace)

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

Parameter

Type

Description

Throws:

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

AutoResizeRow(rowIndex, autoSizeMode)

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

Parameter

Type

Description

Throws:

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

AutoResizeRow(rowIndex, autoSizeMode, extraSpace)

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

Parameter

Type

Description

Throws:

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

AutoResizeRowHeadersWidth(autoSizeMode)

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

Parameter

Type

Description

Throws:

autoSizeMode has the value or .

AutoResizeRowHeadersWidth(autoSizeMode, extraSpace)

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

Parameter

Type

Description

Throws:

autoSizeMode has the value or .

AutoResizeRowHeadersWidth(rowIndex, autoSizeMode)

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

Parameter

Type

Description

Throws:

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

AutoResizeRowHeadersWidth(rowIndex, autoSizeMode, extraSpace)

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

Parameter

Type

Description

Throws:

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

AutoResizeRows()

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

AutoResizeRows(extraSpace)

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

Parameter

Type

Description

AutoResizeRows(autoSizeMode)

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

Parameter

Type

Description

Throws:

autoSizeMode has the value
autoSizeMode has the value and is false.

BeginEdit(selectAll)

Puts the current cell in edit mode.

Parameter

Type

Description

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

Throws:

is not set to a valid cell.

BeginUpdate()

Prevents the control from updating until the method is called.

CancelEdit()

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

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

ClearSelection()

Clears the current selection.

CommitEdit()

Commits changes to cell without ending edit mode.

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

Throws:

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

EndEdit()

Commits and ends the edit operation on the current cell.

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

Throws:

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

EndUpdate()

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

Fill(data, dataMember)

Populates the from the data .

Parameter

Type

Description

Returns: . Numbers of rows added.

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

GetClipboardContent()

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

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

Throws:

is set to .

GetFormattedValue(column, rowIndex)

Retrieves the value for the specified cell, as formatted for display, without retrieving a 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 .

Parameter

Type

Description

Returns: . The formatted value stored in the cell.

Throws:

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

GetFormattedValue(columnName, rowIndex)

Parameter

Type

Description

Returns: . The formatted value stored in the cell.

Throws:

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

GetFormattedValue(columnIndex, rowIndex)

Parameter

Type

Description

Returns: . The formatted value stored in the cell.

Throws:

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

GetRowState(rowIndex)

Returns the state of the at the specified index.

Parameter

Type

Description

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

Throws:

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

GetValue(columnIndex, rowIndex)

Retrieves the value for the specified cell without retrieving a 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 .

Parameter

Type

Description

Returns: . The object value stored in the cell.

Throws:

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

GetValue(cellAddress)

Parameter

Type

Description

Returns: . The object value stored in the cell.

Throws:

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

GetValue(column, rowIndex)

Parameter

Type

Description

Returns: . The object value stored in the cell.

Throws:

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

GetValue(columnName, rowIndex)

Parameter

Type

Description

Returns: . The object value stored in the cell.

Throws:

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

HitTest(x, y)

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

Parameter

Type

Description

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

HitTest(position)

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

Parameter

Type

Description

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

IsCellEditable(cell)

Checks if the specified cell can enter edit mode.

Parameter

Type

Description

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

IsCellEditable(colIndex, rowIndex)

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

Parameter

Type

Description

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

IsCellEditable(cellAddress)

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

Parameter

Type

Description

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

IsCellVisible(cell)

Checks if the specified cell is visible.

Parameter

Type

Description

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

IsCellVisible(colIndex, rowIndex)

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

Parameter

Type

Description

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

IsCellVisible(cellAddress)

Checks if the cell at the cellAddress location is visible.

Parameter

Type

Description

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

IsValidCell(cellAddress)

Verifies that the cell address refers to a valid cell.

Parameter

Type

Description

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

IsValidCell(colIndex, rowIndex)

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

Parameter

Type

Description

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

IsValidColumn(colIndex)

Verifies that the column index refer to a valid column.

Parameter

Type

Description

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

IsValidRow(rowIndex)

Verifies that the row index refer to a valid row.

Parameter

Type

Description

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

NotifyCurrentCellDirty(dirty)

Notifies the that the current cell has uncommitted changes.

Parameter

Type

Description

OnTopLeftHeaderClick(e)

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

Parameter

Type

Description

Throws:

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

Refresh()

Forces a full reload of the data displayed by this .

Refresh(refreshChildren)

Forces a full reload of the data displayed by this .

Parameter

Type

Description

RemoveSummaryRows()

Removes the all the summary rows.

RemoveSummaryRows(summaryPosition)

Removes the summary rows that match the specified summaryPosition .

Parameter

Type

Description

RemoveSummaryRows(groupFromCol)

Removes the summary rows grouped by groupFromCol .

Parameter

Type

Description

RemoveSummaryRows(groupFromCol, groupToCol)

Removes the summary rows grouped by groupFromCol and groupToCol .

Parameter

Type

Description

RemoveSummaryRows(groupFromCol)

Removes the summary rows grouped by groupFromCol .

Parameter

Type

Description

RemoveSummaryRows(groupFromCol, groupToCol)

Removes the summary rows grouped by groupFromCol and groupToCol .

Parameter

Type

Description

RemoveSummaryRows(summaryPosition, groupFromCol)

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

Parameter

Type

Description

RemoveSummaryRows(summaryPosition, groupFromCol, groupToCol)

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

Parameter

Type

Description

RemoveSummaryRows(summaryPosition, groupFromCol, groupToCol)

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

Parameter

Type

Description

ScrollCellIntoView(cell)

Scrolls the specified cell into view.

Parameter

Type

Description

Throws:

cell is null.
cell doesn't belong to this .

ScrollCellIntoView(cell, alignX, alignY)

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

Parameter

Type

Description

Throws:

cell is null.
cell doesn't belong to this .

ScrollCellIntoView(cellAddress)

Scrolls the specified cell into view.

Parameter

Type

Description

Throws:

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.

ScrollCellIntoView(cellAddress, alignX, alignY)

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

Parameter

Type

Description

Throws:

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.

ScrollCellIntoView(columnIndex, rowIndex)

Scrolls the specified cell into view.

Parameter

Type

Description

Throws:

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.

ScrollCellIntoView(columnIndex, rowIndex, alignX, alignY)

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

Parameter

Type

Description

Throws:

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.

ScrollColumnIntoView(columnIndex)

Scrolls the specified column into view.

Parameter

Type

Description

Throws:

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

ScrollColumnIntoView(columnIndex, alignX)

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

Parameter

Type

Description

Throws:

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

ScrollColumnIntoView(column)

Scrolls the specified column into view.

Parameter

Type

Description

Throws:

column is null.
column doesn't belong to this .

ScrollColumnIntoView(column, alignX)

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

Parameter

Type

Description

Throws:

column is null.
column doesn't belong to this .

ScrollRowIntoView(rowIndex)

Scrolls the specified row into view.

Parameter

Type

Description

Throws:

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

ScrollRowIntoView(rowIndex, alignY)

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

Parameter

Type

Description

Throws:

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

ScrollRowIntoView(row)

Scrolls the specified row into view.

Parameter

Type

Description

Throws:

row is null.
row doesn't belong to this .

ScrollRowIntoView(row, alignY)

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

Parameter

Type

Description

Throws:

row is null.
row doesn't belong to this .

SelectAll()

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

SelectAllCells()

Selects all the cells, regardless of the and properties.

SelectAllColumns()

Selects all the columns, regardless of the and properties.

SelectAllRows()

Selects all the rows, regardless of the and properties.

SetCurrentCell(cellAddress)

Sets the currently focused cell.

Parameter

Type

Description

SetCurrentCell(columnIndex, rowIndex)

Sets the currently focused cell.

Parameter

Type

Description

SetRowState(rowIndex, state)

Sets the state for the row at rowIndex .

Parameter

Type

Description

Throws:

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

SetValue(columnIndex, rowIndex, value)

Sets the value of the specified cell without retrieving a 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 .

Parameter

Type

Description

Throws:

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

SetValue(cellAddress, value)

Parameter

Type

Description

Throws:

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

SetValue(columnName, rowIndex, value)

Parameter

Type

Description

Throws:

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

SetValue(column, rowIndex, value)

Parameter

Type

Description

Throws:

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

Sort(column, direction)

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

Parameter

Type

Description

Throws:

The specified column is not part of this ; or the property has been set and the property of the specified column returns false.
column is null.
The property is set to true and the property of the specified column returns false; or the object specified by the property does not implement the interface; or the object specified by the

Sort(comparer)

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

Parameter

Type

Description

Throws:

comparer is null.
is set to true; or is not null.

Update()

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

AllowUserToAddRowsChanged

Fired when the value of the property changes.

AllowUserToDeleteRowsChanged

Fired when the value of the property changes.

AllowUserToOrderColumnsChanged

Fired when the value of the property changes.

AllowUserToResizeColumnsChanged

Fired when the value of the property changes.

AllowUserToResizeRowsChanged

Fired when the value of the property changes.

CellBeginEdit

Fired when edit mode starts for the selected cell.

CellClick

Fired when any part of a cell is clicked.

CellContextMenuNeeded

Fired when a cell's context menu is needed.

CellDoubleClick

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

CellEndEdit

Fired when edit mode stops for the current cell.

CellEnter

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

CellErrorTextChanged

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

CellErrorTextNeeded

Fired when a cell's error text is needed.

CellFormatting

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

CellLeave

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

CellMouseClick

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

CellMouseDoubleClick

Fired when a cell within the is double-clicked.

CellMouseDown

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

CellMouseEnter

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.

CellMouseLeave

Fired when the mouse pointer leaves a cell.

CellMouseMove

Fired when the mouse pointer moves over the control.

CellMouseUp

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

CellPaint

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

CellParsing

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

CellStateChanged

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

CellStyleChanged

Fired when the property of a changes.

CellStyleContentChanged

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

CellToolClick

Fired when a hosted in a cell editor is clicked.

CellToolTipTextChanged

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

CellToolTipTextNeeded

Fired when a cell's ToolTip text is needed.

CellValidated

Occurs after the cell has finished validating.

CellValidating

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

CellValueChanged

Fired when the value of a cell changes.

CellValueNeeded

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

CellValuePushed

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

ColumnAdded

Fired when a column is added to the control.

ColumnDisplayIndexChanged

Fired when the value the property for a column changes.

ColumnFillWeightChanged

Fired when the property changes.

ColumnHeaderMouseClick

Fired when the user clicks a column header.

ColumnHeaderMouseDoubleClick

Fired when a column header is double-clicked.

ColumnHeadersHeightChanged

Fired when the value of the property changes.

ColumnMaximumWidthChanged

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

ColumnMinimumWidthChanged

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

ColumnNameChanged

Fired when the property changes.

ColumnRemoved

Fired when a column is removed from the control.

ColumnSortModeChanged

Fired when the value of the property changes.

ColumnStateChanged

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

ColumnWidthChanged

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

CurrentCellChanged

Fired when the property changes.

DataBindingComplete

Occurs after a data-binding operation has finished.

DataError

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

DataMemberChanged

Fired when value of the property changes.

DataRead

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

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

DataSourceChanged

Fired when the value of the property changes.

DataUpdated

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 won't work.

DefaultRowHeightChanged

Fired when the value of the property changes.

DefaultValuesNeeded

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

EditingControlShowing

Fired when a control for editing a cell is showing.

EditModeChanged

Fired when the value of the property changes.

KeepSameRowHeightChanged

Fired when the value of the property changes.

LastCellTab

Fired when the user tabs past the last cell.

LiveResizeChanged

Fired when the value of the property changes.

MultiSelectChanged

Fired when the value of the property changes.

NewRowNeeded

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

ReadOnlyChanged

Fired when the value of the property changes.

RowCollapsed

Fired when a parent row is collapsed.

RowEnter

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

RowErrorTextChanged

Fired when the property of a row changes.

RowErrorTextNeeded

Fired when the row's error text is required.

RowExpanded

Fired when a parent row is expanded.

RowHeaderMouseClick

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

RowHeaderMouseDoubleClick

Fired when a row header is double-clicked.

RowHeadersWidthChanged

Fired when value of the property changes.

RowHeightChanged

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

RowHeightInfoNeeded

Fired when information about row height is requested.

RowLeave

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

RowMaximumHeightChanged

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

RowMinimumHeightChanged

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

RowsAdded

Occurs after a new row is added to the .

RowsRemoved

Fired when a row or rows are deleted from the .

RowStateChanged

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

RowValidated

Occurs after a row has finished validating.

RowValidating

Fired when a row is validating.

Scroll

Fired when the user or code scrolls the grid.

SelectionChanged

Fired when the current selection changes.

ShowColumnVisibilityMenuChanged

Fired when the value of the property changes.

SortCompare

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

Sorted

Fired when the control completes a sorting operation.

StandardTabChanged

Fired when the value of the property changes.

ToolClick

Fired when a is clicked.

TopLeftHeaderClick

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

UserAddedRow

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

UserDeletedRow

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

UserDeletingRow

Fired when the user deletes a row from the control.

Implements

Name

Description