DataGridView.AreAllCellsSelected Method (Boolean)

 

Returns a value indicating whether all the DataGridView cells are currently selected.

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

Public Function AreAllCellsSelected (
	includeInvisibleCells As Boolean
) As Boolean

Parameters

includeInvisibleCells
Type: System.Boolean

true to include the rows and columns with Visible property values of false; otherwise, false.

Return Value

Type: System.Boolean

true if all cells (or all visible cells) are selected or if there are no cells (or no visible cells); otherwise, false.

The SelectedCells collection does not perform efficiently with large selections. To determine whether all the cells in the DataGridView have been selected before you access the contents of the SelectedCells collection, check the return value of the AreAllCellsSelected method. However, this method can cause rows to become unshared. For more information about DataGridView performance, see Best Practices for Scaling the Windows Forms DataGridView Control.

The following code example illustrates how to use this method to avoid calculations involving the SelectedCells collection.

Private Sub selectedCellsButton_Click( _
    ByVal sender As Object, ByVal e As System.EventArgs) _
    Handles selectedCellsButton.Click

    Dim selectedCellCount As Integer = _
        dataGridView1.GetCellCount(DataGridViewElementStates.Selected)

    If selectedCellCount > 0 Then

        If dataGridView1.AreAllCellsSelected(True) Then

            MessageBox.Show("All cells are selected", "Selected Cells")

        Else

            Dim sb As New System.Text.StringBuilder()

            Dim i As Integer
            For i = 0 To selectedCellCount - 1

                sb.Append("Row: ")
                sb.Append(dataGridView1.SelectedCells(i).RowIndex _
                    .ToString())
                sb.Append(", Column: ")
                sb.Append(dataGridView1.SelectedCells(i).ColumnIndex _
                    .ToString())
                sb.Append(Environment.NewLine)

            Next i

            sb.Append("Total: " + selectedCellCount.ToString())
            MessageBox.Show(sb.ToString(), "Selected Cells")

        End If

    End If

End Sub

.NET Framework
Available since 2.0
Return to top
Show: