DataGridViewColumnCollection.GetNextColumn Method (DataGridViewColumn, DataGridViewElementStates, DataGridViewElementStates)

 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Gets the first column after the given column in display order that meets the given filter requirements.

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

public DataGridViewColumn GetNextColumn(
	DataGridViewColumn dataGridViewColumnStart,
	DataGridViewElementStates includeFilter,
	DataGridViewElementStates excludeFilter
)

Parameters

dataGridViewColumnStart
Type: System.Windows.Forms.DataGridViewColumn

The column from which to start searching for the next column.

includeFilter
Type: System.Windows.Forms.DataGridViewElementStates

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

excludeFilter
Type: System.Windows.Forms.DataGridViewElementStates

A bitwise combination of the DataGridViewElementStates values that represent the filter to apply for exclusion.

Return Value

Type: System.Windows.Forms.DataGridViewColumn

The next column that meets the given filter requirements, or null if no column is found.

Exception Condition
ArgumentNullException

dataGridViewColumnStart is null.

ArgumentException

At least one of the filter values is not a valid bitwise combination of DataGridViewElementStates values.

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

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

.NET Framework
Available since 2.0
Return to top
Show: