DataGridViewRow.GetState(Int32) Method

Reference

Definition

Namespace:: System.Windows.Forms

Assembly:: System.Windows.Forms.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Returns a value indicating the current state of the row.

public:
 virtual System::Windows::Forms::DataGridViewElementStates GetState(int rowIndex);

public virtual System.Windows.Forms.DataGridViewElementStates GetState (int rowIndex);

abstract member GetState : int -> System.Windows.Forms.DataGridViewElementStates
override this.GetState : int -> System.Windows.Forms.DataGridViewElementStates

Public Overridable Function GetState (rowIndex As Integer) As DataGridViewElementStates

Parameters

rowIndex: Int32

The index of the row.

Returns

DataGridViewElementStates

A bitwise combination of DataGridViewElementStates values indicating the row state.

Exceptions

ArgumentOutOfRangeException

The row has been added to a DataGridView control, but the rowIndex value is not in the valid range of 0 to the number of rows in the control minus 1.

ArgumentException

The row is not a shared row, but the rowIndex value does not match the row's Index property value.

-or-

The row has not been added to a DataGridView control, but the rowIndex value does not match the row's Index property value.

Remarks

This method is useful to determine the state of a shared row. Shared rows have Index values of -1, which prevents you from using the State property with shared rows. To use this method, pass in the actual row index. You can retrieve the actual index of a shared row by calling the IndexOf method.

Applies to