DataGridViewColumnCollection.GetColumnCount(DataGridViewElementStates) Method

Definition

Returns the number of columns that meet the given filter requirements.

public:
 int GetColumnCount(System::Windows::Forms::DataGridViewElementStates includeFilter);
public int GetColumnCount (System.Windows.Forms.DataGridViewElementStates includeFilter);
member this.GetColumnCount : System.Windows.Forms.DataGridViewElementStates -> int
Public Function GetColumnCount (includeFilter As DataGridViewElementStates) As Integer

Parameters

includeFilter
DataGridViewElementStates

A bitwise combination of the DataGridViewElementStates values that represent the filter for inclusion.

Returns

The number of columns that meet the filter requirements.

Exceptions

includeFilter is not a valid bitwise combination of DataGridViewElementStates values.

Examples

The following code example illustrates how to use this method to get the number of selected columns.

private void selectedColumnsButton_Click(object sender, System.EventArgs e)
{
    Int32 selectedColumnCount = dataGridView1.Columns
        .GetColumnCount(DataGridViewElementStates.Selected);
    if (selectedColumnCount > 0)
    {
        System.Text.StringBuilder sb = new System.Text.StringBuilder();

        for (int i = 0; i < selectedColumnCount; i++)
        {
            sb.Append("Column: ");
            sb.Append(dataGridView1.SelectedColumns[i].Index
                .ToString());
            sb.Append(Environment.NewLine);
        }

        sb.Append("Total: " + selectedColumnCount.ToString());
        MessageBox.Show(sb.ToString(), "Selected Columns");
    }
}
Private Sub selectedColumnsButton_Click( _
    ByVal sender As Object, ByVal e As System.EventArgs) _
    Handles selectedColumnsButton.Click

    Dim selectedColumnCount As Integer = dataGridView1.Columns _
        .GetColumnCount(DataGridViewElementStates.Selected)

    If selectedColumnCount > 0 Then

        Dim sb As New System.Text.StringBuilder()

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

            sb.Append("Column: ")
            sb.Append(dataGridView1.SelectedColumns(i).Index.ToString())
            sb.Append(Environment.NewLine)

        Next i

        sb.Append("Total: " + selectedColumnCount.ToString())
        MessageBox.Show(sb.ToString(), "Selected Columns")

    End If

End Sub

Applies to

See also