DataGridViewColumnCollection.GetFirstColumn Method (DataGridViewElementStates)


Returns the first column in display order that meets the given inclusion-filter requirements.

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

public DataGridViewColumn GetFirstColumn(
	DataGridViewElementStates includeFilter


Type: System.Windows.Forms.DataGridViewElementStates

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

Return Value

Type: System.Windows.Forms.DataGridViewColumn

The first column in display order that meets the given filter requirements, or null if no column is found.

Exception Condition

includeFilter is not a valid bitwise combination of DataGridViewElementStates values.

The first column in display order is the column with the lowest DisplayIndex value, regardless of whether the column is actually visible on the screen.

This method lets you determine the first column that fits the given criteria without having to compare index values directly.

The following code example uses the GetFirstColumn method to swap the first displayed column and the last displayed column.

// Swap the last column with the first.
private void Button10_Click(object sender, EventArgs args)
    DataGridViewColumnCollection columnCollection = dataGridView.Columns;

    DataGridViewColumn firstVisibleColumn =
    DataGridViewColumn lastVisibleColumn =
            DataGridViewElementStates.Visible, DataGridViewElementStates.None);

    int firstColumn_sIndex = firstVisibleColumn.DisplayIndex;
    firstVisibleColumn.DisplayIndex = lastVisibleColumn.DisplayIndex;
    lastVisibleColumn.DisplayIndex = firstColumn_sIndex;

.NET Framework
Available since 2.0
Return to top