DataGridViewRow.GetState Method (Int32)

 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Returns a value indicating the current state of the row.

Namespace:   System.Windows.Forms
Assembly:  System.Windows.Forms (in System.Windows.Forms.dll)

abstract GetState : 
        rowIndex:int -> DataGridViewElementStates
override GetState : 
        rowIndex:int -> DataGridViewElementStates

Parameters

rowIndex
Type: System.Int32

The index of the row.

Return Value

Type: System.Windows.Forms.DataGridViewElementStates

A bitwise combination of DataGridViewElementStates values indicating the row state.

Exception Condition
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.

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.

.NET Framework
Available since 2.0
Return to top
Show: