DataGridView.SetCurrentCellAddressCore Method

Definition

Sets the currently active cell.

protected:
 virtual bool SetCurrentCellAddressCore(int columnIndex, int rowIndex, bool setAnchorCellAddress, bool validateCurrentCell, bool throughMouseClick);
protected virtual bool SetCurrentCellAddressCore (int columnIndex, int rowIndex, bool setAnchorCellAddress, bool validateCurrentCell, bool throughMouseClick);
abstract member SetCurrentCellAddressCore : int * int * bool * bool * bool -> bool
override this.SetCurrentCellAddressCore : int * int * bool * bool * bool -> bool
Protected Overridable Function SetCurrentCellAddressCore (columnIndex As Integer, rowIndex As Integer, setAnchorCellAddress As Boolean, validateCurrentCell As Boolean, throughMouseClick As Boolean) As Boolean

Parameters

columnIndex
Int32

The index of the column containing the cell.

rowIndex
Int32

The index of the row containing the cell.

setAnchorCellAddress
Boolean

true to make the new current cell the anchor cell for a subsequent multicell selection using the SHIFT key; otherwise, false.

validateCurrentCell
Boolean

true to validate the value in the old current cell and cancel the change if validation fails; otherwise, false.

throughMouseClick
Boolean

true if the current cell is being set as a result of a mouse click; otherwise, false.

Returns

true if the current cell was successfully set; otherwise, false.

Exceptions

columnIndex is less than 0 or greater than the number of columns in the control minus 1, and rowIndex is not -1.

-or-

rowIndex is less than 0 or greater than the number of rows in the control minus 1, and columnIndex is not -1.

The specified cell has a Visible property value of false.

-or-

This method was called for a reason other than the underlying data source being reset, and another thread is currently executing this method.

The new current cell tried to enter edit mode, but its EditType property does not indicate a class that derives from Control and implements IDataGridViewEditingControl.

Remarks

The DataGridView control uses this method whenever it changes the current cell. This method changes the current cell without changing the selection and optionally without validating the previous cell or changing the selection anchor cell. The anchor cell is the first cell of a block of multiple cells that the user can select by holding down the SHIFT key and clicking the last cell of the block.

If rowIndex and columnIndex are both -1, the CurrentCell property returns null.

Applies to

See also