DataGridView.AreAllCellsSelected Method

.NET Framework 2.0

Note: This method is new in the .NET Framework version 2.0.

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)

C#
C++
VB
Copy 
public bool AreAllCellsSelected (
	bool includeInvisibleCells
)
J#
Copy 
public boolean AreAllCellsSelected (
	boolean includeInvisibleCells
)
JScript
Copy 
public function AreAllCellsSelected (
	includeInvisibleCells : boolean
) : boolean

Parameters

includeInvisibleCells

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

Return Value

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.

C#
VB
Copy 
private void selectedCellsButton_Click(object sender, System.EventArgs e)
{
    Int32 selectedCellCount =
        dataGridView1.GetCellCount(DataGridViewElementStates.Selected);
    if (selectedCellCount > 0)
    {
        if (dataGridView1.AreAllCellsSelected(true))
        {
            MessageBox.Show("All cells are selected", "Selected Cells");
        }
        else
        {
            System.Text.StringBuilder sb =
                new System.Text.StringBuilder();

            for (int i = 0;
                i < selectedCellCount; i++)
            {
                sb.Append("Row: ");
                sb.Append(dataGridView1.SelectedCells[i].RowIndex
                    .ToString());
                sb.Append(", Column: ");
                sb.Append(dataGridView1.SelectedCells[i].ColumnIndex
                    .ToString());
                sb.Append(Environment.NewLine);
            }

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

Windows 98, Windows 2000 SP4, Windows Millennium Edition, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see System Requirements.

.NET Framework

Supported in: 2.0
Show: