Export (0) Print
Expand All

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
)

Parameters

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.

ExceptionCondition
ArgumentException

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 =
        columnCollection.GetFirstColumn(DataGridViewElementStates.Visible);
    DataGridViewColumn lastVisibleColumn =
        columnCollection.GetLastColumn(
            DataGridViewElementStates.Visible, DataGridViewElementStates.None);

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

.NET Framework

Supported in: 4.5, 4, 3.5, 3.0, 2.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

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

Show:
© 2014 Microsoft